update
迁移文档 小爱为你推荐使用新版本哦~~

# 导航守卫

译者注

“导航”表示路由正在发生改变。

正如其名,uni-simple-router 也提供了同 vue-router 一样一样的导航守卫主要用来通过跳转或取消的方式守卫导航。有多种机会植入路由导航过程中:全局的, 单个路由独享的。

# 全局前置守卫

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

const router = createRouter({ ... })

router.beforeEach((to, from, next) => {
  // ...
  next()
})
1
2
3
4
5
6

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

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

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

  • from: Route: 当前导航正要离开的路由

  • next: Function: 一定要调用该方法来 resolve 这个钩子。执行效果依赖 next 方法的调用参数。

    • next: 管道中的下一个钩子。如果全部钩子执行完了,则导航的状态就是 confirmed (确认的)。

    • next(false):中断当前的导航。如果浏览器的 URL 改变了 (可能是用户手动或者浏览器后退按钮),那么 URL 地址会重置到 from 路由对应的地址。

    • next('/') 或者 next({ path: '/' }):跳转到一个不同的地址。当前的导航被中断,然后进行一个新的导航。你可以向 next 传递任意位置对象。

注意

确保要调用 next 方法,否则钩子就不会被 resolved。同时在使用 next() 时,如果想导航到新的地址,这时就需要在 next() 传递一个 NAVTYPE 指定类型跳转。

示例








 






router.beforeEach((to, from, next) => {
    if (to.name == 'tabbar-5') {
        next({
            name: 'router4',
            params: {
                msg: '我拦截了tab5并重定向到了路由4页面上',
            },
            NAVTYPE: 'push'
        });
    } else{
    next();
  }
})
1
2
3
4
5
6
7
8
9
10
11
12
13

很显然这是一个全局的生命钩子函数,当发现跳转的路由名称为 tabbar-5 时,中间进行拦截并重定向到名为 router4 的路由下,而显然易见的是 tabbar-5 是通过 pushTab API进行跳转的,而 router4 则是一个普通的页面,应该使用 push API来进行跳转。所以这时的我们就需要提供一个 NAVTYPE 来指定此次跳转需要使用什么方法。如果地址为同一类型时无需传递此参数。

# 全局后置钩子

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

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

# 路由独享的守卫

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





 





 






const router = createRouter({
    routes: [
         {
            path: "/pages/router/router2/router2",
            beforeEnter:(to,from,next)=>{
                next({name:'router3',params:{msg:'我是从router2路由拦截过来的'}});
            }
        }, 
        {
            path: "/pages/router/router3/router3",
            beforeEnter:(to,from,next)=>{
                next();
            }
        }
    ]
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 组件内的守卫 V 1.5.4+

你可以在组件内配置上 beforeRouteLeave 守卫:














 
 
 
 
 



<template>
	<view>
		<h1>路由守卫 beforeRouteLeave</h1>
	</view>
</template>

<script>
	export default {
		data() {
			return {

			};
		},
		beforeRouteLeave(to, from, next) {   
            // 导航离开该组件的对应路由时调用
            // 可以访问组件实例 `this`
			next();
		},
	}
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 插件构建时的守卫 V 2.0.0+



 
 
 
 
 
 
 
 
 
 


const router = createRouter({
    platform: process.env.VUE_APP_PLATFORM,
    routerBeforeEach:(to, from, next) => {
        // 每次导航触发前都会执行这个,比所有守卫都先执行
        next();
    },
    routerAfterEach:(to, from) => {
        // 跳转结束后执行 守卫守卫执行完毕后再执行
    },
    routerErrorEach:(error, router)=>{
        // 跳转时错误后执行的守卫
    }
})
1
2
3
4
5
6
7
8
9
10
11
12
13

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

# 完整的导航解析流程

  1. 导航被触发。

  2. 调用插件 routerBeforeEach 钩子

  3. 在失活的组件里调用离开守卫 beforeRouteLeave

  4. 调用全局的 beforeEach 守卫。

  5. 在路由配置里调用 beforeEnter。

  6. 导航被确认。

  7. 调用全局的 afterEach 钩子。

  8. 调用插件 routerAfterEach 钩子

  9. H5端 触发 DOM 更新,其他端 底层调用 uni Api