手摸手,帶你用vue擼后臺 系列五(v4.0新版本)

前言

vue-element-admin2017.04.17提交第一個 commit 以來,維護至今已經有兩年多的時間了了,發布了四十多個版本,收獲了三萬多的 stars,遠遠的超出了自己的預期。距離上次手摸手系列教程也已經過去了很久,主要因為:作為一個個人開源項目,維持它已經很難了,所以真的沒啥時間寫詳細的教程了,光是維護項目 文檔 就讓我很頭疼了。也有不少人建議我出付費教學視頻,但我個人還是更愿意把這個時間投入到維護開源項目之中吧。

本篇教程主要是趁著vue-element-admin發布了 v4.0 新版本,首先來簡單說一下4.0版本做了哪些改動和優化。后半部分則會分享一些新的思考和一些小技巧吧。之前幾篇手摸手文章都差不多兩年前的了,但隨著技術的不斷發展迭代,很多之前的不能解決的問題也是都是有了新的解決方案的,同時也會出現一些新的問題和挑戰。

4.0 做了什么

首先大概說一下4.0版本做了些什么,通過 pull request 可以看出這是一次比較大的升級,有大概 170 多次的 commits,200 多個文件的改動。其中最大的改變是接軌 vue 社區,直接通過 vue-cli來進行構建,省去了很多額外繁瑣的配置(下文會介紹),并修改了之前 mock 數據的方案,本地改用 mock-server 來解決之前mockjs帶來的各種問題。同時增加了 jest 單元測試,使用了async/await,增加了可視化配置權限,增加了自定義布局等等,優化了原先addRoutes的權限方案,支持不刷新頁面更新路由等等功能。具體的可看 github release。接下來我們著重來分析一下這幾個功能。

vue-cli@3

本身配置方面沒有啥特別好說的,官方文檔已經寫得很詳細了。這次更新基本上就是基于 webpack-chain 把之前的 webpack 配置遷移了一遍,因為vue-cli幫你做了很多默認配置,所有可以省去一些代碼。當然這種out-of-the-box的工具利弊也很明顯,它能快速上手,大部分簡單場景無需任何額外配置基本就能用了。但對于復雜度高的或者自定義性強的項目來說,配置復雜度可能沒有減少太多。它要求你不僅要對 webpack 或者相關工程化的東西很很熟悉,你還要對vue-cli做的一些默認配置和參數也有有一定了解,時不時要去看一下源碼它到底干了啥,有的時候它的一些 plugin 出現了問題還不太好解決。而且說實話 webpack-chain 的書寫也是有些門檻的,大部分情況下我也很難保證自己的配置寫對的,還好官方提供了inspec功能,能讓配置簡單了不少。當你想知道自己的 vue-config.js 里的配置到底對不對的時候,你可以在命令行里執行vue inspect > output.js,它會將你最終生成的config展現在output.js之中,不過它默認顯示的是開發環境的配置。如果你想查看其它環境的配置可以通過vue inspect --mode production > output.js。在寫構建配置的時候這個功能很有幫助,同時也能幫助你了解vue-cli在構建時到底幫你做了些什么。

其它還有些需要注意的如:環境變量 必須以VUE_APP_開頭啊,怎么設置polyfill啊,怎么配置各種各樣的loader啊,就不展開了,文檔或者社區都有很多文章了。具體配置可以參考 vue.config.js

這里還有一個黑科技,看過我之前文章的小伙伴應該還有印象,我一般在開發環境是不使用路由懶加載的,因為這樣會導致熱更新速度變慢,具體的可以看之前的 文章,在vue-cli@3中可以更簡單的實現,你只要在.env.development環境變量配置文件中設置VUE_CLI_BABEL_TRANSPILE_MODULES:true就可以了。它的實現邏輯和原理與之前還是一樣的,還是基于 plugins babel-plugin-dynamic-import-node 來實現的。之所以在vue-cli中只需要設置一個變量就可以了,是借用了vue-cli它的默認配置,它幫你代碼都寫好了。通過閱讀 源碼 可知,vue-cli會通過VUE_CLI_BABEL_TRANSPILE_MODULES這個環境變量來區分是否使用babel-plugin-dynamic-import-node,所以我們只要開其它就可以。雖然它的初衷是為了單元測試的,但正好滿足了我們的需求。

