眾所周知，雖然 Vue CLI 提供了腳手架的功能，但由于官方的腳手架過于簡單，生成好的專案在實際專案開發的時候，還需要做很多事情，而 vue-automation 就是來解決這一痛點，讓你的開發效率至少提升 50% 以上

這是什么

vue-automation 是一款開箱即用的 Vue 專案模版，它基于 Vue CLI 4

特點

默認集成 vue-router 、vuex 和 axios
全域 SCSS 資源自動引入
全域組件自動注冊
支持 SVG 圖示，CSS 精靈圖自動合成
支持 mock 資料，可擺脫后端束縛獨立開發
支持 GZip 和 CDN 優化專案體積/加載速度
結合 IDE 插件、ESlint 、stylelint 、Git 鉤子，輕松實作團隊代碼規范

功能介紹

配置

默認提供開發環境和生產環境兩套配置，分別在根目錄下 .env.development 和 .env.production 檔案里，可配置項有網站標題、介面請求地址和是否開啟CDN支持，

開發者可根據實際業務需求進行擴展，如果對這塊不熟悉，可閱讀 Vue CLI 環境變數和模式章節，

全域 SCSS 資源

全域 SCSS 資源并不是全域樣式，是變數、@mixin 、@function 這些東西

在 assets/styles/resources/ 目錄下存放全域的 SCSS 資源，也就是說在這個目錄里的檔案，無需在頁面上參考即可生效并使用，

專案中默認存放了 utils.scss 檔案，里面有幾個 @mixin 和 % ，你可以嘗試在頁面中使用它們看看效果，

同樣，精靈圖目錄下生成的 SCSS 資源也是全域可呼叫的，

精靈圖

又稱雪碧圖，原理是將多張小圖合并到一張大圖上，以便減少 HTTP 請求，提高網站訪問速度，

精靈圖原始圖片的存放位置位于 assets/sprites/ 目錄下，注意按檔案夾區分，

專案運行前會根據檔案夾生成對應的精靈圖檔案（精靈圖圖片和 .scss 檔案），多個檔案夾則會生成多個精靈圖檔案，需要注意的是，在專案運行時，修改檔案夾里的圖片，會重新生成相關精靈圖檔案，但如果新建檔案夾，則需要重新運行專案才會生成對應精靈圖檔案，

在 .vue 檔案中可通過 @include 直接使用精靈圖，無需手動引入 .scss 檔案：

// 方法 1
// @include [檔案夾名稱]-sprite([檔案名稱]);
.icon {
    @include example-sprite(address);
}

// 方法 2
// @include all-[檔案夾名稱]-sprites;
@include all-example-sprites;

最終輸出如下：

/* 方法 1 */
.icon {
    background-image: url(img/example.326b35aec20837b9c08563c654422fe6.326b35ae.png);
    background-position: 0px 0px;
    background-size: 210px 210px;
    width: 100px;
    height: 100px;
}

/* 方法 2 */
.example-address-sprites {
  background-image: url(img/example.326b35aec20837b9c08563c654422fe6.326b35ae.png);
  background-position: 0 0;
  background-size: 210px 210px;
  width: 100px;
  height: 100px;
}
.example-feedback-sprites {
  background-image: url(img/example.326b35aec20837b9c08563c654422fe6.326b35ae.png);
  background-position: -110px 0;
  background-size: 210px 210px;
  width: 100px;
  height: 100px;
}
.example-payment-sprites {
  background-image: url(img/example.326b35aec20837b9c08563c654422fe6.326b35ae.png);
  background-position: 0 -110px;
  background-size: 210px 210px;
  width: 100px;
  height: 100px;
}

如果是小型專案，靜態圖示不多，可全部放在一個檔案夾內；如果是中大型專案，檔案夾可按模塊來劃分，這樣不同的模塊最侄訓生成各自的精靈圖檔案，

SVG 圖示

現在越來越多專案開始使用 SVG 圖示做為精靈圖的替代品，本框架也提供了 SVG 圖示支持，方便使用，推薦去阿里巴巴矢量圖示庫下載高質量 SVG 圖示

首先將 svg 檔案放到 src/assets/icons/ 目錄下，然后在頁面中就可以使用了，name 就是 svg 檔案名

<svg-icon name="example" />

<svg-icon /> 組件為全域組件，所以無需注冊即可使用

全域組件

全域組件存放在 components/global/ 目錄下，需要注意各個組件按檔案夾區分，

每個組件的檔案夾內至少保留一個檔案名為 index 的組件入口，例如 index.vue ，

組件必須設定 name 并保證其唯一，自動注冊會將組件的 name 設為組件名，可參考 SvgIcon 組件寫法，

雖然檔案夾名稱和 name 無關聯，但建議與 name 保持一致，

如果組件是通過 js 進行呼叫，則確保組件入口檔案為 index.js，可參考 ExampleNotice 組件，

Vue-router

路由也實作了自動注冊，但因為有優先級的概念，先定義的會先匹配，所以同一模塊下的路由需要放在一個路由組態檔里，

開發者只需關心 router/modules/ 目錄下的檔案，一個模塊對應一個 .js 檔案，可參考 router/modules/example.js 檔案，

Vuex

Vuex 同樣實作了自動注冊，開發只需關注 store/modules/ 檔案夾里的檔案即可，同樣也按照模塊區分檔案，

