Vue Router 动态路由

  • 定义和用法

    我们经常需要把某种模式匹配到的所有路由,全都映射到同个组件。例如,我们有一个 User 组件,对于所有 ID 各不相同的用户,都要使用这个组件来渲染。那么,我们可以在 vue-router 的路由路径中使用“动态路径参数”(dynamic segment) 来达到这个效果:
    const User = {
       template: '<div>User</div>'
    }
    
    const router = new VueRouter({
       routes: [
          // 动态路径参数 以冒号开头
          { path: '/user/:id', component: User }
       ]
    })
    
    现在呢,像 /user/foo/user/bar 都将映射到相同的路由。
    一个“路径参数”使用冒号 : 标记。当匹配到一个路由时,参数值会被设置到 this.$route.params,可以在每个组件内使用。于是,我们可以更新 User 的模板,输出当前用户的 ID
    const User = {
         template: '<div>User {{ $route.params.id }}</div>'
    }
    
    你可以在一个路由中设置多段“路径参数”,对应的值都会设置到 $route.params 中。例如:
    模式 匹配路径 $route.params
    /user/:username /user/evan { username: 'evan' }
    /user/:username/post/:post_id /user/evan/post/123 { username: 'evan', post_id: '123' }
    除了 $route.params 外,$route 对象还提供了其它有用的信息,例如,$route.query (如果 URL 中有查询参数)、$route.hash 等等。你可以查看 API 文档 的详细说明。
  • 响应路由参数的变化

    提醒一下,当使用路由参数时,例如从 /user/foo 导航到 /user/bar,原来的组件实例会被复用。因为两个路由都渲染同个组件,比起销毁再创建,复用则显得更加高效。不过,这也意味着组件的生命周期钩子不会再被调用。
    复用组件时,想对路由参数的变化作出响应的话,你可以简单地 watch (监测变化) $route 对象:
    const User = {
       template: '...',
       watch: {
         '$route' (to, from) {
            // 对路由变化作出响应...
         }
       }
    }
    
    或者使用 2.2 中引入的 beforeRouteUpdate 导航守卫:
    const User = {
       template: '...',
       beforeRouteUpdate (to, from, next) {
            // react to route changes...
            // don't forget to call next()
       }
    }
    
  • 捕获所有路由或 404 Not found 路由

    常规参数只会匹配被 / 分隔的 URL 片段中的字符。如果想匹配任意路径,我们可以使用通配符 (*)
    {
        // 会匹配所有路径
        path: '*'
    }
    {
       // 会匹配以 `/user-` 开头的任意路径
       path: '/user-*'
    }
    
    当使用通配符路由时,请确保路由的顺序是正确的,也就是说含有通配符的路由应该放在最后。路由 { path: '*' } 通常用于客户端 404 错误。如果你使用了History 模式,请确保正确配置你的服务器
    当使用一个通配符时,router.push() 内会自动添加一个名为 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'
    
  • 高级匹配模式

    vue-router 使用 path-to-regexp 作为路径匹配引擎,所以支持很多高级的匹配模式,例如:可选的动态路径参数、匹配零个或多个、一个或多个,甚至是自定义正则匹配。查看它的 文档 学习高阶的路径匹配,还有 这个例子 展示 vue-router 怎么使用这类匹配。

    匹配优先级

    有时候,同一个路径可以匹配多个路由,此时,匹配的优先级就按照路由的定义顺序:谁先定义的,谁的优先级就最高。
  • 路由组件传参

    在组件中使用 $route 会使之与其对应路由形成高度耦合,从而使组件只能在某些特定的 URL 上使用,限制了其灵活性。
    使用 props 将组件和路由解耦:
    取代与 $route 的耦合
    const User = {
       template: '<div>User {{ $route.params.id }}<div>'
    }
    const router = new VueRouter({
       routes: [
          { path: '/user/:id', component: User }
       ]
    })
    
    通过 props 解耦
    const User = {
         props: ['id'],
         template: '<div>User {{ id }}</div>'
    }
    const router = new VueRouter({
         routes: [
            { path: '/user/:id', component: User, props: true },
    
            // 对于包含命名视图的路由,你必须分别为每个命名视图添加 `props` 选项:
            {
              path: '/user/:id',
              components: { default: User, sidebar: Sidebar },
              props: { default: true, sidebar: false }
            }
         ]
    })
    
    这样你便可以在任何地方使用该组件,使得该组件更易于重用和测试。

    布尔模式

    如果 props 被设置为 trueroute.params 将会被设置为组件属性。

    对象模式

    如果 props 是一个对象,它会被按原样设置为组件属性。当 props 是静态的时候有用。
    const router = new VueRouter({
         routes: [
              { 
                path: '/promotion/from-newsletter',
                component: Promotion,
                props: { newsletterPopup: false } 
              }
         ]
    })
    

    函数模式

    你可以创建一个函数返回 props。这样你便可以将参数转换成另一种类型,将静态值与基于路由的值结合等等。
    const router = new VueRouter({
         routes: [
            { 
               path: '/search', 
               component: SearchUser, 
               props: (route) => ({ query: route.query.q }) 
            }
         ]
    })
    
    URL /search?q=vue 会将 {query: 'vue'} 作为属性传递给 SearchUser 组件。
    请尽可能保持 props 函数为无状态的,因为它只会在路由发生变化时起作用。如果你需要状态来定义 props,请使用包装组件,这样 Vue 才可以对状态变化做出反应。