總的來說,vue-cli對于大部分用戶來說還是省去了一些繁瑣的配置的。如果你使用本項目的話,基本也不需要做其它過多的額外配置的。

redirect 刷新頁面

在不刷新頁面的情況下,更新頁面。這個 issue 兩年前就提出來了,之前的文章里面也提供了一個 解決方案。在這里分享一下,我目前使用的新方案。

// 先注冊一個名為 `redirect` 的路由
<script>
export default {
  beforeCreate() {
    const { params, query } = this.$route
    const { path } = params
    this.$router.replace({ path: '/' + path, query })
  },
  render: function(h) {
    return h() // avoid warning message
  }
}
</script>
// 手動重定向頁面到 '/redirect' 頁面
const { fullPath } = this.$route
this.$router.replace({
  path: '/redirect' + fullPath
})

當遇到你需要刷新頁面的情況,你就手動重定向頁面到redirect頁面,它會將頁面重新redirect重定向回來,由于頁面的 key 發生了變化,從而間接實現了刷新頁面組件的效果。

addRoutes && removeRoutes

看過我之前文章的人肯定知道,我目前 vue 項目的權限控制都是通過 addRoutes來實現的。簡單說就是:用戶登錄之后會返回一個權限憑證Token,用戶在根據這個Token去問服務端詢問自己的權限,辟如服務端返回權限是['editor'],前端再根據這個權限動態生成他能訪問的路由,再通過addRoutes進行動態的路由掛載。具體的代碼可見 permission.js

但這個方案一直是有一個弊端的。那就是動態添加的路由,并不能動態的刪除。這就是導致一個問題,當用戶權限發生變化的時候,或者說用戶登出的時候,我們只能通過刷新頁面的方式,才能清空我們之前注冊的路由。之前老版本的 vue-element-admin就一直采用的是這種方式。雖然能用,但作為一個 spa,刷新頁面其實是一種很糟糕的用戶體驗。但是官方也遲遲沒有出相關的 remove api,相關 issue

后來發現了一種 hack 的方法,能很好的動態清除注冊的路由。先看代碼:

image

它的原理其實很簡單,所有的 vue-router 注冊的路由信息都是存放在matcher之中的,所以當我們想清空路由的時候,我們只要新建一個空的Router實例,將它的matcher重新賦值給我們之前定義的路由就可以了。巧妙的實現了動態路由的清除。
現在我們只需要調用resetRouter,就能得到一個空的路有實例,之后你就可以重新addRoutes你想要的路由了。完整的代碼實例 router.jsresetRouter

Mock 數據

如果你在實際開發中,最理想的前后端交互方式當然是后端先幫我們 mock 數據,然后前端開發。但現實很骨感,總會因為種種原因,前端需要自己來 mock 假數據。尤其是我的幾個開源項目,都是純前端項目,根本沒有后端服務。
在之前的文章中也介紹過,vue-element-adminvue-admin-template 使用的是 MockJSeasy-mock 這兩個庫。但實際用下來兩者都有一些問題。

  • MockJs

    它的原理是: 攔截了所有的請求并代理到本地,然后進行數據模擬,所以你會發現 network 中沒有發出任何的請求。但它的最大的問題是就是它的實現機制。它會重寫瀏覽器的XMLHttpRequest對象,從而才能攔截所有請求,代理到本地。大部分情況下用起來還是蠻方便的,但就因為它重寫了XMLHttpRequest對象,所以比如progress方法,或者一些底層依賴XMLHttpRequest的庫都會和它發生不兼容,可以看一下我項目的 issues,就知道多少人被坑了。

    它還有一個問題:因為是它是本地模擬數據,實際上不會走任何網絡請求。所以本地調試起來很蛋疼,只能通過console.log來調試。就拿vue-element-admin來說,想搞清楚 getInfo()接口返回了什么數據,只能通過看源碼或者手動 Debug 才能知道。

  • Easy-Mock

    這個項目剛出的時候用的人比較少,還真的挺好用的。天然支持跨域,還是支持MockJs的所有語法,我在之前也推薦過。但因為用的人多了,它的免費服務會經常的掛,可以說天天掛。。。但畢竟人家這是免費的服務,也不能苛求什么,官方的建議是自己搭建服務。如果你的公司整體搭建一個這樣的 mock 服務的話也是一個不錯的選擇。但大部分人可能還是沒有這個技術條件的。