新建模版：

// example.js
const state = {}
const getters = {}
const actions = {}
const mutations = {}
export default {
    namespaced: true,
    state,
    actions,
    getters,
    mutations
}

檔案默認開啟命名空間，檔案名會默認注冊為模塊名，

使用方法：

this.$store.state.example.xxx;
this.$store.getters['example/xxx'];
this.$store.dispatch('example/xxx');
this.$store.commit('example/xxx');

Axios 攔截器

攔截器的用處就是攔截每一次的請求和回應，然后做一些全域的處理，

例如介面回應報錯，可以在攔截器里用統一的報錯提示來展示，方便業務開發，

本框架提供了一份攔截器參考代碼 src/api/index.js ，因為每個公司提供的介面標準不同，所以該檔案需要開發者根據各自公司的介面去定制對應的攔截器，

代碼很簡單，首先初始化 axios 物件，然后 axios.interceptors.request.use() 和 axios.interceptors.response.use() 就分別是請求和回應的攔截代碼了，

參考代碼里只做了簡單的攔截處理，例如請求的時候會自動帶上 token ，回應的時候會根據錯誤資訊判斷是登錄失效還是介面報錯，

快速創建檔案

該功能基于 plop 實作，

開發程序中，避免不了手動去頻繁創建頁面、組件等檔案，并且還要在檔案里寫一些必要的代碼，是不是覺得很麻煩？現在你可以用更簡潔的方式來處理這一切，

模版默認提供了 page(頁面/布局) 、component(組件) 、store(全域狀態) 三個模版檔案，通過 yarn new 指令可以自行選擇，

在實際專案開發中，建議根據專案定制適合專案的模版檔案，可以大大提高開發效率，當多人協作開發時，也能統一部分標準，

模版目錄為 ./plop-templates/ ，如果是新建模版，記得在專案根目錄 plopfile.js 里參考一下，

代碼規范：IDE 編輯器

為保證代碼風格統一，統一使用 VS Code 做為開發 IDE ，并安裝以下擴展：

EditorConfig for VS Code
ESLint
Vetur
Prettier - Code formatter
stylelint

安裝完后在 settings.json 中增加如下配置：

"editor.codeActionsOnSave": {
	"source.fixAll.eslint": true,
	"source.fixAll.stylelint": true
}

最終效果為，在保存時，會自動對當前檔案進行代碼格式化操作，

代碼規范：Git 鉤子

上述操作僅對代碼的寫法規范進行格式化，例如縮進、空格、結尾的分號等，

而在提交代碼時， Git 的鉤子會檢查代碼中是否有錯誤，這些錯誤是 IDE 無法自動修復的，例如出現未使用過的變數，如果有錯誤，則會取消此次提交，直到開發者修復完所有錯誤后才允許提交成功，確保倉庫里的代碼絕對正確，

可通過修改 .eslintignore 和 .stylelintignore 忽略無需做代碼規范的檔案，例如在專案中參考了一些第三方的插件或組件，我們就可以將其忽略

如果 git init 倉庫初始化是在依賴包安裝之后執行的，則無法初始化 Git 鉤子，建議在 git init 之后再執行一遍 yarn 或者 npm i ，重新安裝一遍依賴包，

代碼規范：配置代碼規范

組態檔主要有 3 處，分別為 IDE 配置（.editorconfig）、ESLint 配置（.eslintrc.js 和 .eslintignore）、StyleLint 配置（.stylelintrc 和 .stylelintignore），

以代碼縮進舉例，本模版默認是以 4 空格進行縮進，如果要調整為 2 空格，則需要在 .editorconfig 里修改：

indent_size = 2

在 .eslintrc.js 里修改：

'indent': [2, 2, {
    'SwitchCase': 1
}],

...

'vue/html-indent': [2, 2],

...

'vue/script-indent': [2, 2, {
    'switchCase': 1
}]

在 .stylelintrc 里修改：

"indentation": 2

修改完畢后，再分別執行下面兩句命令：

yarn run lint
yarn run stylelint

該操作會將代碼進行一次格式校驗，如果規則支持自動修復，則會將不符合規則的代碼自動進行格式化，

以上面的例子，當縮進規則調整后，我們無需手動去每個檔案調整，通過命令可以自動應用新的縮進規則，

擴展功能

除了以上常用功能介紹外，vue-automation 還支持 mock 、CDN 、GZip 和移動端等相關配置，方便適應任何開發場景，真正做到了開箱即用，

生態

在我目前所在的公司里，vue-automation 已經穩定用于數十個真實專案上，覆寫企業官網、商城、數字大屏、微信公眾號等多個不同領域，

同時在其基礎上，擴展開發出了一套獨立的中后臺系統框架：Fantastic-admin ，在易用的基礎上保證了功能全面，超越市面上大部分同類框架，

新年展望

在 2021 年，vue-automation 將會全新升級，全面支持 Vue 3

最后祝大家新年快樂，讓我們一起對 2020 說再見吧！

轉載請註明出處，本文鏈接：https://www.uj5u.com/qiye/243194.html

標籤：JavaScript

上一篇：Webpack4.0各個擊破（7）plugin篇

下一篇：JS撰寫的科學計算器

收下這款 Vue 專案模版，它將讓你的開發效率在 2021 年提高 50%