路由对象

一个路由对象 (route object) 表示当前激活的路由的状态信息,包含了当前 URL 解析得到的信息,还有 URL 匹配到的路由记录 (route records)

路由对象是不可变 (immutable) 的,每次成功的导航后都会产生一个新的对象。

路由对象出现在多个地方:

  • 在组件内,即 this.$route

  • $route 观察者回调内

  • router.match(location) 的返回值

  • 导航守卫的参数:

    1. router.beforeEach((to, from, next) => {
    2. // `to` 和 `from` 都是路由对象
    3. })
  • scrollBehavior 方法的参数:

    1. const router = new VueRouter({
    2. scrollBehavior(to, from, savedPosition) {
    3. // `to` 和 `from` 都是路由对象
    4. }
    5. })

路由对象属性

  • $route.path

    • 类型: string

      字符串,对应当前路由的路径,总是解析为绝对路径,如 "/foo/bar"

  • $route.params

    • 类型: Object

      一个 key/value 对象,包含了动态片段和全匹配片段,如果没有路由参数,就是一个空对象。

  • $route.query

    • 类型: Object

      一个 key/value 对象,表示 URL 查询参数。例如,对于路径 /foo?user=1,则有 $route.query.user == 1,如果没有查询参数,则是个空对象。

  • $route.hash

    • 类型: string

      当前路由的 hash 值 (带 #) ,如果没有 hash 值,则为空字符串。

  • $route.fullPath

    • 类型: string

      完成解析后的 URL,包含查询参数和 hash 的完整路径。

  • $route.matched

    • 类型: Array<RouteRecord>

    一个数组,包含当前路由的所有嵌套路径片段的路由记录 。路由记录就是 routes 配置数组中的对象副本 (还有在 children 数组)。

    1. const router = new VueRouter({
    2. routes: [
    3. // 下面的对象就是路由记录
    4. {
    5. path: '/foo',
    6. component: Foo,
    7. children: [
    8. // 这也是个路由记录
    9. { path: 'bar', component: Bar }
    10. ]
    11. }
    12. ]
    13. })

    当 URL 为 /foo/bar$route.matched 将会是一个包含从上到下的所有对象 (副本)。

  • $route.name

    当前路由的名称,如果有的话。(查看命名路由)

  • $route.redirectedFrom

    如果存在重定向,即为重定向来源的路由的名字。(参阅重定向和别名)