新方案

所以我一直在尋求一個更好的解決方案,我也去體驗了其它很多 mock api 服務,如 mockapiMocky 等等。總之體驗都不能滿足我的需求。

v4.0版本之后,在本地會啟動一個mock-server來模擬數據,線上環境還是繼續使用mockjs來進行模擬(因為本項目是一個純前端項目,你也可以自己搭建一個線上 server 來提供數據)。不管是本地還是線上所以的數據模擬都是基于mockjs生成的,所以只要寫一套 mock 數據,就可以在多環境中使用。

該方案的好處是,在保留 mockjs的優勢的同時,解決之前的痛點。由于我們的 mock 是完全基于webpack-dev-serve來實現的,所以在你啟動前端服務的同時,mock-server就會自動啟動,這里還通過 chokidar 來觀察 mock 文件夾內容的變化。在發生變化時會清除之前注冊的mock-api接口,重新動態掛載新的接口,從而支持熱更新。有興趣的可以自己看一下代碼 mock-server.js。由于是一個真正的server,所以你可以通過控制臺中的network,清楚的知道接口返回的數據結構。并且同時解決了之前mockjs會重寫 XMLHttpRequest對象,導致很多第三方庫失效的問題。

在本地開發環境中基于webpack-dev-serveafter這個middleware中間件,在這里自動讀取你的 mock文件,模擬出 REST API,它最大的好處是,完全不需要什么額外的工作,完全基于webpack-dev-serve就能實現。如果你還是想單獨啟動一個serve也是可以的,完全可以引入一個express或者其它插件來啟動一個 mock-serve。

我們模擬數據有了,現在要做的事情就是,將我們的接口代理到我們的 mock 服務上就好了,這里我們使用webpack-dev-serve自帶的 proxy進行接口代理。

proxy: {
      // xxx-api/login => mock/login
      [process.env.VUE_APP_BASE_API]: {
        target: `http://localhost:${port}/mock`,
        changeOrigin: true,
        pathRewrite: {
          ['^' + process.env.VUE_APP_BASE_API]: ''
        }
      }
    }

snippets 自動生成代碼片段

平時日常工作中,做最多的就是寫業務模塊和組件。當每次新開一個view或者component的時候都需要手動創建一個新.vue文件,然后再創建<template><script><style>這些標簽,還是有些麻煩的。

所以在新版本中,基于plop,提供了幾個基礎模板,方便創建新的view或者component
執行如下命令:

npm run new
plop

如上面 gif 所示,現在只要輕松的點幾次回車就可以輕松生成我要的基礎代碼片段。這里只是一個 demo,你完全可以按照自己需求定制模板。老版本的vue-cli實現邏輯和它類似。

如果你覺得配置太復雜,我推薦你可以安裝如 Vue 2 Snippets VS Code插件。 這種代碼片段在平時工作中還是能提升不少開發效率的。

async/await or promise

本次更新中,我也將部分代碼用了async/await的方式替代了原有的 promise方式,主要是 @/src/permission.js。有興趣的大家自己可以通過 git-history 自己對比下,可以發現代碼閱讀性高了不少。 不過本項目中也并沒有把所有promiseasync/await替代。我來簡單說一下我的看法。

