vue-router

最新推荐文章于 2024-07-24 23:00:08 发布

HWRY

最新推荐文章于 2024-07-24 23:00:08 发布

阅读量218

点赞数

分类专栏： vue-router 文章标签：前端 vue.js javascript

原文链接：https://router.vuejs.org/zh/guide/advanced/navigation-guards.html#%E5%85%A8%E5%B1%80%E5%89%8D%E7%BD%AE%E5%AE%88%E5%8D%AB

版权

vue-router 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

vue-router中$route 和 $router

$route主要是存储当前路由页面的状态信息，所以多是一些属性，

$router是全局路由对象，主要是管理当前路由状态，所以有路由跳转的方法，拦截的方法，也有路由的映射规则

1.1 $route 表示(当前路由信息对象)

表示当前激活的状态信息，包含了当前URL解析得到的信息还有URL匹配到的route records（路由记录）。

路由信息对象：即 $router 会被注入每个组件中，可以利用它进行一些信息的获取。

1 $route.path
    字符串，对应当前路由的路径，总是解析为绝对路径，如"/foo/bar"
2 $route.params
     一个 key/value 对象 包含了 动态片段 和 全局匹配片段
3 $route.query
     一个key/value 对象 表示URL 查询参数
     例如，对于路径 /foo?user=1,则 $route.query.user == 1
     如果没有查询参数 则是个空对象
