导航守卫解释与例子

时间 2019-11-11

标签导航守卫解释例子繁體版

原文原文链接

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

正如其名，vue-router 提供的导航守卫主要用来经过跳转或取消的方式守卫导航。有多种机会植入路由导航过程当中：全局的, 单个路由独享的, 或者组件级的。html

记住参数或查询的改变并不会触发进入/离开的导航守卫。你能够经过观察 $route 对象来应对这些变化，或使用 beforeRouteUpdate 的组件内守卫。vue

一、全局前置守卫

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

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

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

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

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

to: Route: 即将要进入的目标路由对象浏览器
from: Route: 当前导航正要离开的路由app
next: Function: 必定要调用该方法来 resolve 这个钩子。执行效果依赖 next 方法的调用参数。异步
- next(): 进行管道中的下一个钩子。若是所有钩子执行完了，则导航的状态就是 confirmed (确认的)。ide
- 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 方法，不然钩子就不会被 resolved。 完整例子以下：

<body class="">
    <script src="../js/vue.js"></script>
    <script src="../js/vue-router.js"></script>
    <div id="app">
        <h1>导航守卫</h1>
       <router-link :to="{ name: 'user', params: { id: 123 }}">User</router-link>
        <br />
        <router-link to="/user/222">b title</router-link>
        <router-view></router-view>
    </div>
    <script>
    var user = {
        template: "<div>this is user </div>"
    };

    const router = new VueRouter({
        routes: [{
            path: "/user/:id",
			name:"user",
            component: user,
        }],
		
    })
	router.beforeEach((to,from,next)=>{
	 console.log(to);
	 //console.log(to.name);//user
	 next();
	})
    const app = new Vue({ router }).$mount("#app")
	//:to="{ name: 'user', params: { id: 123 }}" 前面的：不能省略，须要得到路由path里面的id
    </script>
</body>

二、全局解析守卫

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

路由拦截是咱们项目中常常遇到的广泛问题，例如当你访问任何一个页面的时候须要验证该用户有没有登陆等；
对此，vue-router提供的beforeRouter能够方便的实现路由的导航守卫；

router.beforeResolve((to, from, next) => {
  /* must call `next` */
})

三、全局后置钩子

你也能够注册全局后置钩子，然而和守卫不一样的是，这些钩子不会接受 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` 访问组件实例
  })
}

完整例子：

<body class="">
    <script src="../js/vue.js"></script>
    <script src="../js/vue-router.js"></script>
    <div id="app">
        <h1>导航守卫</h1>
        <router-link :to="{ name: 'user', params: { id: 123 }}">User</router-link>
        <br />
        <router-link to="/user/222">b title</router-link>
        <router-view></router-view>
    </div>
    <script>
    var user = {
        data() {
            return {
                num: 18
            }
        },
        template: "<div>this is user {{num}} </div>",
        beforeRouteEnter(to, from, next) {
            next(vm => {
                vm.num = 19;//从新为num赋值19
                console.log(vm)
            })
        }
    };
   
    const router = new VueRouter({
        routes: [{
            path: "/user/:id",
            name: "user",
            component: user,
        }],

    })

    const app = new Vue({ router }).$mount("#app")
    //点击连接展现this is user 19
    //:to="{ name: 'user', params: { id: 123 }}" 前面的：不能省略，须要得到路由path里面的id
    </script>
</body>

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

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

完整例子：

<body class="">
    <script src="../js/vue.js"></script>
    <script src="../js/vue-router.js"></script>
    <div id="app">
        <h1>导航守卫</h1>
        <router-link to="/user/111">User</router-link>
        <br />
        <router-link to="/user/222">b title</router-link>
        <router-view></router-view>
    </div>
    <script>
    var user = {
        data() {
            return {
                name: "lily"
            }
        },
        template: "<div>this is user {{name}} </div>",
        beforeRouteUpdate(to, from, next) {
		    this.name = "jack"
			console.log(to)
            next()
        }
    };
   
    const router = new VueRouter({
        routes: [{
            path: "/user/:id",
            name: "user",
            component: user,
        }],

    })

    const app = new Vue({ router }).$mount("#app")
    </script>
</body>

这个离开守卫一般用来禁止用户在还未保存修改前忽然离开。该导航能够经过 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)
  }
}

完整例子：

<body class="">
    <script src="../js/vue.js"></script>
    <script src="../js/vue-router.js"></script>
    <div id="app">
        <h1>导航守卫</h1>
        <router-link to="/user">User</router-link>
        <br />
        <router-link to="/seller">seller</router-link>
        <router-view></router-view>
    </div>
    <script>
    var user = {
        data() {
            return {
                name: "lily"
            }
        },
        template: "<div>this is user {{name}} </div>",
        beforeRouteLeave(to, from, next) {
            const answer = window.confirm('Do you really want to leave? you have unsaved changes!')
            if (answer) {
                next()
            } else {
                next(false)
            }
        }
    };
    var seller = {

        template: "<div>this is seller </div>",

    };
    const router = new VueRouter({
        routes: [{
            path: "/user",
            name: "user",
            component: user,
        }, {
            path: "/seller",
            name: "seller",
            component: seller,
        }],

    })

    const app = new Vue({ router }).$mount("#app")
	//点击另一个链接准备离开此链接触发beforeRouteLeave
    </script>
</body>

完整的导航解析流程

导航被触发。
在失活的组件里调用离开守卫。
调用全局的 beforeEach 守卫。
在重用的组件里调用 beforeRouteUpdate 守卫 (2.2+)。
在路由配置里调用 beforeEnter。
解析异步路由组件。
在被激活的组件里调用 beforeRouteEnter。
调用全局的 beforeResolve 守卫 (2.5+)。
导航被确认。
调用全局的 afterEach 钩子。
触发 DOM 更新。
用建立好的实例调用 beforeRouteEnter 守卫中传给 next 的回调函数。