十全大補vue-router

將組件(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>
複製代碼