將元件(components)對映到路由(routes)，然後告訴 vue-router 在哪裡渲染它們。
基本例子：
# HTML
<div id="app">
<h1>Hello App!</h1>
<p>
<!-- 使用 router-link 元件來導航. -->
<!-- 通過傳入 `to` 屬性指定連結. -->
<!-- <router-link> 預設會被渲染成一個 `<a>` 標籤 -->
<router-link to="/foo">Go to Foo</router-link>
<router-link to="/bar">Go to Bar</router-link>
</p>
<!-- 路由出口 -->
<!-- 路由匹配到的元件將渲染在這裡 -->
<router-view></router-view>
</div>
# JavaScript
0. 如果使用模組化機制程式設計，匯入Vue和VueRouter，要呼叫 Vue.use(VueRouter)
1. 定義（路由）元件。
可以從其他檔案 import 進來
const Foo = { template: '<div>foo</div>' }
const Bar = { template: '<div>bar</div>' }
2. 定義路由
每個路由應該對映一個元件。 其中"component" 可以是通過 Vue.extend() 建立的元件構造器，或者只是一個元件配置物件。
const routes = [
{ path: '/foo', component: Foo },
{ path: '/bar', component: Bar }
]
3. 建立 router 例項，然後傳 `routes` 配置
const router = new VueRouter({
routes // （縮寫）相當於 routes: routes
})
4. 建立和掛載根例項。
記得要通過 router 配置引數注入路由，從而讓整個應用都有路由功能
const app = new Vue({
router
}).$mount('#app')
複製程式碼動態路由配置
# 例如我們有一個 User 元件，對於所有 ID 各不相同的使用者，都要使用這個元件來渲染。那麼，我們可以在 vue-router 的路由路徑中使用『動態路徑引數』（dynamic segment）來達到這個效果：
const User = {
template: '<div>User</div>'
}
const router = new VueRouter({
routes: [
動態路徑引數 以冒號開頭
{ path: '/user/:id', component: User }
]
})
現在呢，像 /user/foo 和 /user/bar 都將對映到相同的路由。
一個『路徑引數』使用冒號 : 標記。當匹配到一個路由時，引數值會被設定到 this.$route.params，可以在每個元件內使用。於是，我們可以更新 User 的模板，輸出當前使用者的 ID：
const User = {
template: '<div>User {{ $route.params.id }}</div>'
}
# 當使用路由引數時，兩個路由都複用同個元件，比起銷燬再建立，複用則顯得更加高效。也意味著元件的生命週期鉤子不會再被呼叫。
想對路由引數的變化作出響應的話，你可以簡單地 watch（監測變化） $route 物件：
const User = {
template: '...',
watch: {
'$route' (to, from) {
// 對路由變化作出響應...
}
}
}
# 或者使用 2.2 中引入的 beforeRouteUpdate 守衛：
const User = {
template: '...',
beforeRouteUpdate (to, from, next) {
// react to route changes...
// don't forget to call next()
}
}
複製程式碼巢狀路由
const router = new VueRouter({
routes: [
{ path: '/user/:id', component: User,
children: [
{
// 當 /user/:id/profile 匹配成功，
// UserProfile 會被渲染在 User 的 <router-view> 中
path: 'profile',
component: UserProfile
},
{
// 當 /user/:id/posts 匹配成功
// UserPosts 會被渲染在 User 的 <router-view> 中
path: 'posts',
component: UserPosts
}
]
}
]
})
注意,以 / 開頭的巢狀路徑會被當作根路徑。這讓你充分的使用巢狀元件而無須設定巢狀的路徑。
children 配置就是像 routes配置一樣的路由配置陣列，所以可以巢狀多層路由。
此時，基於上面的配置，當你訪問 /user/foo 時，User 的出口是不會渲染任何東西，這是因為沒有匹配到合適的子路由。如果你想要渲染點什麼，可以提供一個空的子路由：
const router = new VueRouter({
routes: [
{
path: '/user/:id', component: User,
children: [
當 /user/:id 匹配成功，
UserHome 會被渲染在 User 的 <router-view> 中
{ path: '', component: UserHome },
...其他子路由
]
}
]
})
複製程式碼$router
# router.push==window.history.pushState
會向 history 棧新增一個新的記錄，所以，當使用者點選瀏覽器後退按鈕時，則回到之前的 URL。
宣告式 程式設計式
<router-link :to="..."> router.push(...)
引數可以是一個字串路徑，或者一個描述地址的物件:
// 字串
router.push('home')
// 物件
router.push({ path: 'home' })
// 命名的路由
router.push({ name: 'user', params: { userId: 123 }})
// 帶查詢引數，變成 /register?plan=private
router.push({ path: 'register', query: { plan: 'private' }})
router.push({ name: 'user', params: { userId }}) // -> /user/123
router.push({ path: `/user/${userId}` }) // -> /user/123
在 2.2.0+，可選的在 router.push 或 router.replace 中提供 onComplete 和 onAbort 回撥作為第二個和第三個引數。這些回撥將會在導航成功完成 (在所有的非同步鉤子被解析之後) 或終止 (導航到相同的路由、或在當前導航完成之前導航到另一個不同的路由) 的時候進行相應的呼叫。
注意：如果目的地和當前路由相同，只有引數發生了改變 (比如從一個使用者資料到另一個 /users/1 -> /users/2)，你需要使用 beforeRouteUpdate 來響應這個變化 (比如抓取使用者資訊)。
# router.replace()==window.history.replaceState
不會向 history 新增新記錄，而是跟它的方法名一樣 —— 替換掉當前的 history 記錄。
宣告式 程式設計式
<router-link :to="..." replace> router.replace(...)
# router.go(n)==window.history.go**
這個方法的引數是一個整數，意思是在 history 記錄中向前或者後退多少步.
// 在瀏覽器記錄中前進一步，等同於 history.forward()
router.go(1)
// 後退一步記錄，等同於 history.back()
router.go(-1)
// 前進 3 步記錄
router.go(3)
複製程式碼命名檢視
# 同級檢視
有時候想同時（同級）展示多個檢視，而不是巢狀展示，例如建立一個佈局，有 sidebar（側導航） 和 main（主內容） 兩個檢視，你可以在介面中擁有多個單獨命名的檢視，而不是隻有一個單獨的出口。如果 router-view 沒有設定名字，那麼預設為 default。
<router-view class="view one"></router-view>
<router-view class="view two" name="a"></router-view>
<router-view class="view three" name="b"></router-view>
一個檢視使用一個元件渲染，因此對於同個路由，多個檢視就需要多個元件。確保正確使用 components 配置（帶上 s）：
const router = new VueRouter({
routes: [
{
path: '/',
components: {
default: Foo,
a: Bar,
b: Baz
}
}
]
})
# 巢狀命名檢視
UserSettings 元件的 ```<template>``` 部分應該是類似下面的這段程式碼：
<!-- UserSettings.vue -->
<div>
<h1>User Settings</h1>
<NavBar/>
<router-view/>
<router-view name="helper"/>
</div>
巢狀的檢視元件在此已經被忽略了，但是你可以在這裡找到完整的原始碼
然後你可以用這個路由配置完成該佈局：
{
path: '/settings',
// 你也可以在頂級路由就配置命名檢視
component: UserSettings,
children: [{
path: 'emails',
component: UserEmailsSubscriptions
}, {
path: 'profile',
components: {
default: UserProfile,
helper: UserProfilePreview
}
}]
}
複製程式碼重定向和別名
const router = new VueRouter({
routes: [
{ path: '/a', redirect: '/b' }
]
})
# 重定向的目標也可以是一個命名的路由：
const router = new VueRouter({
routes: [
{ path: '/a', redirect: { name: 'foo' }}
]
})
# 甚至是一個方法，動態返回重定向目標：
const router = new VueRouter({
routes: [
{ path: '/a', redirect: to => {
// 方法接收 目標路由 作為引數
// return 重定向的 字串路徑/路徑物件
}}
]
})
# 別名
/a 的別名是 /b，意味著，當使用者訪問 /b 時，URL 會保持為 /b，但是路由匹配則為 /a，就像使用者訪問 /a 一樣。
const router = new VueRouter({
routes: [
{ path: '/a', component: A, alias: '/b' }
]
})
『別名』的功能讓你可以自由地將 UI 結構對映到任意的 URL，而不是受限於配置的巢狀路由結構。
複製程式碼路由元件傳參
在元件中使用 $route 會使之與其對應路由形成高度耦合，從而使元件只能在某些特定的 URL 上使用，限制了其靈活性。
使用 props 將元件和路由解耦：
取代與 $route 的耦合
const User = {
template: '<div>User {{ $route.params.id }}</div>'
}
const router = new VueRouter({
routes: [
{ path: '/user/:id', component: User }
]
})
# 通過 props 解耦
const User = {
props: ['id'],
template: '<div>User {{ id }}</div>'
}
const router = new VueRouter({
routes: [
{ path: '/user/:id', component: User, props: true },
// 對於包含命名檢視的路由，你必須分別為每個命名檢視新增 `props` 選項：
{
path: '/user/:id',
components: { default: User, sidebar: Sidebar },
props: { default: true, sidebar: false }
}
]
})
這樣你便可以在任何地方使用該元件，使得該元件更易於重用和測試。
# 布林模式
如果 props 被設定為 true，route.params 將會被設定為元件屬性。
# 物件模式
如果 props 是一個物件，它會被按原樣設定為元件屬性。當 props 是靜態的時候有用。
const router = new VueRouter({
routes: [
{ path: '/promotion/from-newsletter', component: Promotion, props: { newsletterPopup: false } }
]
})
# 函式模式
你可以建立一個函式返回 props。這樣你便可以將引數轉換成另一種型別，將靜態值與基於路由的值結合等等。
const router = new VueRouter({
routes: [
{ path: '/search', component: SearchUser, props: (route) => ({ query: route.query.q }) }
]
})
URL /search?q=vue 會將 {query: 'vue'} 作為屬性傳遞給 SearchUser 元件。
請儘可能保持 props 函式為無狀態的，因為它只會在路由發生變化時起作用。如果你需要狀態來定義 props，請使用包裝元件，這樣 Vue 才可以對狀態變化做出反應。
複製程式碼HTML5 History 模式
vue-router 預設 hash 模式
可以用路由的 history 模式，這種模式充分利用 history.pushState API 來完成 URL 跳轉而無須重新載入頁面。
const router = new VueRouter({
mode: 'history',
routes: [...]
})
需要後臺配置支援。因為我們的應用是個單頁客戶端應用，如果後臺沒有正確的配置，當使用者在瀏覽器直接訪問 http://oursite.com/user/id 就會返回 404，這就不好看了,
給個警告，後臺因為這麼做以後，你的伺服器就不再返回 404 錯誤頁面，因為對於所有路徑都會返回 index.html 檔案。為了避免這種情況，你應該在 Vue 應用裡面覆蓋所有的路由情況，然後在給出一個 404 頁面。
const router = new VueRouter({
mode: 'history',
routes: [
{ path: '*', component: NotFoundComponent }
]
})
複製程式碼後端配置例子
Apache
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index\.html$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.html [L]
</IfModule>
除了 mod_rewrite，你也可以使用 FallbackResource。
nginx
location / {
try_files $uri $uri/ /index.html;
}
原生 Node.js
const http = require('http')
const fs = require('fs')
const httpPort = 80
http.createServer((req, res) => {
fs.readFile('index.htm', 'utf-8', (err, content) => {
if (err) {
console.log('We cannot open "index.htm" file.')
}
res.writeHead(200, {
'Content-Type': 'text/html; charset=utf-8'
})
res.end(content)
})
}).listen(httpPort, () => {
console.log('Server listening on: http://localhost:%s', httpPort)
})
基於 Node.js 的 Express
對於 Node.js/Express，請考慮使用 connect-history-api-fallback 中介軟體。
Internet Information Services (IIS)
安裝 IIS UrlRewrite
在你的網站根目錄中建立一個 web.config 檔案，內容如下：
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<rewrite>
<rules>
<rule name="Handle History Mode and custom 404/500" stopProcessing="true">
<match url="(.*)" />
<conditions logicalGrouping="MatchAll">
<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
</conditions>
<action type="Rewrite" url="/" />
</rule>
</rules>
</rewrite>
</system.webServer>
</configuration>
Caddy
rewrite {
regexp .*
to {path} /
}
Firebase 主機
在你的 firebase.json 中加入：
{
"hosting": {
"public": "dist",
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}
複製程式碼路由守衛
# 導航守衛(beforeRouteUpdate)
路由正在發生改變.
記住引數或查詢的改變並不會觸發進入/離開的導航守衛。你可以通過觀察 $route 物件來應對這些變化，或使用 beforeRouteUpdate 的元件內守衛。
# 全域性守衛(router.beforeEach)
const router = new VueRouter({ ... })
router.beforeEach((to, from, next) => {
// ...
})
當一個導航觸發時，全域性前置守衛按照建立順序呼叫。守衛是非同步解析執行，此時導航在所有守衛 resolve 完之前一直處於 等待中。
每個守衛方法接收三個引數：
to: Route: 即將要進入的目標 路由物件
from: Route: 當前導航正要離開的路由
next: Function: 一定要呼叫該方法來 resolve 這個鉤子。執行效果依賴 next 方法的呼叫引數。
next(): 進行管道中的下一個鉤子。如果全部鉤子執行完了，則導航的狀態就是 confirmed （確認的）。
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。
# 全域性解析守衛(router.beforeResolve)(2.5.0 新增)**
與全域性前置守衛區別是router.beforeResolve在導航被確認之前，同時在所有元件內守衛和非同步路由元件被解析之後，解析守衛就被呼叫。
# 全域性後置鉤子(router.afterEach)
和守衛不同的是，這些鉤子不會接受 next 函式也不會改變導航本身：
router.afterEach((to, from) => {
// ...
})
# 路由獨享的守衛(beforeEnter)
你可以在路由配置上直接定義 beforeEnter 守衛：
const router = new VueRouter({
routes: [
{
path: '/foo',
component: Foo,
beforeEnter: (to, from, next) => {
// ...
}
}
]
})
#元件內的守衛
# beforeRouteEnter (to, from, next) {
在渲染該元件的對應路由被 confirm 前呼叫不！能！獲取元件例項 `this`因為當守衛執行前，元件例項還沒被建立,你可以通過傳一個回撥給 next來訪問元件例項。在導航被確認的時候執行回撥，並且把元件例項作為回撥方法的引數
},
beforeRouteEnter (to, from, next) {
next(vm => {
// 通過 `vm` 訪問元件例項
})
}
# beforeRouteUpdate (to, from, next) {
// 在當前路由改變，但是該元件被複用時呼叫
// 舉例來說，對於一個帶有動態引數的路徑 /foo/:id，在 /foo/1 和 /foo/2 之間跳轉的時候，
// 由於會渲染同樣的 Foo 元件，因此元件例項會被複用。而這個鉤子就會在這個情況下被呼叫。
// 可以訪問元件例項 `this`
// just use `this`
this.name = to.params.name
next()
},
}
# beforeRouteLeave
通常用來禁止使用者在還未儲存修改前突然離開。該導航可以通過 next(false) 來取消。
beforeRouteLeave (to, from , next) {
// 導航離開該元件的對應路由時呼叫
// 可以訪問元件例項 `this`
const answer = window.confirm('Do you really want to leave? you have unsaved changes!')
if (answer) {
next()
} else {
next(false)
}
}
注意 beforeRouteEnter 是支援給 next 傳遞迴調的唯一守衛。對於beforeRouteUpdate 和 beforeRouteLeave 來說，this 已經可用了，所以不支援傳遞迴調.
複製程式碼
過渡動效
<router-view>是基本的動態元件，<transition>的所有功能 在這裡同樣適用：
<transition>
<router-view></router-view>
</transition>
# 單個路由的過渡可以在各路由元件內使用 <transition> 並設定不同的 name。
const Foo = {
template: `
<transition name="slide">
<div class="foo">...</div>
</transition>
`
}
const Bar = {
template: `
<transition name="fade">
<div class="bar">...</div>
</transition>
`
}
# 可以基於當前路由與目標路由的變化關係，動態設定過渡效果：```
<!-- 使用動態的 transition name -->
<transition :name="transitionName">
<router-view></router-view>
</transition>
// 接著在父元件內
// watch $route 決定使用哪種過渡
watch: {
'$route' (to, from) {
const toDepth = to.path.split('/').length
const fromDepth = from.path.split('/').length
this.transitionName = toDepth < fromDepth ? 'slide-right' : 'slide-left'
}
}
複製程式碼Router api
# routes:型別: Array<RouteConfig>
declare type RouteConfig = {
path: string;
component?: Component;
name?: string; // 命名路由
components?: { [name: string]: Component }; // 命名檢視元件
redirect?: string | Location | Function;
props?: boolean | string | Function;
alias?: string | Array<string>;
children?: Array<RouteConfig>; // 巢狀路由
beforeEnter?: (to: Route, from: Route, next: Function) => void;
meta?: any;
// 2.6.0+
caseSensitive?: boolean; // 匹配規則是否大小寫敏感？(預設值：false)
pathToRegexpOptions?: Object; // 編譯正則的選項
}
# mode: string
預設值: "hash" (瀏覽器環境) | "abstract" (Node.js 環境)
配置路由模式:
hash: 使用 URL hash 值來作路由。支援所有瀏覽器，包括不支援 HTML5 History Api 的瀏覽器。
history: 依賴 HTML5 History API 和伺服器配置。檢視 HTML5 History 模式。
abstract: 支援所有 JavaScript 執行環境，如 Node.js 伺服器端。如果發現沒有瀏覽器的 API，路由會自動強制進入這個模式。
# base: string
預設值: "/"
應用的基路徑。例如，如果整個單頁應用服務在 /app/ 下，然後 base 就應該設為 "/app/"。
# linkActiveClass: string
預設值: "router-link-active"
全域性配置 <router-link> 的預設『啟用 class 類名』。參考 router-link。
#linkExactActiveClass(2.5.0+): string
預設值: "router-link-exact-active"
全域性配置 <router-link> 精確啟用的預設的 class。可同時翻閱 router-link。
# scrollBehavior: Function
type PositionDescriptor =
{ x: number, y: number } |
{ selector: string } |
?{}
type scrollBehaviorHandler = (
to: Route,
from: Route,
savedPosition?: { x: number, y: number }
) => PositionDescriptor | Promise<PositionDescriptor>
更多詳情參考滾動行為。
# parseQuery / stringifyQuery(2.4.0+): Function
提供自定義查詢字串的解析/反解析函式。覆蓋預設行為。
# fallback(2.6.0+): boolean
當瀏覽器不支援 history.pushState 控制路由是否應該回退到 hash 模式。預設值為 true。
在 IE9 中，設定為 false 會使得每個 router-link 導航都觸發整頁重新整理。它可用於工作在 IE9 下的服務端渲染應用，因為一個 hash 模式的 URL 並不支援服務端渲染。
複製程式碼路由資訊物件的屬性
$route(路由)為當前router跳轉物件裡面可以獲取name、path、query、params等
複製程式碼# $route.path: string
字串，對應當前路由的路徑，總是解析為絕對路徑，如 "/foo/bar"。
#$route.params: Object
一個 key/value 物件，包含了動態片段和全匹配片段，如果沒有路由引數，就是一個空物件。
# $route.query: Object
一個 key/value 物件，表示 URL 查詢引數。例如，對於路徑 /foo?user=1，則有 $route.query.user == 1，如果沒有查詢引數，則是個空物件。
# $route.hash: string
當前路由的 hash 值 (帶 #) ，如果沒有 hash 值，則為空字串。
# $route.fullPath: string
完成解析後的 URL，包含查詢引數和 hash 的完整路徑。
# $route.matched: Array<RouteRecord>
一個陣列，包含當前路由的所有巢狀路徑片段的路由記錄 。路由記錄就是 routes 配置陣列中的物件副本 (還有在 children 陣列)。
const router = new VueRouter({
routes: [
// 下面的物件就是路由記錄
{ path: '/foo', component: Foo,
children: [
// 這也是個路由記錄
{ path: 'bar', component: Bar }
]
}
]
})
當 URL 為 /foo/bar，$route.matched 將會是一個包含從上到下的所有物件 (副本)。
# $route.name
當前路由的名稱，如果有的話。(檢視命名路由)
# $route.redirectedFrom
如果存在重定向，即為重定向來源的路由的名字.
複製程式碼router-link
# Props
to : string | Location
<!-- 字串 -->
<router-link to="home">Home</router-link>
<!-- 渲染結果 -->
<a href="home">Home</a>
<!-- 使用 v-bind 的 JS 表示式 -->
<router-link :to="'home'">Home</router-link>
<!-- 同上 -->
<router-link :to="{ path: 'home' }">Home</router-link>
<!-- 命名的路由 -->
<router-link :to="{ name: 'user', params: { userId: 123 }}">User</router-link>
<!-- 帶查詢引數，下面的結果為 /register?plan=private -->
<router-link :to="{ path: 'register', query: { plan: 'private' }}">Register</router-link>
#replace: boolean
設定 replace 屬性的話，當點選時，會呼叫 router.replace()並且不會留下 history 記錄。
<router-link :to="{ path: '/abc'}" replace></router-link>
# append: boolean
設定 append 屬性後，則在當前（相對）路徑前新增基路徑。例如，我們從 /a 導航到一個相對路徑 b，如果沒有配置 append，則路徑為 /b，如果配了，則為 /a/b
<router-link :to="{ path: 'relative/path'}" append></router-link>
#tag: string
預設值: "a"
<router-link to="/foo" tag="li">foo</router-link>
<!-- 渲染結果 -->
<li>foo</li>
# active-class: string
預設值: "router-link-active"
設定 連結啟用時使用的 CSS 類名。預設值可以通過路由的構造選項 linkActiveClass 來全域性配置。
# exact: boolean
"是否啟用"
<!-- 這個連結只會在地址為 / 的時候被啟用 -->
<router-link to="/" exact>
#event(2.1.0+) : string | Array<string>```
宣告用來觸發導航的事件。可以是一個字串或是一個包含字串的陣列。
複製程式碼router-view
<router-view> 渲染的元件還可以內嵌自己的 <router-view>，根據巢狀路徑，渲染巢狀元件。
name 型別: string 預設值: "default"
如果 <router-view>設定了名稱，則會渲染對應的路由配置中 components 下的相應元件.所以可以配合 <transition> 和 <keep-alive> 使用。如果兩個結合一起用，要確保在內層使用 <keep-alive>：
<transition>
<keep-alive>
<router-view></router-view>
</keep-alive>
</transition>
複製程式碼