4 $route.hash
     当前路由的 hash 值 (不带 #) 如果没有 hash 值 则空字符串 锚点
5 $route.fullPath
     完成解析后的 URL 包含查询参数和 hash 的完整路径
6 $ route.matched
     数组，包含当前匹配的路径中所包含的所有片段所对应的配置参数对象
7 $route.name  当前路径名字
8 $route.meta  路由元信息

1.2 route object 出现在多个地方:

(1)在组件内，即 this.$route
(2)在 $route 观察者回调内 router.match(location) 的返回值
(3)导航守卫的参数：

router.beforeEach((to,form, next) => {
    // to 和 from 都是 路由信息对象
})
watch: {
  $route(to, from) {
    // to 和 from 都是路由信息对象
  }
}

2. $router对象

全局的路由实例是router构造方法的实例

在Vue实例内部你可以通过$router 访问路由实例

const router = new Router({
  routes: [
    {
      path: "/",
      name: "首页",
      redirect: "/home",
    },
    {
      path: "/login",
      name: "login",
      component: Login,
    },
    { path: "*", component: NotFoundComponent },
  ],
  linkActiceClass:"active-router",
  linkExactActiveClass:"exact-router"
});

2.1 全局挂载路由实例

// 全局注册的路由
Vue.use(VueRouter)

2.2 路由实例方法push

// 字符串
this.$router.push("home");
// 对象
this.$router.push({ path: "home" });
// 命名的路由
this.$router.push({ name: "user", patams: { userId: 123 } });
// 带查询的参数， 变成 /register?plan=123
this.$router.push({ path: "register", query: { plan: 123 } });

push 方法其实和<router-link :to="..."> 是等同的

注意：push方法的跳转会向 history 栈添加一个新的记录当我们点击浏览器的返回按钮时可以看到之前的页面

2.2 路由实例方法go

// 页面路由跳转 前进或者后退
this.$router.go(-1) // 后退

2.3 路由实例方法replace

// push 方法会向 history 栈添加一个新的记录 而replace方法是替换当前的页面
// 不会向 history 栈添加一个新的记录
<router-link to="/03" relace>03</router-link>

// 一般适用replace 来做404页面
this.$router.replace('/')

为什么使用导航守卫?

我们来考虑一个需求: 在一个SPA应用中, 如何改变网页的标题呢?

网页标题是通过<title>来显示的, 但是SPA只有一个固定的HTML, 切换不同的页面时, 标题并不会改变.

但是我们可以通过JavaScript来修改<title>的内容.window.document.title = '新的标题'.

那么在Vue项目中, 在哪里修改? 什么时候修改比较合适呢?

普通的修改方式:

我们比较容易想到的修改标题的位置是每一个路由对应的组件.vue文件中.

通过mounted声明周期函数, 执行对应的代码进行修改即可.

但是当页面比较多时, 这种方式不容易维护(因为需要在多个页面执行类似的代码).

有没有更好的办法呢? 使用导航守卫即可.

什么是导航守卫?

vue-router提供的导航守卫主要用来监听监听路由的进入和离开的.

vue-router提供了beforeEach和afterEach的钩子函数, 它们会在路由即将改变前和改变后触发.

导航守卫使用

我们可以利用 beforeEach 来完成标题的修改

首先我们可以在钩子当中定义一些标题可以利用meta来定义

其次利用导航守卫修改我们的标题

导航钩子的三个参数解析：

to: 即将要进入的目标的路由对象

from: 当前导航即将要离开的路由对象

next: 调用该方法后，才能进入下一个钩子

如果是后置钩子, 也就是afterEach, 不需要主动调用next()函数.

全局前置守卫

你可以使用 router.beforeEach 注册一个全局前置守卫：

const router = new VueRouter({ ... })

router.beforeEach((to, from, next) => {
  // ...
})

当一个导航触发时，全局前置守卫按照创建顺序调用。守卫是异步解析执行，此时导航在所有守卫 resolve 完之前一直处于 等待中。

每个守卫方法接收三个参数：

to: Route: 即将要进入的目标路由对象
from: Route: 当前导航正要离开的路由
next: Function: 一定要调用该方法来 resolve 这个钩子。执行效果依赖 next 方法的调用参数。
- next(): 进行管道中的下一个钩子。如果全部钩子执行完了，则导航的状态就是 confirmed (确认的)。
- next(false): 中断当前的导航。如果浏览器的 URL 改变了 (可能是用户手动或者浏览器后退按钮)，那么 URL 地址会重置到 from 路由对应的地址。
- next('/') 或者 next({ path: '/' }): 跳转到一个不同的地址。当前的导航被中断，然后进行一个新的导航。你可以向 next 传递任意位置对象，且允许设置诸如 replace: true、name: 'home' 之类的选项以及任何用在 router-link 的 to prop 或 router.push 中的选项。
- next(error): (2.4.0+) 如果传入 next 的参数是一个 Error 实例，则导航会被终止且该错误会被传递给 router.onError() 注册过的回调。

确保 next 函数在任何给定的导航守卫中都被严格调用一次。它可以出现多于一次，但是只能在所有的逻辑路径都不重叠的情况下，否则钩子永远都不会被解析或报错。这里有一个在用户未能验证身份时重定向到 /login 的示例：

// BAD
router.beforeEach((to, from, next) => {
  if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
  // 如果用户未能验证身份，则 `next` 会被调用两次
  next()
})

// GOOD
router.beforeEach((to, from, next) => {
  if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
  else next()
})

全局解析守卫

2.5.0 新增

在 2.5.0+ 你可以用 router.beforeResolve 注册一个全局守卫。这和 router.beforeEach 类似，区别是在导航被确认之前，同时在所有组件内守卫和异步路由组件被解析之后，解析守卫就被调用。

#全局后置钩子

你也可以注册全局后置钩子，然而和守卫不同的是，这些钩子不会接受 next 函数也不会改变导航本身：

router.afterEach((to, from) => {
  // ...
})

路由独享的守卫

你可以在路由配置上直接定义 beforeEnter 守卫：

const router = new VueRouter({
  routes: [
    {
      path: '/foo',
      component: Foo,
      beforeEnter: (to, from, next) => {
        // ...
      }
    }
  ]
})

这些守卫与全局前置守卫的方法参数是一样的。

#组件内的守卫

最后，你可以在路由组件内直接定义以下路由导航守卫：

beforeRouteEnter
beforeRouteUpdate (2.2 新增)
beforeRouteLeave

const Foo = {
  template: `...`,
  beforeRouteEnter(to, from, next) {
    // 在渲染该组件的对应路由被 confirm 前调用
    // 不！能！获取组件实例 `this`
    // 因为当守卫执行前，组件实例还没被创建
  },
  beforeRouteUpdate(to, from, next) {
    // 在当前路由改变，但是该组件被复用时调用
    // 举例来说，对于一个带有动态参数的路径 /foo/:id，在 /foo/1 和 /foo/2 之间跳转的时候，
    // 由于会渲染同样的 Foo 组件，因此组件实例会被复用。而这个钩子就会在这个情况下被调用。
    // 可以访问组件实例 `this`
  },
  beforeRouteLeave(to, from, next) {
    // 导航离开该组件的对应路由时调用
    // 可以访问组件实例 `this`
  }
}

beforeRouteEnter 守卫不能访问 this，因为守卫在导航确认前被调用，因此即将登场的新组件还没被创建。

不过，你可以通过传一个回调给 next来访问组件实例。在导航被确认的时候执行回调，并且把组件实例作为回调方法的参数。

beforeRouteEnter (to, from, next) {
  next(vm => {
    // 通过 `vm` 访问组件实例
  })
}

注意 beforeRouteEnter 是支持给 next 传递回调的唯一守卫。对于 beforeRouteUpdate 和 beforeRouteLeave 来说，this 已经可用了，所以不支持传递回调，因为没有必要了。

beforeRouteUpdate (to, from, next) {
  // just use `this`
  this.name = to.params.name
  next()
}

这个离开守卫通常用来禁止用户在还未保存修改前突然离开。该导航可以通过 next(false) 来取消。

beforeRouteLeave (to, from, next) {
  const answer = window.confirm('Do you really want to leave? you have unsaved changes!')
  if (answer) {
    next()
  } else {
    next(false)
  }
}