正如其名,vue-router
提供的導航守衛主要用來經過跳轉或取消的方式守衛導航。有多種機會植入路由導航過程當中:全局的, 單個路由獨享的, 或者組件級的。vue
記住參數或查詢的改變並不會觸發進入/離開的導航守衛。你能夠經過觀察 $route
對象來應對這些變化,或使用 beforeRouteUpdate
的組件內守衛。vue-router
你可使用 router.beforeEach
註冊一個全局前置守衛:瀏覽器
1 const router = new VueRouter({ ... }) 2 3 router.beforeEach((to, from, next) => { 4 // ... 5 })
當一個導航觸發時,全局前置守衛按照建立順序調用。守衛是異步解析執行,此時導航在全部守衛 resolve 完以前一直處於 等待中。異步
每一個守衛方法接收三個參數:函數
to: Route
: 即將要進入的目標 路由對象this
from: Route
: 當前導航正要離開的路由spa
next: Function
: 必定要調用該方法來 resolve 這個鉤子。執行效果依賴 next
方法的調用參數。code
next()
: 進行管道中的下一個鉤子。若是所有鉤子執行完了,則導航的狀態就是 confirmed (確認的)。component
next(false)
: 中斷當前的導航。若是瀏覽器的 URL 改變了 (多是用戶手動或者瀏覽器後退按鈕),那麼 URL 地址會重置到 from
路由對應的地址。router
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。
2.5.0 新增
在 2.5.0+ 你能夠用 router.beforeResolve
註冊一個全局守衛。這和 router.beforeEach
相似,區別是在導航被確認以前,同時在全部組件內守衛和異步路由組件被解析以後,解析守衛就被調用。
你也能夠註冊全局後置鉤子,然而和守衛不一樣的是,這些鉤子不會接受 next
函數也不會改變導航自己:
router.afterEach((to, from) => { // ... })
你能夠在路由配置上直接定義 beforeEnter
守衛:
1 const router = new VueRouter({ 2 routes: [ 3 { 4 path: '/foo', 5 component: Foo, 6 beforeEnter: (to, from, next) => { 7 // ... 8 } 9 } 10 ] 11 })
這些守衛與全局前置守衛的方法參數是同樣的。
最後,你能夠在路由組件內直接定義如下路由導航守衛:
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
來訪問組件實例。在導航被確認的時候執行回調,而且把組件實例做爲回調方法的參數。
1 beforeRouteEnter (to, from, next) { 2 next(vm => { 3 // 經過 `vm` 訪問組件實例 4 }) 5 }
注意 beforeRouteEnter
是支持給 next
傳遞迴調的惟一守衛。對於 beforeRouteUpdate
和beforeRouteLeave
來講,this
已經可用了,因此不支持傳遞迴調,由於沒有必要了。
1 beforeRouteUpdate (to, from, next) { 2 // just use `this` 3 this.name = to.params.name 4 next() 5 }
這個離開守衛一般用來禁止用戶在還未保存修改前忽然離開。該導航能夠經過 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) } }
beforeEach
守衛。beforeRouteUpdate
守衛 (2.2+)。beforeEnter
。beforeRouteEnter
。beforeResolve
守衛 (2.5+)。afterEach
鉤子。beforeRouteEnter
守衛中傳給 next
的回調函數。