vue-router基本使用方法_$avuerouter

声明：本人的所有博客皆为个人笔记，作为个人知识索引使用，因此在叙述上存在逻辑不通顺、跨度大等问题，希望理解。分享出来仅供大家学习翻阅，若有错误希望指出，感谢！

动态路由匹配

我们可以在 vue-router 的路由路径中使用“动态路径参数”(dynamic segment)

const User = {
  template: '<div>User: {{ $route.params.id }}</div>'	//使用路径参数的值
}

const router = new VueRouter({
  routes: [
    // 动态路径参数 以冒号开头
    { path: '/user/:id', component: User }		//指定路径参数名为'id'
  ]
})
1
2
3
4
5
6
7
8
9
10

• 像/user/foo 和 /user/bar都将映射到相同的路由
• 一个“路径参数”使用冒号 : 标记，当匹配到一个路由时，参数值会被设置到 this.$route.params，可以在每个组件内使用

可以在一个路由中设置多段“路径参数”，对应的值都会设置到 $route.params 中。例如：

响应路由参数的变化

当使用路由参数时，例如从 /user/foo 导航到 /user/bar，原来的组件实例会被复用。因为两个路由都渲染同个组件，比起销毁再创建，复用则显得更加高效。不过，这也意味着组件的生命周期钩子不会再被调用。

复用组件时，想对路由参数的变化作出响应的话，你可以简单地 watch (监测变化) $route 对象

捕获所有路由或 404 Not found 路由

常规参数只会匹配被 / 分隔的 URL 片段中的字符。如果想匹配任意路径，我们可以使用通配符 *

{
  path: '*'		// 会匹配所有路径
},
{
  path: '/user-*'	// 会匹配以 `/user-` 开头的任意路径
}
1
2
3
4
5
6

• 当使用通配符路由时，请确保路由的顺序是正确的，也就是说含有通配符的路由应该放在最后
• 路由 { path: '*' } 通常用于客户端 404 错误
• 当使用一个通配符时，$route.params 内会自动添加一个名为 pathMatch 参数，它包含了 URL 通过通配符被匹配的部分

// 给出一个路由 { path: '/user-*' }
this.$router.push('/user-admin')
this.$route.params.pathMatch // 'admin'
// 给出一个路由 { path: '*' }
this.$router.push('/non-existing')
this.$route.params.pathMatch // '/non-existing'
1
2
3
4
5
6

匹配优先级

有时候，同一个路径可以匹配多个路由，此时，匹配的优先级就按照路由的定义顺序：谁先定义的，谁的优先级就最高

嵌套路由

实际生活中的应用界面，通常由多层嵌套的组件组合而成。同样地，URL 中各段动态路径也按某种结构对应嵌套的各层组件

借助 vue-router，使用嵌套路由配置，就可以很简单地表达这种关系

<div id="app">
  <router-view></router-view>
</div>
1
2
3

const User = {
  template: '<div>User {{ $route.params.id }}</div>'
}

const router = new VueRouter({
  routes: [
    { path: '/user/:id', component: User }
  ]
})
1
2
3
4
5
6
7
8
9

这里的 <router-view> 是最顶层的出口，渲染最高级路由匹配到的组件。同样地，一个被渲染组件同样可以包含自己的嵌套<router-view>，例如，在 User 组件的模板添加一个 <router-view>

const User = {
  template: `
    <div class="user">
      <h2>User {{ $route.params.id }}</h2>
      <router-view></router-view>
    </div>
  `
}
1
2
3
4
5
6
7
8

要在嵌套的出口中渲染组件，需要在 VueRouter 的参数中使用 children 配置：

