Vue.js 学习笔记十三：Vue Router 之导航守卫

目录

导航守卫

全局前置守卫

全局后置钩子

路由独享的守卫

组件内的守卫

---

---

导航守卫

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

网页标题是通过 <title> 来显示的，但是 SPA 只有一个固定的 HTML，切换不同的页面时，标题并不会改变。但是我们可以通过 JavaScript 来修改 <title> 的内容。

 window.document.title = '新的标题'

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

普通的修改方式：

我们比较容易想到的修改标题的位置是每一个路由对应的组件 .vue 文件中。通过 mounted 声明周期函数， 执行对应的代码进行修改即可。

但是当页面比较多时， 这种方式不容易维护（因为需要在多个页面执行类似的代码）。

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

什么是导航守卫？

Vue Router 提供的导航守卫主要用来监听监听路由的进入和离开的。

Vue Router 提供了 beforeEach 和 afterEach 的钩子函数，它们会在路由即将改变前和改变后触发。

全局前置守卫

你可以使用 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 函数在任何给定的导航守卫中都被严格调用一次。它可以出现多于一次，但是只能在所有的逻辑路径都不重叠的情况下，否则钩子永远都不会被解析或报错。

这里我们利用beforeEach 来完成标题的修改。

首先，我们可以在钩子当中定义一些标题，可以利用 meta （路由元信息）来定义。

const routes = [	
     {
        path: '/home',  
		name: 'Home',
    	component: Home,	
		meta: {
			title: '首页'
		}
      },
      {
        path: '/about',
        name: 'About',
        component: About,
            meta: {
                title: '关于'
            }
      }
]

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

router.beforeEach((to, from, next) => {
  	window.document.title = to.meta.title
	next()
})

这里还有一个在用户未认证（未登录或认证过期）时，重定向到 /login 的示例：

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

全局后置钩子

你也可以使用 afterEach 注册全局后置钩子 ，但不需要主动调用 next() 函数。

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

// 修改我们的标题
router.afterEach((to) => {
  window.document.title = to.meta.title
})

路由独享的守卫

你可以在路由配置上直接定义 beforeEnter 守卫，只有当进入这个路由时才会调用的，这些守卫与全局前置守卫的方法参数是一样的。

const routes = [    
      {
         path: '/home',  
         name: 'Home',
         component: Home,    
         meta: {
             title: '首页'
         },
         beforeEnter: (to, from, next) => {
           // ...
         }
       },
       {
         path: '/about',
         name: 'About',
         component: About,
             meta: {
                 title: '关于'
             }
       }
 ]

组件内的守卫

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

• beforeRouteEnter

• beforeRouteUpdate

• beforeRouteLeave

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

这三个守卫是写在组件里，beforeRouteEnter 守卫不能访问 this，因为守卫在导航确认前被调用，因此即将进入的新组件还没被创建。

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

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('有未保存的更改，你真的想离开吗?')
   if (answer) {
     next()
   } else {
     next(false)
   }
 }