6 個 Async/Await 優于 Promise 的方面,這篇文章很多人應該都看過,里面大部分觀點我都是同意的,大部分復雜場景下async/await的確是更優解。但相對的也不是所有的情況下都是async/await寫起來讓我更爽的。先說說我最不爽的地方是它的錯誤處理,try catch讓這個代碼結構看起來就很奇怪(當然也有很多人很喜歡這種錯誤處理形式。社區也是相對的解決方案類似go語言的風格,比如 await-to-js

[err, res] = await to(getInfo())
if(err) //do something

這個方案是不錯,但還需要引入一個新的庫,增加了學習成本,得不償失。所以以我個人的習慣,當只有一個異步請求,且需要做錯誤處理的情況下,更傾向于使用 promise。比如

// promise
getInfo()
  .then(res => {
    //do somethings
  })
  .catch(err => {
    //do somethings
  })

// async/await
try {
  const res = await getInfo()
  //do somethings
} catch (error) {
  //do somethings
}

在有嵌套請求的情況下,肯定是 async/await 更直觀的。

// promise
a(() => {
  b(() => {
    c()
  })
})

// async/await
await a()
await b()
await c()

當然代碼寫的好與不好還是取決于寫代碼的人的。比如一個常見的業務場景:有兩個并發的異步請求,在都完成后do something。但很多人會錯誤的用串行的方式實現了。

//錯誤
await a()
await b()
//這樣變成了 a().then(() => b() )
// a 好了才會執行 b
done()

//正確
await Promise.all([a(), b()])
done()

還有一個小細節async/await打包后的代碼其實會比 promise 復雜很多, 當然這個是一個忽略不計得問題。

總結:我認為它們兩個人并不是or的關系,在特定的業務場景下,選擇相對而言代碼可讀性更好地解決方案。

以上所述純個人偏愛,并非什么最佳實現。具體該怎么選擇還是需要大家更具自己團隊的風格或者自己的理解來判斷。

命名規范

其實剛開始我寫 vue 文件的時候也不注意,各種駝峰啊、大寫開頭 (PascalCase)還是橫線連接 (kebab-case)混著來,誰叫 vue 都可以,在 風格指南 中也沒有定論。不過基于本項目我還是整理了一套文件的命名規則。

Component

所有的Component文件都是以大寫開頭 (PascalCase),這也是官方所 推薦的

但除了 index.vue

例子:

  • @/src/components/BackToTop/index.vue
  • @/src/components/Charts/Line.vue
  • @/src/views/example/components/Button.vue

JS 文件

所有的.js文件都遵循橫線連接 (kebab-case)。

例子:

  • @/src/utils/open-window.js
  • @/src/views/svg-icons/require-icons.js
  • @/src/components/MarkdownEditor/default-options.js

Views

views文件下,代表路由的.vue文件都使用橫線連接 (kebab-case),代表路由的文件夾也是使用同樣的規則。

例子:

  • @/src/views/svg-icons/index.vue
  • @/src/views/svg-icons/require-icons.js

使用橫線連接 (kebab-case)來命名views主要是出于以下幾個考慮。

  • 橫線連接 (kebab-case) 也是官方推薦的命名規范之一 文檔
  • views下的.vue文件代表的是一個路由,所以它需要和component進行區分(component 都是大寫開頭)
  • 頁面的url 也都是橫線連接的,比如https://www.xxx.admin/export-excel,所以路由對應的view應該要保持統一
  • 沒有大小寫敏感問題

CDN

你可以通過執行npm run preview -- --report來分析webpack打包之后的結果,觀察各個靜態資源的大小。你可以發現占用空間最多的是第三方依賴。如vueelement-uiECharts等。

你可以使用 CDN 外鏈的方式引入第這些三方庫,這樣能大大增加構建的速度(通過 CDN 引入的資源不會經 webpack 打包)。如果你的項目沒有自己的CDN服務的話,使用一些第三方的CDN服務,如 jsdelivrunpkg 等是一個很好的選擇,它提供過了免費的資源加速,同時提供了緩存優化,由于你的第三方資源是在html中通過script引入的,它的緩存更新策略都是你自己手動來控制的,省去了你需要優化緩存策略功夫。

很多文章說使用 CDN 引入的方式能大大減小代碼的體積,這是不可能的。雖然打包完的 bundle小了,但那部分代碼只是被你拆出去,用CDN的方式引入罷了。你想減小體積,最高效的方案是啟用GZIP

我個人暫時不使用CDN引入第三方依賴的原因:

暫時構建速度還沒有遇到什么瓶頸,所有沒有必要單獨剝離部分第三方依賴。使用CDN引入的方式等于一些第三方依賴的版本你是通過package.json來控制的,一些依賴則需要手動維護,增加了一些維護成本。目前基于 webpack 的optimization.splitChunks已經做了資源的緩存優化,靜態資源的緩存已經做得很好了。并且目前所有的靜態資源都會上傳到自己的CDN服務,沒有必要使用第三方的CDN服務。

當然所有的優化都是需要結合自己的具體業務來調整的! 之后可能會采用這種引入方式,或者使用webpack dll的方式進行優化。如果你覺得CDN引入對于的項目有益處,你可以遵循如下方法進行修改:

使用方式

先找到 vue.config.js, 添加 externalswebpack 不打包 vueelement

externals: {
  vue: 'Vue',
  'element-ui':'ELEMENT'
}

然后配置那些第三方資源的CDN,請注意先后順序。

const cdn = {
  css: [
    // element-ui css
    'https://unpkg.com/element-ui/lib/theme-chalk/index.css'
  ],
  js: [
    // vue must at first!
    'https://unpkg.com/vue/dist/vue.js',
    // element-ui js
    'https://unpkg.com/element-ui/lib/index.js'
  ]
}

之后通過 html-webpack-plugin注入到 index.html之中:

config.plugin('html').tap(args => {
  args[0].cdn = cdn
  return args
})

找到 public/index.html。通過你配置的CND Config 依次注入 css 和 js。

<head>
  <!-- 引入樣式 -->
  <% for(var css of htmlWebpackPlugin.options.cdn.css) { %>
    <link rel="stylesheet" href="<%=css%>">
  <% } %>
</head>

<!-- 引入JS -->
<% for(var js of htmlWebpackPlugin.options.cdn.js) { %>
  <script src="<%=js%>"></script>
<% } %>

完整的 代碼修改

最終你可以使用 npm run preview -- --report 查看效果 如圖:

image

同理,其它第三方依賴都可以使用相同的方式處理(比如vuexvue-router等)。當然你也可以選擇使用 DLLPlugin的方式來處理第三方依賴,從而來優化構建。

小技巧與建議

Watch immediate

這個已經算是一個比較常見的技巧了,這里就簡單說一下。當 watch 一個變量的時候,初始化時并不會執行,如下面的例子,你需要在created的時候手動調用一次。

// bad
created() {
  this.fetchUserList();
},
watch: {
  searchText: 'fetchUserList',
}

你可以添加immediate屬性,這樣初始化的時候也會觸發,然后上面的代碼就能簡化為:

// good
watch: {
  searchText: {
    handler: 'fetchUserList',
    immediate: true,
  }
}

ps: watch 還有一個容易被大家忽略的屬性deep。當設置為true時,它會進行深度監聽。簡而言之就是你有一個 const obj={a:1,b:2},里面任意一個 key 的 value 發生變化的時候都會觸發watch。應用場景:比如我有一個列表,它有一堆query篩選項,這時候你就能deep watch它,只有任何一個篩序項改變的時候,就自動請求新的數據。或者你可以deep watch一個 form 表單,當任何一個字段內容發生變化的時候,你就幫它做自動保存等等。

Attrs 和 Listeners

這兩個屬性是 vue 2.4 版本之后提供的,它簡直是二次封裝組件或者說寫高階組件的神器。在我們平時寫業務的時候免不了需要對一些第三方組件進行二次封裝。比如我們需要基于el-select分裝一個帶有業務特性的組件,根據輸入的 name 搜索用戶,并將一些業務邏輯分裝在其中。但el-select這個第三方組件支持幾十個配置參數,我們當然可以適當的挑選幾個參數通過 props 來傳遞,但萬一哪天別人用你的業務組件的時候覺得你的參數少了,那你只能改你封裝的組件了,亦或是哪天第三方組件加入了新參數,你該怎么辦?

其實我們的這個組件只是基于el-select做了一些業務的封裝,比如添加了默認的placeholder,封裝了遠程 ajax 搜索請求等等,總的來說它就是一個中間人組件,只負責傳遞數據而已。

這時候我們就可以使用v-bind="$attrs":傳遞所有屬性、v-on="$listeners"傳遞所有方法。如下圖所示:

image

這樣,我們沒有在$props中聲明的方法和屬性,會通過$attrs$listeners直接傳遞下去。這兩個屬性在我們平時分裝第三方組件的時候非常有用!

.sync

這個也是 vue 2.3 之后新加的一個語法糖。這也是平時在分裝組件的時候很好用的一個語法糖,它的實現機制和v-model是一樣的。

image

當你有需要在子組件修改父組件值的時候這個方法很好用。
線上例子

Computed 的 get 和 set

computed 大家肯定都用過,它除了可以緩存計算屬性外,它在處理傳入數據和目標數據格式不一致的時候也是很有用的。set、get 文檔

上面說的可能還是是有點抽象,舉一個簡單的的例子:我們有一個 form 表單,from 里面有一個記錄創建時間的字段create_at。我們知道前端的時間戳都是 13 位的,但很多后端默認時間戳是 10 位的,這就很蛋疼了。前端和后端的時間戳位數不一致。最常見的做法如下:

image

上面的代碼主要做的是:在拿到數據的時候將后端 10 位時間戳轉化為 13 位時間戳,之后再向服務端發送數據的時候再轉化回 10 位時間戳傳給后端。目前這種做法當然是可行的,但之后可能不僅只有創建接口,還有更新接口的時候,你還需要在update的接口里在做一遍同樣數據轉化的操作么?而且這只是一個最簡單的例子,真實的 form 表單會復雜的多,需要處理的數據也更為的多。這時候代碼就會變得很難維護。

這時候就可以使用 computed 的 set 和 get 方法了。

image

通過上面的代碼可以看到,我們把需要做前后端兼容的數據,放在了 computed 中,從 getDatasubmit中隔離了數據處理的部分。

當然上面說的方案還不是最好的方案,你其實應該利用之前所說的v-bind="$attrs"v-on="$listeners"對時間選擇器組件進行二次封裝。例如這樣<date-time v-model="postForm.create_at" /> 外部無需做任何數據處理,直接傳入一個 10 位的時間戳,內部進行轉化。當日期發生變化的時候,自動通過emit觸發input使v-model發生變化,把所有臟活累活都放在組件內部完成,保持外部業務代碼的相對干凈。具體 v-model 語法糖原理可以見官方 文檔

set 和 get 處理可以做上面說的進行一些數據處理之外,你也可以把它當做一個 watch的升級版。它可以監聽數據的變化,當發生變化時,做一些額外的操作。最經典的用法就是v-model上綁定一個 vuex 值的時候,input 發生變化時,通過 commit更新存在 vuex 里面的值。

image

具體的解釋你也可以見官方 文檔

Object.freeze

這算是一個性能優化的小技巧吧。在我們遇到一些 big data的業務場景,它就很有用了。尤其是做管理后臺的時候,經常會有一些超大數據量的 table,或者一個含有 n 多數據的圖表,這種數據量很大的東西使用起來最明顯的感受就是卡。但其實很多時候其實這些數據其實并不需要響應式變化,這時候你就可以使用 Object.freeze 方法了,它可以凍結一個對象(注意它不并是 vue 特有的 api)。

當你把一個普通的 JavaScript 對象傳給 Vue 實例的 data 選項,Vue 將遍歷此對象所有的屬性,并使用 Object.defineProperty 把這些屬性全部轉為 getter/setter,它們讓 Vue 能進行追蹤依賴,在屬性被訪問和修改時通知變化。
使用了 Object.freeze 之后,不僅可以減少 observer 的開銷,還能減少不少內存開銷。相關 issue

使用方式:this.item = Object.freeze(Object.assign({}, this.item))

這里我提供了一個在線測速 demo,點我

通過測速可以發現正常情況下1000 x 10 rerender 都穩定在 1000ms-2000ms 之間,而開啟了Object.freeze的情況下,rerender 都穩住在 100ms-200ms 之間。有接近 10 倍的差距。所以能確定不需要變化檢測的情況下,big data 還是要優化一下的。

Functional

函數式組件 這個是文檔里就寫的內容,但在其實很少人會刻意的去使用。因為你不用它,代碼也不會有任何問題,用了到可能會出現 bug。

我們先看一個例子:點我測試性能 肉眼可見的性能差距。當然很多人會覺得我的項目中也沒有這種變化量級,但我覺得這是一個程序員的自我修養問題吧。,比如能用v-show的地方就不要用v-if,善用keep-alivev-onceObject.freeze()處理 vue big data 問題等。雖然都是一些小細節,但對性能和體驗都是有不少的提升的。更多的性能優化技巧請查看該文章 vue-9-perf-secrets

減少全局操作

這其實并不只是針對 vue 項目的一個建議,我們平時寫代碼的時候一定要盡量避免一些全局的操作。如果必須要用到的時候,一定要自己檢查,會不會產生一些全局的污染或者副作用。

舉幾個簡單例子:

  1. 我們現在雖然用 vue 寫代碼了,核心思想轉變為用數據驅動 view,不用像jQuery時代那樣,頻繁的操作 DOM 節點。但還是免不了有些場景還是要操作 DOM 的。我們在組件內選擇節點的時候一定要切記避免使用 document.querySelector()等一系列的全局選擇器。你應該使用this.$el或者this.refs.xxx.$el的方式來選擇 DOM。這樣就能將你的操作局限在當前的組件內,能避免很多問題。

  2. 我們經常會不可避免的需要注冊一些全局性的事件,比如監聽頁面窗口的變化window.addEventListener('resize', this.__resizeHandler),但再聲明了之后一定要在 beforeDestroy或者destroyed生命周期注銷它。window.removeEventListener('resize', this.__resizeHandler)避免造成不必要的消耗。

  3. 避免過多的全局狀態,不是所有的狀態都需要存在 vuex 中的,應該根據業務進行合理的進行取舍。如果不可避免有很多的值需要存在 vuex 中,建議使用動態注冊的方式。相關文檔。只是部分業務需要的狀態處理,建議使用 Event Bus或者使用 簡單的 store 模式

  4. css 也應該盡量避免寫太多的全局性的樣式。除了一些全局公用的樣式外,所以針對業務的或者組件的樣式都應該使用命名空間的方式或者直接使用 vue-loader 提供的 scoped寫法,避免一些全局沖突。文檔

Sass 和 Js 之間變量共享

這個需求可能有些人沒有遇到過,舉個實際例子來說明一下。

image

如上面要實現一個動態的換膚,就需要將用戶選擇的 theme 主題色傳遞給 css。但同時初始化的時候 css 又需要將一個默認主題色傳遞給 js。所以下面我們就分兩塊來講解。

  • js 將變量傳遞給 sass
    這部分是相對簡單就可以實現的,實現方案也很多。最簡單的方法就是通過 在模板里面寫 style 標簽來實現,就是俗話所說的內聯標簽。

    <div :style="{'background-color':color}" ></div>
    

    或者使用 css var(),在線 demo,還有用 less 的話modifyVars,等等方案都能實現 js 與 css 的變量傳遞。

  • sass 將變量給 js

還是那前面那個換膚來舉例子,我們頁面初始化的時候,總需要一個默認主題色吧,假設我們在 var.scss中聲明了一個 theme:blue,我們在 js 中該怎么獲取這個變量呢?我們可以通過 css-modules :export來實現。更具體的解釋-How to Share Variables Between Javascript and Sass

// var.scss
$theme: blue;

:export {
  theme: $theme;
}
// test.js
import variables from '@/styles/var.scss'
console.log(variables.theme) // blue

當 js 和 css 共享一個變量的時候這個方案還是很實用的。vue-element-admin 中的側邊欄的寬度,顏色等等變量都是通過這種方案來實現共享的。

其它換膚方案可以參考 聊一聊前端換膚

自動注冊全局組件

我的業務場景大部分是中后臺,雖然封裝和使用了很多第三方組件,但還是免不了需要自己封裝和使用很多業務組件。但每次用的時候還需要手動引入,真的是有些麻煩的。

image

我們其實可以基于 webpack 的require.context來實現自動加載組件并注冊的全局的功能。相關原理在之前的文章中已經闡述過了。具體代碼如下

image

我們可以創建一個GlobalComponents文件夾,將你想要注冊到全局的組件都放在這個文件夾里,在index.js里面放上如上代碼。之后只要在入口文件main.js中引入即可。

//main.js
import './components/Table/index' // 自動注冊全局業務組件

這樣我們可以在模板中直接使用這些全局組建了。不需要再繁瑣的手動引入了。

<template>
  <div>
    <user-select/>
    <status-button/>
  </div>
</template>

當然你也不要為了省事,啥組件都往全局注冊,這樣會讓你初始化頁面的時候你的初始init bundle很大。你應該就注冊那些你經常使用且體積不大的組件。那些體積大的組件,如編輯器或者圖表組件還是按需加載比較合理。而且你最好聲明這些全局組件的時候有一個統一的命名規范比如:globel-user-select這樣的,指定一個團隊規范,不然人家看到你這個全局組件會一臉懵逼,這個組件是哪來的。

Lint

這又是一個老生常談的問題了
vue 的一些最佳實踐什么的話,這里不討論了,我覺得看官方的 風格指南 差不多就夠了。比如避免避免 v-if 和 v-for 用在一起元素特性的順序這些等等規則,幾十條規則,說真的寫了這么久 vue,我也只能記住一些常規的。什么屬性的順序啊,不太可能記住的。這種東西還是交給程序來自動優化才是更合理的選擇。強烈推薦配置編輯器自動化處理。具體配置見 文檔。同時建議結合 Git Hooks 配合在每次提交代碼時對代碼進行 lint 校驗,確保所有提交到遠程倉庫的代碼都符合團隊的規范。它主要使用到的工具是huskylint-staged,詳細文檔見 Git Hooks

Hook

這個是一個文檔里沒有寫的 api,但我覺得是一個很有用的 api。比如我們平時使用一些第三方組件,或者注冊一些全局事件的時候,都需要在mounted中聲明,在destroyed中銷毀。但由于這個是寫在兩個生命周期內的,很容易忘記,而且大部分在創建階段聲明的內容都會有副作用,如果你在組件摧毀階段忘記移除的話,會造成內存的泄漏,而且都不太容易發現。如下代碼:

image

react 在新版本中也加入了useEffect,將以前的多個 life-cycles 合并、重組,使邏輯更加清晰,這里就不展開了。那 vue 是不是也可以這樣做?我去了看了一下官方的 vue-hooks源碼 發現了一個新的 api:$on('hook:xxx')。有了它,我們就能將之前的代碼用更簡單和清楚地方式實現了。

image

和 react 的useEffect有異曲同工之妙。

而且我們有了這個 api 之后,能干的事情還不止這個。有時候我們會用一些第三方組件,比如我們有一個編輯器組件(加載比較慢,會有白屏),所以我們在它渲染完成之前需要給它一個占位符,但可能這個組件并沒有暴露給我們這個接口,當然我們需要修改這個組件,在它創建的時候手動 emit 一個事件出去,然后在組件上監聽它,比如:

image

當然這也是可行的,但萬一還要監聽一個更新或者摧毀的生命周期呢?其實利用 hook可以很方便的實現這個效果。

image

當然在 vue 3.0 版本中可能會有新的寫法,就不如下面的討論: Dynamic Lifecycle Injection。有興趣的可以自行去研究,這里就不展開了。當 3.0 正式發布之后再來討論吧。

RoadMap

最后來說一下,之后需要做的事情吧:

  • 更好的多級頁面緩存:目前頁面的緩存基于keep-alive,但當三級路由嵌套的情況下,支持的并不好。之后探索一個更好的解決方案。
  • 單元測試:當項目大了之后,沒有單元測試維護起來還是有些吃力的。
    之后會慢慢補上unit-test 的測試用例。 酌情加上一些e2e-test的例子。
  • 去國際化:其實大部分人是不需要國際化的,默認情況下移除國際化。單獨開一個國際化分支(v4.1 已完成)。
  • 適配 webpack5:webpack5 還是解決了不少之前的痛點的,正式版發布之后會進行升級。
  • vue 3.0: 等官方發布之后會基于新版本進行重構(這個或許還有很久)
  • 適配 element-ui 3.0 之前官方發了 3.0 的打算(我也不知道會不會跳票)

總結

開源不易,且行且珍惜吧。

系列文章:

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,034評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,337評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,883評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,114評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,625評論 1 332
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,555評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,737評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,973評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,343評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,699評論 2 370