一个完整的导航流程
- 导航被触发。
- 在失活的组件里调用 beforeRouteLeave 守卫。
- 调用全局的 beforeEach 守卫。
- 在重用的组件里调用 beforeRouteUpdate 守卫(2.2+)。
- 在路由配置里调用 beforeEnter。
- 解析异步路由组件。
- 在被激活的组件里调用 beforeRouteEnter。
- 调用全局的 beforeResolve 守卫(2.5+)。
- 导航被确认。
- 调用全局的 afterEach 钩子。
- 触发 DOM 更新。
- 调用 beforeRouteEnter 守卫中传给 next 的回调函数,创建好的组件实例会作为回调函数的参数传入。
路由守卫又被分为
- 全局守卫
- 全局前置守卫
- 全局解析守卫
- 全局后置钩子
- 路由独享守卫
- 组件守卫
- beforeRouteEnter
- beforeRouteUpdate
- beforeRouteLeave
全局前置守卫 你可以使用 router.beforeEach 注册一个全局前置守卫:
const router = createRouter({ ... })
router.beforeEach((to, from) => {
// ...
// 返回 false 以取消导航
return false
})
当一个导航触发时,全局前置守卫按照创建顺序调用。守卫是异步解析执行,此时导航在所有守卫 resolve 完之前一直处于等待中。 每个守卫接收两个参数
- to:将要进入的目标
- from:当前导航正要离开的路由
可以返回的值如下:
- false:取消当前的导航。如果浏览器的 URL 改变(可能是用户手动操作了浏览器后退按钮),你的 URL 会回退到 from 路由对应的位置。
- 一个路由地址:通过一个路由地址跳转到一个不同的地址,就像你调用 router.push() 一样,前提是你要先设置 name:"home" 或 replace: true 之类的配置。
router.beforeEach(async (to, from) => {
if (
// 检查用户是否已登录
!isAuthenticated &&
// ❗️ 避免无限重定向
to.name !== 'Login'
) {
// 将用户重定向到登录页面
return { name: 'Login' }
}
})
可选的第三个参数 next 使用 next 也可以进行路由的跳转,但是要确保 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()
})
全局解析守卫 该守卫在每次导航时都会触发,但是确保在导航被确认前,同时在所有组件内守卫和异步路由组件被解析后,解析守卫会被正确调用。这里有个例子,确保用户访问自定义 meta 属性 requiresCamera 的路由:
router.beforeResolve(async to => {
if (to.meta.requiresCamera) {
try {
await askForCameraPermission()
} catch (error) {
if (error instanceof NotAllowedError) {
// ... 处理错误,然后取消导航
return false
} else {
// 意料之外的错误,取消导航并把错误传给全局处理器
throw error
}
}
}
})
router.beforeResolve 是获取数据或执行任何其他操作(如果用户无法进入页面时你希望避免执行的操作)的理想位置。
全局后置钩子 这个钩子和守卫不同,它不会接受 next 函数也不会改变导航本身。 它们对于分析、更改页面标题、声明页面等辅助功能以及其他许多事情都很有用。 它可以使用 navigation failures 作为第三个参数:
router.afterEach((to, from, failure) => {
if (!failure) sendToAnalytics(to.fullPath)
})
路由独享守卫 你可以直接在路由配置上定义 beforeEnter 守卫:
const routes = [
{
path:"/user/:id",
component: UserDetails,
beforeEnter: (to,from) => {
// reject the navigation
return false
}
}
]
beforeEnter 守卫只会在进入路由时触发,不会再 params、query 或 hash 改变时触发。例如从 /user/2 进入到 /user/3。只有在从一个不同的路由导航时,才会被触发。 你还可以将一个函数数组传递给 beforeEnter,这在为不同的路由重用守卫时很有用:
function removeQueryParams(to) {
if (Object.keys(to.query).length)
return { path: to.path, query: {}, hash: to.hash }
}
function removeHash(to) {
if (to.hash) return { path: to.path, query: to.query, hash: '' }
}
const routes = [
{
path: '/users/:id',
component: UserDetails,
beforeEnter: [removeQueryParams, removeHash],
},
{
path: '/about',
component: UserDetails,
beforeEnter: [removeQueryParams],
},
]
组件守卫 你可以在路由组件内直接定义路由导航守卫(传递给路由配置的)
const UserDetails = {
template: `...`,
beforeRouteEnter(to, from) {
// 在渲染该组件的对应路由被验证前调用
// 不能获取组件实例 `this` !
// 因为当守卫执行时,组件实例还没被创建!
},
beforeRouteUpdate(to, from) {
// 在当前路由改变和该组件被复用时调用
// 举例来说,对于一个带有动态参数的路径 `/users/:id`,在 `/users/1` 和 `/users/2` 之间跳转的时候,
// 由于会渲染同样的 `UserDetails` 组件,因此组件实例会被复用。而这个钩子就会在这个情况下被调用。
// 因为在这种情况发生的时候,组件已经挂载好了,导航守卫可以访问组件实例 `this`
},
beforeRouteLeave(to, from) {
// 在导航离开渲染该组件的对应路由时调用
// 与 `beforeRouteUpdate` 一样,它可以访问组件实例 `this`
},
}