vue-router是Vue.js官方的路由插件,它和vue.js是深度集成的,適合用於構建單頁面應用。vue的單頁面應用是基於路由和組件的,路由用於設定訪問路徑,並將路徑和組件映射起來。傳統的頁面應用,是用一些超連接來實現頁面切換和跳轉的。在vue-router單頁面應用中,則是路徑之間的切換,也就是組件的切換。javascript
本文將以示例的形式來介紹vue-router的各個特性,一共包含6個示例,每一個示例都有乞丐版,前5個示例有皇帝版。
乞丐版是將全部代碼混雜在一塊兒的HTML頁面,皇帝版是基於vue-webpack-simple模板構建的。html
乞丐版可讓你快速地瞭解到vue-router的一些特性和API;皇帝版則基於.vue組件和單獨的路由配置,更適用於實際的應用。vue
本文的Demo和源代碼已放到GitHub,若是您以爲內容不錯,請點個贊,或在GitHub上加個星星!java
第一個單頁面應用 嵌套路由示例 具名路徑示例 路由對象示例 讓連接處於選中狀態示例 鉤子函數示例 GitHub Source webpack
在GitHub上,乞丐版和皇帝版的目錄結構以下:git
├─06.Router // vue-router示例目錄 │ ├─basic // 乞丐版示例 │ ├──basic_01.html // 第一個單頁面應用 │ ├──basic_02.html // 嵌套路由示例 │ ├──basic_03.html // 具名路徑示例 │ ├──basic_04.html // 路由對象實例 │ ├──basic_05.html // 讓連接處於選中狀態示例 │ ├──basic_06.html // 鉤子函數示例 │ ├─demo01 // 皇帝版,和basic_01.html對應 │ ├─demo02 // 皇帝版,和basic_02.html對應 │ ├─demo03 // 皇帝版,和basic_03.html對應 │ ├─demo04 // 皇帝版,和basic_04.html對應 │ ├─demo05 // 皇帝版,和basic_05.html對應
如今咱們以一個簡單的單頁面應用開啓vue-router之旅,這個單頁面應用有兩個路徑:/home
和/about
,與這兩個路徑對應的是兩個組件Home和About。github
首先引入vue.js和vue-router.js:web
<script src="js/vue.js"></script> <script src="js/vue-router.js"></script>
而後建立兩個組件構造器Home和About:vue-router
var Home = Vue.extend({ template: '<div><h1>Home</h1><p>{{msg}}</p></div>', data: function() { return { msg: 'Hello, vue router!' } } }) var About = Vue.extend({ template: '<div><h1>About</h1><p>This is the tutorial about vue-router.</p></div>' })
var router = new VueRouter()
調用構造器VueRouter,建立一個路由器實例router。npm
router.map({ '/home': { component: Home }, '/about': { component: About } })
調用router的map方法映射路由,每條路由以key-value的形式存在,key是路徑,value是組件。
例如:'/home'
是一條路由的key,它表示路徑;{component: Home}
則表示該條路由映射的組件。
<div class="list-group"> <a class="list-group-item" v-link="{ path: '/home'}">Home</a> <a class="list-group-item" v-link="{ path: '/about'}">About</a> </div>
在a元素上使用v-link
指令跳轉到指定路徑。
<router-view></router-view>
在頁面上使用<router-view></router-view>
標籤,它用於渲染匹配的組件。
var App = Vue.extend({}) router.start(App, '#app')
路由器的運行須要一個根組件,router.start(App, '#app')
表示router會建立一個App實例,而且掛載到#app元素。
注意:使用vue-router的應用,不須要顯式地建立Vue實例,而是調用start方法將根組件掛載到某個元素。
當你從GitHub上獲取到最新的源代碼後,若是想運行皇帝版,以demo01爲例,在Git Bash下執行如下命令:
npm run demo01-dev
而後在瀏覽器中訪問地址http://127.0.0.1:8080
若是要編譯和發佈,請在Git Bash下執行如下命令:
npm run demo01-build
上面的6個步驟,能夠說是建立一個單頁面應用的基本步驟:
應用在首次運行時右側是一片空白,應用一般都會有一個首頁,例如:Home頁。
使用router.redirect
方法將根路徑重定向到/home路徑:
router.redirect({ '/': '/home' })
router.redirect
方法用於爲路由器定義全局的重定向規則,全局的重定向會在匹配當前路徑以前執行。
當用戶點擊v-link
指令元素時,咱們能夠大體猜測一下這中間發生了什麼事情:
v-link
指令的路由映射<router-view>
標籤嵌套路由是個常見的需求,假設用戶可以經過路徑/home/news
和/home/message
訪問一些內容,一個路徑映射一個組件,訪問這兩個路徑也會分別渲染兩個組件。
實現嵌套路由有兩個要點:
<router-view>
標籤如今咱們就動手實現這個需求。
組件模板:
<template id="home"> <div> <h1>Home</h1> <p>{{msg}}</p> </div> <div> <ul class="nav nav-tabs"> <li> <a v-link="{ path: '/home/news'}">News</a> </li> <li> <a v-link="{ path: '/home/message'}">Messages</a> </li> </ul> <router-view></router-view> </div> </template> <template id="news"> <ul> <li>News 01</li> <li>News 02</li> <li>News 03</li> </ul> </template> <template id="message"> <ul> <li>Message 01</li> <li>Message 02</li> <li>Message 03</li> </ul> </template>
組件構造器:
var Home = Vue.extend({ template: '#home', data: function() { return { msg: 'Hello, vue router!' } } }) var News = Vue.extend({ template: '#news' }) var Message = Vue.extend({ template: '#message' })
路由映射:
router.map({ '/home': { component: Home, // 定義子路由 subRoutes: { '/news': { component: News }, '/message': { component: Message } } }, '/about': { component: About } })
在/home
路由下定義了一個subRoutes選項,/news
和/message
是兩條子路由,它們分別表示路徑/home/news
和/home/message
,這兩條路由分別映射組件News和Message。
該示例運行以下:
注意:這裏有一個概念要區分一下,/home/news
和/home/message
是/home
路由的子路由,與之對應的News和Message組件並非Home的子組件。
在有些狀況下,給一條路徑加上一個名字可以讓咱們更方便地進行路徑的跳轉,尤爲是在路徑較長的時候。
咱們再追加一個組件NewsDetail,該組件在訪問/home/news/detail路徑時被渲染,組件模板:
<template id="newsDetail"> <div> News Detail - {{$route.params.id}} ...... </div> </template>
組件構造器:
var NewsDetail = Vue.extend({ template: '#newsDetail' })
router.map({ '/home': { component: Home, subRoutes: { '/news': { name: 'news', component: News, subRoutes: { 'detail/:id': { name: 'detail', component: NewsDetail } } }, '/message': { component: Message } } }, '/about': { component: About } })
注意:咱們在定義/homes/news/
和home/news/detail/:id
路由時,給該路由指定了name
屬性。/:id
是路由參數,例如:若是要查看id = '01'的News詳情,那麼訪問路徑是/home/news/detail/01。
Home組件和News組件模板:
<template id="home"> <div> <h1>Home</h1> <p>{{msg}}</p> </div> <div> <ul class="nav nav-tabs"> <li> <a v-link="{ name: 'news'}">News</a> </li> <li> <a v-link="{ path: '/home/message'}">Messages</a> </li> </ul> <router-view></router-view> </div> </template> <template id="news"> <div> <ul> <li> <a v-link="{ name: 'detail', params: {id: '01'} }">News 01</a> </li> <li> <a v-link="{ path: '/home/news/detail/02'}">News 02</a> </li> <li> <a v-link="{ path: '/home/news/detail/03'}">News 03</a> </li> </ul> <div> <router-view></router-view> </div> </div> </template>
<a v-link="{ name: 'news'}">News</a>
和<a v-link="{ name: 'detail', params: {id: '01'} }">News 01</a>
這兩行HTML代碼,使用了用了具名路徑。
該示例運行以下:
用了這麼久的v-link指令,是該介紹一下它了。
v-link
是一個用來讓用戶在 vue-router 應用的不一樣路徑間跳轉的指令。該指令接受一個 JavaScript 表達式,並會在用戶點擊元素時用該表達式的值去調用router.go
。
具體來說,v-link有三種用法:
<!-- 字面量路徑 --> <a v-link="'home'">Home</a> <!-- 效果同上 --> <a v-link="{ path: 'home' }">Home</a> <!-- 具名路徑 --> <a v-link="{ name: 'detail', params: {id: '01'} }">Home</a>
v-link
會自動設置 <a>
的 href
屬性,你無需使用href
來處理瀏覽器的調整,緣由以下:
它在 HTML5 history 模式和 hash 模式下的工做方式相同,因此若是你決定改變模式,或者 IE9 瀏覽器退化爲 hash 模式時,都不須要作任何改變。
在 HTML5 history 模式下,v-link
會監聽點擊事件,防止瀏覽器嘗試從新加載頁面。
在 HTML5 history 模式下使用 root
選項時,不須要在 v-link
的 URL 中包含 root 路徑。
在使用了 vue-router 的應用中,路由對象會被注入每一個組件中,賦值爲 this.$route
,而且當路由切換時,路由對象會被更新。
路由對象暴露了如下屬性:
"/home/news"
。 /home/news/detail/01?favorite=yes
,會獲得 $route.query.favorite == 'yes'
。 在頁面上添加如下代碼,能夠顯示這些路由對象的屬性:
<div> <p>當前路徑:{{$route.path}}</p> <p>當前參數:{{$route.params | json}}</p> <p>路由名稱:{{$route.name}}</p> <p>路由查詢參數:{{$route.query | json}}</p> <p>路由匹配項:{{$route.matched | json}}</p> </div>
$route.path, $route.params, $route.name, $route.query
這幾個屬性很容易理解,看示例就能知道它們表明的含義。
(因爲$route.matched內容較長,因此沒有將其顯示在畫面上)
這裏我要稍微說一下$router.matched
屬性,它是一個包含性的匹配,它會將嵌套它的父路由都匹配出來。
例如,/home/news/detail/:id
這條路徑,它包含3條匹配的路由:
另外,帶有 v-link
指令的元素,若是 v-link
對應的 URL 匹配當前的路徑,該元素會被添加特定的class,該class的默認名稱爲v-link-active
。例如,當咱們訪問/home/news/detail/03
這個URL時,根據匹配規則,會有3個連接被添加v-link-active
。
以上畫面存在兩個問題:
第1個問題,能夠經過設定v-link
指令的activeClass
解決。
<a class="list-group-item" v-link="{ path: '/home', activeClass: 'active'}">Home</a> <a class="list-group-item" v-link="{ path: '/about', activeClass: 'active'}">About</a>
設定了v-link
指令的activeClass屬性後,默認的v-link-active
被新的class取代。
第2個問題,爲v-link指令設定activeClass是不起做用的,由於咱們使用的是bootstrap的樣式,須要設置a標籤的父元素<li>才能讓連接看起來處於選中狀態,就像下面的代碼所展示的:
<ul class="nav nav-tabs"> <li class="active"> <a v-link="{ path: '/home/news'}">News</a> </li> <li> <a v-link="{ path: '/home/message'}">Messages</a> </li> </ul>
如何實現這個效果呢?你可能會想到,爲Home組件的data選項追加一個currentPath屬性,而後使用如下方式綁定class。
<ul class="nav nav-tabs"> <li :class="currentPath == '/home/news' ? 'active': ''"> <a v-link="{ path: '/home/news'}">News</a> </li> <li :class="currentPath == '/home/message' ? 'active': ''"> <a v-link="{ path: '/home/message'}">Messages</a> </li> </ul>
如今又出現了另外一個問題,在什麼狀況下給currentPath賦值呢?
用戶點擊v-link的元素時,是路由的切換。
每一個組件都有一個route選項,route選項有一系列鉤子函數,在切換路由時會執行這些鉤子函數。
其中一個鉤子函數是data鉤子函數,它用於加載和設置組件的數據。
var Home = Vue.extend({ template: '#home', data: function() { return { msg: 'Hello, vue router!', currentPath: '' } }, route: { data: function(transition){ transition.next({ currentPath: transition.to.path }) } } })
該示例運行效果以下:
路由的切換過程,本質上是執行一系列路由鉤子函數,鉤子函數整體上分爲兩大類:
全局的鉤子函數定義在全局的路由對象中,組件的鉤子函數則定義在組件的route
選項中。
全局鉤子函數有2個:
beforeEach
:在路由切換開始時調用afterEach
:在每次路由切換成功進入激活階段時被調用組件的鉤子函數一共6個:
每一個切換鉤子函數都會接受一個 transition
對象做爲參數。這個切換對象包含如下函數和方法:
全局鉤子函數和組件鉤子函數加起來一共8個,爲了熟練vue router的使用,有必要了解這些鉤子函數的執行順序。
爲了直觀地瞭解這些鉤子函數的執行順序,在畫面上追加一個Vue實例:
var well = new Vue({ el: '.well', data: { msg: '', color: '#ff0000' }, methods: { setColor: function(){ this.color = '#' + parseInt(Math.random()*256).toString(16) + parseInt(Math.random()*256).toString(16) + parseInt(Math.random()*256).toString(16) }, setColoredMessage: function(msg){ this.msg += '<p style="color: ' + this.color + '">' + msg + '</p>' }, setTitle: function(title){ this.msg = '<h2 style="color: #333">' + title + '</h2>' } } })
well實例的HTML:
<div class="well"> {{{ msg }}} </div>
而後,添加一個RouteHelper函數,用於記錄各個鉤子函數的執行日誌:
function RouteHelper(name) { var route = { canReuse: function(transition) { well.setColoredMessage('執行組件' + name + '的鉤子函數:canReuse') return true }, canActivate: function(transition) { well.setColoredMessage('執行組件' + name + '的鉤子函數:canActivate') transition.next() }, activate: function(transition) { well.setColoredMessage('執行組件' + name + '的鉤子函數:activate') transition.next() }, canDeactivate: function(transition) { well.setColoredMessage('執行組件' + name + '的鉤子函數:canDeactivate') transition.next() }, deactivate: function(transition) { well.setColoredMessage('執行組件' + name + '的鉤子函數:deactivate') transition.next() }, data: function(transition) { well.setColoredMessage('執行組件' + name + '的鉤子函數:data') transition.next() } } return route; }
最後,將這些鉤子函數應用於各個組件:
var Home = Vue.extend({ template: '#home', data: function() { return { msg: 'Hello, vue router!', path: '' } }, route: RouteHelper('Home') }) var News = Vue.extend({ template: '#news', route: RouteHelper('News') }) var Message = Vue.extend({ template: '#message', route: RouteHelper('Message') }) var About = Vue.extend({ template: '#about', route: RouteHelper('About') })
咱們按照如下步驟作個小實驗:
/home
路徑)/home/news
路徑/home/message
路徑/about
路徑當用戶點擊了/home/news連接,而後再點擊/home/message連接後,vue-router作了什麼事情呢?它執行了一個切換管道
如何作到這些呢?這個過程包含一些咱們必需要作的工做:
能夠重用組件Home,由於從新渲染後,組件Home依然保持不變。
須要停用並移除組件News。
啓用並激活組件Message。
在執行步驟2和3以前,須要確保切換效果有效——也就是說,爲保證切換中涉及的全部組件都能按照指望的那樣被停用/激活。
咱們能夠把路由的切換分爲三個階段:可重用階段,驗證階段和激活階段。
咱們以home/news
切換到home/message
爲例來描述各個階段。
(如下文字描述參考:http://router.vuejs.org/zh-cn/pipeline/index.html)
檢查當前的視圖結構中是否存在能夠重用的組件。這是經過對比兩個新的組件樹,找出共用的組件,而後檢查它們的可重用性(經過 canReuse
選項)。默認狀況下, 全部組件都是可重用的,除非是定製過。
檢查當前的組件是否可以停用以及新組件是否能夠被激活。這是經過調用路由配置階段的canDeactivate
和 canActivate
鉤子函數來判斷的。
一旦全部的驗證鉤子函數都被調用並且沒有終止切換,切換就能夠認定是合法的。路由器則開始禁用當前組件並啓用新組件。
此階段對應鉤子函數的調用順序和驗證階段相同,其目的是在組件切換真正執行以前提供一個進行清理和準備的機會。界面的更新會等到全部受影響組件的 deactivate
和 activate
鉤子函數執行以後才進行。
data
這個鉤子函數會在 activate
以後被調用,或者當前組件組件能夠重用時也會被調用。
本文主要介紹瞭如下內容: