前言
做這個 vueAdmin-template 的主要原因是: vue-element-admin 這個項目的初衷是一個vue的管理后台集成方案,把平時用到的一些組件或者經驗分享給大家,同時它也在不斷的維護和拓展中,比如最近重構了dashboard,加入了全屏功能,新增了tabs-view等等。所以項目會越來越復雜,不太適合很多初用vue的同學來構建后台。所以就寫了這個基礎模板,它沒有復雜的功能,只包含了一個后台需要最基礎的東西。
vueAdmin-template 主要是基於vue-cli webpack模板為基礎開發的,引入了如下dependencies:
- element-ui 餓了么出品的vue2.0 pc UI框架
- axios 一個現在主流並且很好用的請求庫 支持Promise
- js-cookie 一個輕量的JavaScript庫來處理cookie
- normalize.css 格式化css
- nprogress 輕量的全局進度條控制
- vuex 官方狀態管理
- vue-router 官方路由
該項目只做了一個管理后台需要極簡的功能,封裝了axios請求,支持無限層級路由,動態權限和動態側邊欄。
如果需要更多復雜的功能可以參考 vue-element-admin,若還有不足,歡迎提issue或者pr。下文會簡單說一下用該模板需要注意的地方。
路由懶加載
路由懶加載應該是寫大一點的項目都會用的一個功能,只有在使用這個component的時候才會加載這個相應的組件,這樣寫大大減少了初始頁面 js 的大小並且能更好的利用游覽器的緩存。
const Foo = resolve => require(['./Foo.vue'], resolve) //或者 const Foo = () => import('./Foo');
在懶加載頁面不多的情況下一切是那么的美好,但我司后台業務在不斷地迭代,現在項目近百個路由,這時候使用路由懶加載在開發模式下就是一件痛苦的事情了,隨手改一行代碼熱更新都是要6000ms+的,這怎么能忍。樓主整整花了一天多的時間找原因,能webpack優化的方法都用了,什么 dll
, HappyPack
等方法都是過了,但提升的效果都不是很明顯,正好那段時間出了 webpack3
樓主也升級了,編譯速度也得到了很大幅度的提升,不過也要2000ms+。經過不斷查找發現原來是路由懶加載搞得鬼,樓主猜測可能是異步加載導致 webpack 每次的 cache 失效了,所以每次的rebuild 才會這么的慢。找到了原因我們就可以對症下葯了,我們就自己封裝了一個_import()
的方法,只有在正式環境下才使用懶加載。這樣解決了困擾多事的rebuild慢問題。代碼
const _import = require('./_import_' + process.env.NODE_ENV); const Foo = _import('Foo');

整整比原來6000ms快了十多倍,我終於又能愉快的開發了。
權限 控制
在手摸手,帶你用vue擼后台 系列二(登錄權限篇)這章中其實已經詳細介紹過了。該項目中權限的實現方式是:通過獲取當前用戶的權限去比對路由表,生成當前用戶具的權限可訪問的路由表,通過router.addRoutes
動態掛載到router上。
但其實很多公司的業務邏輯可能不是這樣的,舉一個例子來說,很多公司的需求是每個頁面的權限是動態配置的,不像本項目中是寫死預設的。但其實原理是相同的。如這個例子,你可以在后台通過一個tree控件或者其它展現形式給每一個頁面動態配置權限,之后將這份路由表存儲到后端。當用戶登錄后根據role,后端返回一個相應的路由表或者前端去請求之前存儲的路由表動態生成可訪問頁面,之后就是router.addRoutes
動態掛載到router上,你會發現原來是相同的,萬變不離其宗。
導航
側邊欄:本項目里的側邊欄是根據 router.js 配置的路由並且根據權限動態生成的,這樣就省去了寫一遍路由還要再手動寫側邊欄這種麻煩事,同是使用了遞歸組件,這樣不管你路由多少級嵌套,都能愉快的顯示了。權限驗證那里也做了遞歸的處理。

面包屑:本項目中也封裝了一個面包屑導航,它也是通過watch $route
動態生成的。代碼

由於側邊欄導航和面包屑亦或是權限,你會發現其實都是和router密切相關的,所以基於vue-router路由信息對象上做了一下小小的拓展,自定義了一些屬性
- icon : the icon show in the sidebar
- hidden : if
hidden:true
will not show in the sidebar- redirect : if
redirect:noredirect
will not redirct in the levelbar- noDropdown : if
noDropdown:true
will not has submenu in the sidebar- meta :
{ role: ['admin'] }
will control the page role
大家也可以結合自己的業務需求增改這些自定義屬性。
iconfont
element-ui自帶的圖標不是很豐富,但管理后台圖標的定制性又很強。這里只給大家推薦使用阿里的 iconfont ,簡單好用又方便管理。本項目中已經嵌入了一些 iconfont 作為例子,大家可以自行替換。
這里來簡單介紹一下 iconfont 的使用方式。首先注冊好 iconfont 賬號之后,可以在我的項目中管理自己的 iconfont 。我司所有的項目都是用這個管理的,真心推薦使用。