const router = new VueRouter({
  routes: [
    { path: '/user/:id', component: User,
      children: [
        {
          // 当 /user/:id/profile 匹配成功，UserProfile 会被渲染在User的<router-view>中
          path: 'profile',
          component: UserProfile
        },
        {
          // 当 /user/:id/posts 匹配成功，UserPosts 会被渲染在User的<router-view>中
          path: 'posts',
          component: UserPosts
        }
      ]
    }
  ]
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

要注意，以 / 开头的嵌套路径会被当作根路径。 这让你充分的使用嵌套组件而无须设置嵌套的路径

children 配置就是像 routes 配置一样的路由配置数组，所以你可以嵌套多层路由

**注意：**此时，基于上面的配置，当你访问 /user/foo 时，User 的出口是不会渲染任何东西，这是因为没有匹配到合适的子路由。如果你想要渲染点什么，可以提供一个空的子路由：

const router = new VueRouter({
  routes: [
    {
      path: '/user/:id', component: User,
      children: [
        // 当 /user/:id 匹配成功，UserHome 会被渲染在User的<router-view>中
        { path: '', component: UserHome }
      ]
    }
  ]
})
1
2
3
4
5
6
7
8
9
10
11

编程式的导航

除了使用 <router-link> 创建 a 标签来定义导航链接，我们还可以借助 router 的实例方法，通过编写代码来实现

router.push(location, onComplete?, onAbort?) onComplete和onAbort为可选参数

router.push

注意：在 Vue 实例内部，可以通过 $router 访问路由实例。因此你可以调用 this.$router.push()

• 想要导航到不同的 URL，则使用 router.push 方法，这个方法会向 history 栈添加一个新的记录，所以，当用户点击浏览器后退按钮时，则回到之前的 URL
• 点击 <router-link :to="..."> 等同于调用router.push(...)

---

该方法的参数可以是一个字符串路径，或者一个描述地址的对象，例如：

// 字符串
router.push('home')
// 对象
router.push({ path: 'home' })
// 命名的路由
router.push({ name: 'user', params: { userId: '123' }})
// 带查询参数，变成 /register?plan=private
router.push({ path: 'register', query: { plan: 'private' }})
1
2
3
4
5
6
7
8

• 注意：如果提供了 path，params 会被忽略

可以在传值时使用变量

const userId = '123'
router.push({ name: 'user', params: { userId }}) // -> /user/123
router.push({ path: `/user/${userId}` }) // -> /user/123
1
2
3

${变量名} 为ES6中添加的字符串拼接符，将指定变量的值插入到字符串中${}所在位置

• 同样的规则也适用于 router-link 组件的 to 属性

回调函数

• vue-router 在 router.push 或 router.replace 中提供 onComplete 和 onAbort 回调作为第二个和第三个参数
• 这些回调将会在导航成功完成 (在所有的异步钩子被解析之后) 或终止 (导航到相同的路由、或在当前导航完成之前导航到另一个不同的路由) 的时候进行相应的调用
• 可以省略第二个和第三个参数，此时如果支持 Promise，router.push 或 router.replace 将返回一个 Promise

注意： 如果目的地和当前路由相同，只有参数发生了改变，你需要使用 beforeRouteUpdate 来响应这个变化 (比如抓取用户信息)

router.replace

router.replace(location, onComplete?, onAbort?)

跟 router.push 很像，唯一的不同就是，它不会向 history 添加新记录，而是替换掉当前的 history 记录

router.go(n)

这个方法的参数是一个整数，意思是在 history 记录中向前或者后退多少步，类似 window.history.go(n)

// 在浏览器记录中前进一步，等同于 history.forward()
router.go(1)
// 后退一步记录，等同于 history.back()
router.go(-1)
// 前进 3 步记录
router.go(3)
1
2
3
4
5
6

命名路由

可以在创建 Router 实例的时候，在 routes 配置中给某个路由设置名称

const router = new VueRouter({
  routes: [
    {
      path: '/user/:userId',
      name: 'user',		//设置路由名称
      component: User
    }
  ]
})
1
2
3
4
5
6
7
8
9

要链接到一个命名路由，可以给 router-link 的 to 属性传一个对象：

<router-link :to="{ name: 'user', params: { userId: 123 }}">User</router-link>
1

这跟代码调用 router.push() 是一回事：

router.push({ name: 'user', params: { userId: 123 }})
1

这两种方式都会把路由导航到 /user/123 路径

命名视图

有时候想同时 (同级) 展示多个视图，而不是嵌套展示，例如创建一个布局，有 sidebar (侧导航) 和 main (主内容) 两个视图，这个时候命名视图就派上用场了。你可以在界面中拥有多个单独命名的视图，而不是只有一个单独的出口。如果 router-view 没有设置名字，那么默认为 default

<router-view class="view one"></router-view>
<router-view class="view two" name="a"></router-view>
<router-view class="view three" name="b"></router-view>
1
2
3

一个视图使用一个组件渲染，因此对于同个路由，多个视图就需要多个组件。确保正确使用 components 配置：

const router = new VueRouter({
  routes: [
    {
      path: '/',
      components: {		//注意此时components是一个对象
        default: Foo,
        a: Bar,
        b: Baz
      }
    }
  ]
})
1
2
3
4
5
6
7
8
9
10
11
12

嵌套命名视图

我们也有可能使用命名视图创建嵌套视图的复杂布局。这时你也需要命名用到的嵌套 router-view 组件。我们以一个设置面板为例：

/settings/emails                                       /settings/profile
+-----------------------------------+                  +------------------------------+
| UserSettings                      |                  | UserSettings                 |
| +-----+-------------------------+ |                  | +-----+--------------------+ |
| | Nav | UserEmailsSubscriptions | |  +------------>  | | Nav | UserProfile        | |
| |     +-------------------------+ |                  | |     +--------------------+ |
| |     |                         | |                  | |     | UserProfilePreview | |
| +-----+-------------------------+ |                  | +-----+--------------------+ |
+-----------------------------------+                  +------------------------------+
1
2
3
4
5
6
7
8
9

• Nav 只是一个常规组件
• UserSettings 是一个视图组件
• UserEmailsSubscriptions、UserProfile、UserProfilePreview 是嵌套的视图组件

UserSettings 组件的 <template> 部分应该是类似下面的这段代码：

<!-- UserSettings.vue -->
<div>
  <h1>User Settings</h1>
  <NavBar/>
  <router-view/>
  <router-view name="helper"/>
</div>
1
2
3
4
5
6
7

然后你可以用这个路由配置完成该布局：

{
  path: '/settings',
  // 你也可以在顶级路由就配置命名视图
  component: UserSettings,
  children: [{
    path: 'emails',
    component: UserEmailsSubscriptions
  }, {
    path: 'profile',
    components: {
      default: UserProfile,
      helper: UserProfilePreview
    }
  }]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

重定向和别名

重定向

“重定向”的意思是，当用户访问 /a时，URL 将会被替换成 /b，然后匹配路由为 /b

重定向也是通过 routes 配置来完成，下面例子是从 /a 重定向到 /b：

const router = new VueRouter({
  routes: [
    { path: '/a', redirect: '/b' }
  ]
})
1
2
3
4
5

重定向的目标也可以是一个命名的路由：

const router = new VueRouter({
  routes: [
    { path: '/a', redirect: { name: 'foo' }}
  ]
})
1
2
3
4
5

甚至是一个方法，动态返回重定向目标：

const router = new VueRouter({
  routes: [
    { path: '/a', redirect: to => {
      // 方法接收'目标路由'作为参数，return重定向的字符串路径/路径对象
    }}
  ]
})
1
2
3
4
5
6
7

别名

/a 的别名是 /b，意味着，当用户访问 /b 时，URL 会保持为 /b，但是路由匹配则为 /a，就像用户访问 /a 一样

上面对应的路由配置为：

const router = new VueRouter({
  routes: [
    { path: '/a', component: A, alias: '/b' }
  ]
})
1
2
3
4
5

“别名”的功能让你可以自由地将 UI 结构映射到任意的 URL，而不是受限于配置的嵌套路由结构

路由组件传参

在组件中使用 $route 会使之与其对应路由形成高度耦合，从而使组件只能在某些特定的 URL 上使用，限制了其灵活性

使用 props 能够将组件和路由解耦，props类似于组件属性props

const User = {
  props: ['id'],
  template: '<div>User {{ id }}</div>'	//不再需要$route.params.id
}
const router = new VueRouter({
  routes: [
    //如果 props 被设置为 true，route.params 将会被设置为组件属性
    { path: '/user/:id', component: User, props: true },	//此处添加 props: true

    // 对于包含命名视图的路由，你必须分别为每个命名视图添加 `props` 选项：
    {
      path: '/user/:id',
      components: { default: User, sidebar: Sidebar },
      props: { default: true, sidebar: false }
    }
  ]
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

这样你便可以在任何地方使用该组件，使得该组件更易于重用和测试

对象模式

如果 props 是一个对象，它会被按原样设置为组件属性。当 props 是静态的时候有用

const router = new VueRouter({
  routes: [
    { path: '/promotion/from-newsletter', component: Promotion, props: { newsletterPopup: false } }
  ]
})
1
2
3
4
5

函数模式

你可以创建一个函数返回 props。这样你便可以将参数转换成另一种类型，将静态值与基于路由的值结合等等

const router = new VueRouter({
  routes: [
    { path: '/search', component: SearchUser, props: (route) => ({ query: route.query.q }) }
  ]
})
1
2
3
4
5

URL /search?q=vue 会将 {query: 'vue'} 作为属性传递给 SearchUser 组件