vue項目創建步驟 和 路由router知識點

  • 2020 年 2 月 10 日
  • 筆記

菜單快捷導航:

  1. vue項目創建
  2. vue路由router知識點(路徑參數、查詢參數、命名路由、嵌套路由、命名視圖、hash/history模式)
  3. vue導航守衛(全局守衛、單個路由獨享、組件級守衛)

1、創建一個vue項目步驟 (windows環境下)。創建vue項目前,檢查系統是否具備創建項目的條件(是否已經安裝好了node.js、webpack、vue-cli)。cmd打開終端。

1.1 如果還沒安裝node.js, 則先安裝node.js ,安裝完成後,查看node版本

node -v

1.2 安裝淘寶鏡像, 安裝完成後查看npm版本:npm -v

npm install -g cnpm --registry=https://registry.npm.taobao.org

1.3 安裝webpack

npm install webpack -g

1.4 安裝vue全局腳手架,vue-cli2.x使用  npm install -g vue-cli  , vue-cli3.x使用   npm install -g @vue/cli  安裝, 查看vue版本: vue -V  

npm install -g vue-cli

  或 

npm install -g @vue/cli 

1.5 準備工作做好了,開始正式創建vue項目, 創建vue項目可以選擇兩種方式。下面的my_vue_pro是vue項目名字

vue init webpack my_vue_pro

  或

vue create my_vue_pro

  vue init  是vue-cli2.x的初始化方式,可以使用github上面的一些模板來初始化項目,webpack是官方推薦的標準模板名。vue-cli2.x項目向3.x遷移只需要把static目錄複製到public目錄下,老項目的src目錄覆蓋3.x的src目錄。 vue  create   是vue-cli3.x的初始化方式,目前模板是固定的,模板選項可自由配置,創建出來的是vue-cli3的項目,與vue-cli2項目結構不同,配置方法不同,具體配置方法參考官方文檔

  如果vue版本還是2.x, 從vue-cli2.x升級到最新版:先執行卸載: npm uninstall -g vue-cli  , 再安裝最新版  npm install -g @vue/cli  

1.6  cd進入項目

cd my_vue_pro

1.7 添加需要的依賴包,比如添加vue路由vue-router依賴包,可以使用  npm install vue-router  , 或者  vue add router  

npm install vue-router

  或

vue add router

1.8 安裝所有依賴包, npm install  。卸載依賴包: npm uninstall xxx 

cnpm install

1.9 運行項目,查看package.json文件中的scripts腳本中的運行方式, npm run dev  或  npm  run serve  

npm run serve

2、vue路由vue-router解說

  Vue Router 是 Vue.js 官方的路由管理器。它和 Vue.js 的核心深度集成,讓構建單頁面應用變得易如反掌。包含的功能有:

  • 嵌套的路由/視圖表
  • 模塊化的、基於組件的路由配置
  • 路由參數、查詢、通配符
  • 基於 Vue.js 過渡系統的視圖過渡效果
  • 細粒度的導航控制
  • 帶有自動激活的 CSS class 的鏈接
  • HTML5 歷史模式或 hash 模式,在 IE9 中自動降級
  • 自定義的滾動條行為

為了加深對路由的理解,在安裝vue-router包後,如果項目自動生成了router.js, 先刪除,我們手動來寫一個router.js。創建router.js後,再新增加2個vue頁面,命名pageA和pageB,如下圖:

其中router.js代碼

import Vue from 'vue'  import Router from 'vue-router'  //自定義頁面  import PageA from './views/PageA'  import PageB from './views/PageB'    //安裝路由到vue  Vue.use(Router)    const routes = [      {          path: '/',          redirect: '/pageB'  //重定向,設置默認進入pageB頁面      }, {          //動態路徑參數,以冒號開頭,如果有多個參數則繼續往後面追加          path: '/pageA/:id/:name',          name: 'pageA',          component: PageA      }, {          path: '/pageB',          name: 'pageB',          component: PageB      }  ]    export default new Router({      //mode: 'hash', //默認hash模式,hash模式有#;另外還有一種history模式,沒有#符號      routes  })

main.js是vue項目的入口腳本,在這裡引入router.js, 傳入路由配置。