創建好圖標庫后如果有更新替換也很方便,這里我使用了 Symbol 的方式引入,這里還有unicode
,font-class
的引入方式,有興趣的可以自行研究。
之后我們點擊下載 Symbol,會發現有如下這些文件,我們只要關心iconfont.js
就可以了

我們將它替換項目中的 iconfont.js 就可以了。本項目中也封裝了一個svg component 方便大家使用。
<icon-svg icon-class="填入你需要的iconfont名字就能使用了"></icon-svg>
favicon
每個項目都需要有一個屬於自己的favicon。

其實實現起來非常的方便,我們主需要借助html-webpack-plugin
//webpack config function resolveApp(relativePath) { return path.resolve(relativePath); } new HtmlWebpackPlugin({ filename: config.build.index, template: 'index.html', inject: true, favicon: resolveApp('favicon.ico') }),
你只要將本項目跟目錄下的favicon.ico文件替換為你想要的圖標即可。
eslint
vue cli
默認提供了standard
和airbnb
兩種 lint 規范,說真的一個j檢查校驗的太松一個又太緊,而且每個團隊的 lint 規范又是不同的,所以樓主干脆在項目里把大部分常用的 lint 規范都列舉了出來並寫上了注釋方便大家修改代碼地址,大家也可以把自己的規范上傳到npm,像 vue 一樣 vue-eslint-config。配置 eslint 對多人協作的項目有很大的好處,同時配置好lint 在加 ide 的 lint 插件寫代碼簡直要起飛。相關配置可見第一篇教程。
postcss
相信大部分 vue 的項目都是基於 vue-cli 來開發的,不過畢竟每個人需求都是不太一樣的,需要自定義一些的東西。就比如拿 postcss 來說 vue-cli 有一個小坑,它默認 autoprefixer 只會對通過 vue-loader 引入的樣式有作用,換而言之也就是 .vue 文件里面的 css autoprefixer 才會效果。相關問題issues/544,issues/600。解決方案也很簡單粗暴
//app.vue <style lang="scss"> @import './styles/index.scss'; // 全局自定義的css樣式 </style>
你在 .vue 文件中引入你要的樣式就可以了,或者你可以改變 vue-cli的文件在 css-loader 前面在加一個 postcss-loader,在前面的issue地址中已經給出了解決方案。
這里再來說一下 postcss 的配置問題,新版的vue-cli webpack 模板 inti 之后跟目錄下默認有一個.postcssrc.js
。vue-loader 的 postcss 會默認讀取這個文件的里的配置項,所以在這里直接改配置文件就可以了。配置和postcss是一樣的。
//.postcssrc.js module.exports = { "plugins": { // to edit target browsers: use "browserlist" field in package.json "autoprefixer": {} } } //package.json "browserslist": [ "> 1%", "last 2 versions", "not ie <= 8" ]
如上代碼所述,autoprefixe r回去讀取 package.json 下 browserslist的配置文件
> 1%
兼容全球使用率大於1%的游覽器last 2 versions
兼容每個游覽器的最近兩個版本-
not ie <= 8
不兼容ie8及以下
具體可見 browserslist, postcss也還有很多很多其它的功能大家可以自行去把玩
babel-polyfill
本項目暫時沒有兼容性需求,如有兼容性需求可自行使用babel-polyfill。
在Node/Browserify/webpack中使用
npm install --save babel-polyfill //下載依賴
在入口文件中引入
import 'babel-polyfill'; // 或者 require('babel-polyfill');//es6
在webpack.config.js中加入babel-polyfill到你的入口數組:
module.exports = { entry:["babel-polyfill","./app/js"] }
具體可參考 link
或者更簡單暴力 polyfill.io 使用它給的一個 cdn 地址,引入這段js之后它會自動判斷游覽器,加載缺少的那部分 polyfill,但國內速度肯能不行,大家可以自己搭 cdn。
跨域問題
樓主 vue 群里的小伙伴們問的最多的問題還是關於跨域的,其實跨域問題真的不是一個很難解決的問題。這里我來簡單總結一下我推薦的幾種跨域解決方案。
- 我最推薦的也是我司常用的方式就是
cors
全稱為 Cross Origin Resource Sharing(跨域資源共享)。這玩意對應前端來說和平時發請求寫法上沒有任何區別,工作量基本都在后端這里。每一次請求瀏覽器必須先以 OPTIONS 請求方式發送一個預請求,從而獲知服務器端對跨源請求所支持 HTTP 方法。在確認服務器允許該跨源請求的情況下,以實際的 HTTP 請求方法發送那個真正的請求。推薦的原因是只要第一次配好了,之后不管有多少接口和項目復用就可以了,一勞永逸的解決了跨域問題,而且不管是開發環境還是測試環境都能方便的使用。 - 但總有后端覺得麻煩不想這么搞。那前端也是有解決方案的,在
dev 開發模式下可以下使用webpack 的 proxy
使用也是很方便的看一下文檔就會使用了,樓主一些個人項目使用的該方法。但這種方法在生成環境是不適用的。在生產環境中需要使 用Nginx反向代理 不管是 proxy 和 nginx 的原理都是一樣的通過搭建一個中轉服務器來轉發請求規避跨域的問題。
開發環境 | 生成環境 |
---|---|
cors | cors |
proxy | nginx |
這里我只推薦這兩種方式跨域,其它的跨域方式都很多,但真心主流的也就這兩種方式。
easy-mock
vue-element-admin 由於是一個純前端個人項目,所以所以的數據都是用mockjs生成的,它的原理是:攔截了所有的請求並代理到本地模擬數據,所以 network 中沒有任何的請求發出。不過這並不符合實際業務開發中的場景,所以這個項目中使用了前不久剛出的 easy-mock,支持跨域,mockjs 的語法,支持Swagger 這幾點還是挺不錯的。相關文章
baseurl
線上或者測試環境接口的 base_url 不一樣是很長見得需求,或者你在本地用了如 easy-mock 這種模擬數據到線上環境你想用自己公司生產環境的數據,這些需求都可以簡單的通過用 baseurl 來解決。首先我們在config/
下有dev.env.js
和prod.env.js
這兩個配置文件。用它來區分不同環境的配置參數。
//dev.env.js module.exports = { NODE_ENV: '"development"', BASE_API: '"https://easy-mock.com/mock/5950a2419adc231f356a6636/vue-admin"', } //prod.env.js module.exports = { NODE_ENV: '"production"', BASE_API: '"https://prod-xxx"', }
同時本項目封裝了axios攔截器,方便大家使用,大家也可根據自己的業務自行修改。
import axios from 'axios'; import { Message } from 'element-ui'; import store from '../store'; // 創建axios實例 const service = axios.create({ baseURL: process.env.BASE_API, // api的base_url 讀取config配置文件 timeout: 5000 // 請求超時時間 }); // request攔截器 service.interceptors.request.use(config => { if (store.getters.token) { config.headers['X-Token'] = store.getters.token; // 讓每個請求攜帶自定義token 請根據實際情況自行修改 } return config; }, error => { // Do something with request error console.log(error); // for debug Promise.reject(error); }) // respone攔截器 service.interceptors.response.use( response => { /** * code為非20000是拋錯 可結合自己業務進行修改 */ const res = response.data; if (res.code !== 20000) { Message({ message: res.data, type: 'error', duration: 5 * 1000 }); // 50008:非法的token; 50012:其他客戶端登錄了; 50014:Token 過期了; if (res.code === 50008 || res.code === 50012 || res.code === 50014) { MessageBox.confirm('你已被登出,可以取消繼續留在該頁面,或者重新登錄', '確定登出', { confirmButtonText: '重新登錄', cancelButtonText: '取消', type: 'warning' }).then(() => { store.dispatch('FedLogOut').then(() => { location.reload();// 為了重新實例化vue-router對象 避免bug }); }) } return Promise.reject(error); } else { return response.data; } }, error => { console.log('err' + error);// for debug Message({ message: error.message, type: 'error', duration: 5 * 1000 }); return Promise.reject(error); } ) export default service;
由於axios每一個都是一個實例,你的請求都是基於這個實例來的,所以所以配置的參數屬性都繼承了下來.
//api.xxx.js import fetch from '@/utils/fetch'; export function getInfo(token) { return fetch({ url: '/user/info', method: 'get', params: { token } }); } //你可以直接這樣使用,之前攔截器寫的東西都是生效的, //它自動會有一個你之前配置的baseURL, //但你說我這個請求baseURL和其它的不同, //這也是很方便的,你可以字請求內部修改, //它會自動覆蓋你在創建實例時候寫的參數如 export function getInfo(token) { return fetch({ baseURL: https://api2-xxxx.com url: '/user/info', method: 'get', params: { token } }); }
總結
這篇文章主要是介紹了 vueAdmin 做了哪些事情,希望大家如果有后台新項目要開發,建議基於 vueAdmin-template 來開發,而 vue-element-admin 更多的是用來當做一個集成方案,你要什么功能就去里面找拿來用,因為兩者的基礎架構是一樣的,所以復用成本也很低。
占坑
常規占坑,這里是手摸手,帶你用vue擼后台系類
項目地址:vueAdmin-template
相關項目地址:vue-element-admin
系類文章一:手摸手,帶你用vue擼后台 系列一(基礎篇)
系類文章二:手摸手,帶你用vue擼后台 系列二(登錄權限篇)
系類文章三:手摸手,帶你用vue擼后台 系列三(實戰篇)
下一篇文章真的真的會寫關於如何用 electron 包裝現有項目,快速實現一個跨平台的終端后台。
相應廣大需求 建了一個qq群 591724180 方便大家交流。
作者:花褲衩coder
鏈接:http://www.jianshu.com/p/506533c22f1c
來源:簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權,非商業轉載請注明出處。