import Vue from 'vue'  import App from './App.vue'  import router from './router.js'    Vue.config.productionTip = false    new Vue({    router,  //key名字必須命名為router    render: h => h(App)  }).$mount('#app')

2.1 路由視圖<router-view> 組件和 路由導航<router-link>組件

 在項目啟動模板頁App.vue上面有個<router-view>路由視圖組件,相當於是一個佔位符一樣(<slot>插槽也類似),之後頁面的路由變化引起的頁面替換都是在<router-view>路由視圖上進行。

  而<router-link>有點類似於超鏈接標籤<a>,<router-link>上有個必寫的屬性to, 就類似於超鏈接<a>的href屬性,設置要跳轉的路由鏈接。

  App.Vue測試代碼:

<template>    <div id="app">      <div id="nav">        <router-link to="/pageA/5188/王大鎚">pageA</router-link> |        <router-link to="/pageB">pageB</router-link>      </div>      <router-view/>    </div>  </template>

2.2 路徑參數和查詢參數

  路徑參數和查詢參數作為頁面之間的數據傳遞的一種方式,使用非常頻繁。路徑參數,望文生義意思是參數作為路徑的一部分,在配置路由的時候把參數配置好,然後在瀏覽器中輸入url時,必須傳參,否則會找不到這個路由這個頁面。例如,pageA頁面的路由配置為:/pageA/:id/:name  ,意思是pageA頁面後面必須傳一個id參數和name參數,這兩個參數作為路徑的一部分,必須傳值。然後在pageA頁面中用:this.$route.params 來獲取所有的路徑參數。

  而查詢參數則沒有路徑參數這麼嚴格,路由不會對此做驗證。路由參數在url中的表現為頁面鏈接後面加 ?key=value&… , 然後在頁面中用:this.$route.query 來獲取所有查詢參數。如下圖:

我們打印this.$route變量,看到如上圖右邊部分內容:

  • this.$route.name : 頁面名字。這個name就是在router.js中配置的那個name, 這個name也是有大用處的,比如在<router-link>中使用「命名路由」的時候就是用到它,舉例說明,通過在路由鏈接標籤的to屬性設置name和相應的參數,然後跳轉效果和設置路由path是一樣的:
<router-link :to="{ name: 'pageA', params: { id: 5188, name:'王大鎚' }}">命名路由pageA</router-link>
  • this.$route.path: 路由路徑,包含路徑參數,不包含查詢參數
  • this.$route.fullPath: 路由全路徑,包含路徑參數和查詢參數
  • this.$route.query: 路徑所有查詢參數
  • this.$route.params: 路徑所有路徑參數
  • this.$route.meta: 路由元信息,在配置路由的時候可以把自定義的一些數據存在meta中,用作其他用途
  • this.$route.matched: 裏面包含了路由的一些匹配信息

2.3 路由props設置及路徑參數獲取

  在設置頁面路由時,如果增加一個props屬性,並設置為true, 則在頁面中可以直接拿到參數,不需要通過this.$route.params來取參數。比如router.js中部分代碼:

{          path: '/pageC/:id/:name',          name: 'pageC',          props: true, //設置props屬性為true, 則可以在PageC頁面中直接取參數          component: PageC      }

在PageC頁面中參數獲取:

<template>      <div class="box">          <h1>佛山 -- 黃飛鴻,from PageC </h1>          <h3>男兒何不帶吳鉤,收取關山五十州</h3>          <h3>路徑參數id: {{this.id}}, name: {{this.name}}</h3>      </div>  </template>    <script>      export default {          name: 'pageC',          props: ['id', 'name'], //直接接收路徑參數          created(){              console.log("id: ", this.id, ", name: ", this.name)          }      }  </script>

2.4 嵌套路由。實際生活中的應用界面,通常由多層嵌套的組件組合而成。同樣地,URL 中各段動態路徑也按某種結構對應嵌套的各層組件。比如現在PageB頁面中嵌入頁面PageC, 則需要在PageB頁面中增加一個路由視圖<router-view>標籤,作為嵌套頁面PageC的佔位符。

  路由部分代碼:

{          path: '/pageB',          name: 'pageB',          component: PageB,          meta: { isOK: true, type: 9 },          children: [              {                  path: 'pageC/:id/:name',                  component: PageC,                  props: true, //設置props屬性為true, 則可以在PageC頁面中直接取參數                  name: 'subPageC',                  meta: { requiresAuth: true, id: 51666 }, //自定義數據              }          ]      },

 PageB頁面中部分代碼:

<template>      <div class="box">          <h1>一片雲 -- 羅小虎,from PageB </h1>          <h3>千磨萬擊還堅勁,任爾東南西北風</h3>          <!-- 嵌套路由,嵌套頁面佔位符 -->          <router-view></router-view>      </div>  </template>    <script>      export default {          name: 'pageB',          created(){              console.log('...pageB...')              console.log(this.$route)          }        }  </script>

  效果圖:

2.5 編程式的導航。 <router-link>叫聲明式導航,還有種編程式導航,格式為:router.push(location, onComplete?, onAbort?), 在頁面中的使用例子:

// 字符串  router.push('home')    // 對象  router.push({ path: 'home' })    // 命名的路由  router.push({ name: 'user', params: { userId: '123' }})    // 帶查詢參數,變成 /register?plan=private  router.push({ path: 'register', query: { plan: 'private' }})    /*注意:如果提供了 path,params 會被忽略,上述例子中的 query 並不屬於這種情況。  取而代之的是下面例子的做法,你需要提供路由的 name 或手寫完整的帶有參數的 path:  */  const userId = '123'  router.push({ name: 'user', params: { userId }}) // -> /user/123  router.push({ path: `/user/${userId}` }) // -> /user/123  // 這裡的 params 不生效, 即編程式導航如果提供了path, 則路徑參數必須寫入path中。而查詢參數可以不寫入  router.push({ path: '/user', params: { userId }}) // -> /user

  同樣的編程式導航規則也適用於<router-link>導航組件的to屬性

  router.replace(location, onComplete?, onAbort?) 和router.push(…)很像,唯一的不同就是,它不會向 history 添加新記錄,而是跟它的方法名一樣 —— 替換掉當前的 history 記錄。聲明式導航替換用法: <router-link :to="…" replace>  ,編程式導航替換用法:  router.replace(…)  

     router.go(n)的使用,這個方法的參數是一個整數,意思是在 history 記錄中向前或者後退多少步,類似 window.history.go(n)

// 在瀏覽器記錄中前進一步,等同於 history.forward()  router.go(1)    // 後退一步記錄,等同於 history.back()  router.go(-1)    // 前進 3 步記錄  router.go(3)    // 如果 history 記錄不夠用,那就默默地失敗唄  router.go(-100)  router.go(100)

2.6 命名視圖。有時候想同時 (同級) 展示多個視圖,而不是嵌套展示,例如創建一個布局,有 sidebar (側導航) 和 main (主內容) 兩個視圖,這個時候命名視圖就派上用場了。你可以在界面中擁有多個單獨命名的視圖,而不是只有一個單獨的出口。如果 router-view 沒有設置名字,那麼默認為 default

router.js中部分代碼:

{          path: '/pageD',          name: 'pageD',          components: {  //演示命名視圖              default: PageD,              tanA: PageA,              tanB: PageB          }      }

App.vue中部分代碼:

<router-view/>      <!-- 命名視圖, 路由視圖名字匹配了,就會展示匹配的頁面內容 -->      <router-view name="tanA"/>      <router-view name="tanB"/>

2.7 路由模式。默認路由模式是hash模式,即地址欄中域名後帶有#符號(此 hash 不是密碼學裏的散列運算)。它的特點就是使用 URL 的 hash 來模擬一個完整的 URL,於是當 URL 改變時,頁面不會重新加載。不過看起來不是很美觀,另外hash模式的路由,在作為回調地址和一些第三方公司合作時,會有點麻煩,比如如果想實現微信快捷登錄或者獲取微信用戶授權時,當微信用戶授權成功後,回跳回來時,微信返回的code參數會插入到#符號前面,這樣的話就為了獲取這個code,就需要一系列的另外操作了。

  路由模式還有另外一種模式就是history模式,這種模式是沒有#符號的,符合我們平常的使用習慣。這種模式充分利用 history.pushState API 來完成 URL 跳轉而無須重新加載頁面。

export default new Router({      //mode: 'hash', //默認hash模式,hash模式有#;另外還有一種history模式,沒有#符號      mode: 'history', //history模式,沒有#符號      routes  })

  不過這種模式要玩好,還需要後台配置支持。因為我們的應用是個單頁客戶端應用,如果後台沒有正確的配置,當用戶在瀏覽器直接訪問 http://oursite.com/user/id 就會返回 404,這就不好看了。

  所以呢,你要在服務端增加一個覆蓋所有情況的候選資源:如果 URL 匹配不到任何靜態資源,則應該返回同一個 index.html 頁面,這個頁面就是你 app 依賴的頁面。

3、路由導航守衛。「導航」表示路由正在發生改變,vue-router提供的導航守衛主要用來通過跳轉取消的方式守衛導航,從而達到控制導航走向。有多種機會植入路由導航過程中:全局的,單個路由獨享的,或者組件級的。

3.1 全局前置守衛: router.beforeEach  

import router from './router.js'    Vue.config.productionTip = false    //全局守衛  //beforeEach, 全局前置守衛,當一個導航觸發時,全局前置守衛按照創建順序調用。  router.beforeEach((to, from, next)=>{    console.log("....beforeEach....")      //數據校驗時    // if (to.fullPath === '/home'){    //   next('/login')    // }      if (to.path != '/login'){      next();    }    else {      setTimeout(()=>{        next();      }, 1000)    }      console.log(to)    console.log(from)    console.log(next);  })

 當一個導航觸發時,全局前置守衛按照創建順序調用。守衛是異步解析執行,此時導航所在所有守衛resolve完之前一直處於等待中。

每個守衛方法接收三個參數:

  • to: Route: 即將要進入的目標 路由對象
  • from: Route: 當前導航正要離開的路由
  • next: Function: 一定要調用該方法來 resolve 這個鉤子。執行效果依賴 next 方法的調用參數。
    • next(): 進行管道中的下一個鉤子。如果全部鉤子執行完了,則導航的狀態就是 confirmed (確認的)。
    • next(false): 中斷當前的導航。如果瀏覽器的 URL 改變了 (可能是用戶手動或者瀏覽器後退按鈕),那麼 URL 地址會重置到 from 路由對應的地址。
    • next('/') 或者 next({ path: '/' }): 跳轉到一個不同的地址。當前的導航被中斷,然後進行一個新的導航。你可以向 next 傳遞任意位置對象,且允許設置諸如 replace: truename: 'home' 之類的選項以及任何用在 router-link 的 to prop 或 router.push 中的選項。
    • next(error): (2.4.0+) 如果傳入 next 的參數是一個 Error 實例,則導航會被終止且該錯誤會被傳遞給 router.onError() 註冊過的回調。

確保要調用 next 方法,否則鉤子就不會被 resolved。

3.2 全局解析守衛: router.beforeResolve  ,這和 router.beforeEach 類似,區別是在導航被確認之前,同時在所有組件內守衛和異步路由組件被解析之後,解析守衛就被調用

3.3 全局後置鉤子: router.afterEach  ,然而和守衛不同的是,這些鉤子不會接受 next 函數也不會改變導航本身:

router.afterEach((to, from)=>{    console.log("....afterEach....")    console.log(to)    console.log(from)  })

3.4 路由獨享守衛: beforeEnter  ,參數和全局前置守衛一樣,執行順序在全局前置守衛之後,在全局解析守衛之前。router.js中部分測試代碼:

 {          //動態路徑參數,以冒號開頭,如果有多個參數則繼續往後面追加          path: '/pageA/:id/:name',          name: 'pageA',          component: PageA,          //路由獨享的守衛          beforeEnter: (to, from, next) => {              console.log(".....路由獨享的守衛...beforeEnter...")              console.log(to)              console.log(from)              console.log(next)              next();          }      },

3.5 組件內路由守衛。進入組件時、組件路徑參數變化時,離開組件時分別監聽。

<script>      export default {          name: 'pageA',          //組件內的守衛          beforeRouteEnter (to, from, next) {              // 在渲染該組件的對應路由被 confirm 前調用              // 不!能!獲取組件實例 `this`              // 因為當守衛執行前,組件實例還沒被創建              console.log('...組件內守衛beforeRouteEnter...')              console.log(to)              console.log(from)              next();          },          beforeRouteUpdate (to, from, next) {              // 在當前路由改變,但是該組件被複用時調用              // 舉例來說,對於一個帶有動態參數的路徑 /foo/:id,在 /foo/1 和 /foo/2 之間跳轉的時候,              // 由於會渲染同樣的 Foo 組件,因此組件實例會被複用。而這個鉤子就會在這個情況下被調用。              // 可以訪問組件實例 `this`              console.log('...組件內守衛beforeRouteUpdate2222...')              console.log(to)              console.log(from)              next();          },          beforeRouteLeave (to, from, next) {              // 導航離開該組件的對應路由時調用              // 可以訪問組件實例 `this`              console.log('...組件內守衛beforeRouteLeave3333...')              console.log(to)              console.log(from)              next();          }      }  </script>

注意: beforeRouteEnter 守衛衛 不能 訪問 this,因為守衛在導航確認前被調用,因此即將登場的新組件還沒被創建。不過,你可以通過傳一個回調給 next來訪問組件實例。在導航被確認的時候執行回調,並且把組件實例作為回調方法的參數。

beforeRouteEnter (to, from, next) {    next(vm => {      // 通過 `vm` 訪問組件實例    })  }

  beforeRouteEnter 是支持 給next 傳遞迴調的唯一守衛。對於 beforeRouteUpdate beforeRouteLeave 來說,this已經可用了,所以不支持傳遞迴調,因為沒有必要了。

  beforeRouteLeave  這個離開守衛通常用來禁止用戶在還未保存修改前突然離開。該導航可以通過 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)    }  }

完整的導航解析流程

  1. 導航被觸發。
  2. 在失活的組件里調用離開守衛。
  3. 調用全局的 beforeEach 守衛。
  4. 在重用的組件里調用 beforeRouteUpdate 守衛 (2.2+)。
  5. 在路由配置里調用 beforeEnter
  6. 解析異步路由組件。
  7. 在被激活的組件里調用 beforeRouteEnter
  8. 調用全局的 beforeResolve 守衛 (2.5+)。
  9. 導航被確認。
  10. 調用全局的 afterEach 鉤子。
  11. 觸發 DOM 更新。
  12. 用創建好的實例調用 beforeRouteEnter 守衛中傳給 next 的回調函數。

測試DEMO:https://github.com/xiaotanit/tan_vue