vue 項目代碼拆分的方案
由于之前的數(shù)據(jù)庫防火墻產(chǎn)品與數(shù)據(jù)庫審計產(chǎn)品使用的是同一套代碼,隨著兩個產(chǎn)品功能的差異越來越大,代碼的冗余度和偶合度越來越高,為了便于后期維護(hù)以及添加新功能,所以基于原來的項目代碼,進(jìn)行了代碼結(jié)構(gòu)拆分。
注意:本次拆分只拆分了可以拆分的部分,有的模塊例如:規(guī)則、關(guān)于我們,是沒有進(jìn)行拆分的,一是有的模塊很簡單,沒必要拆分;二是有的模塊原先寫得代碼偶合太嚴(yán)重,無法拆分,如果要拆分,需要花費大量精力去梳理代碼,同時還要后端配合拆分。
目的將此次代碼拆分方案記錄下來,便于后來的開發(fā)人員快速熟悉項目結(jié)構(gòu)。
拆分前流程設(shè)計項目拆分前,區(qū)分?jǐn)?shù)審和防火墻功能的流程如上圖所示。
訪問系統(tǒng)時,先加載入口文件 main.js,然后加載登錄頁 login.vue,加載登錄頁的同時獲取產(chǎn)品模式并保存到 session.storage.platformType 中,接著用戶登錄系統(tǒng)進(jìn)入具體頁面,該頁面同時包含了數(shù)審和防火墻的功能,根據(jù) session.storage.platformType 保存的值來判斷,具體顯示哪個功能。
目錄結(jié)構(gòu)設(shè)計項目拆分前的目錄結(jié)構(gòu)如上圖所示。
該目錄結(jié)構(gòu)是初始化一個 Vue 項目時的基本目錄,根據(jù)目錄結(jié)構(gòu),基本上看不出該項目包含了兩個不同的產(chǎn)品,也不知道不同產(chǎn)品模式下會加載哪一部分文件,結(jié)構(gòu)不清晰。
存在的問題通過分析,可以發(fā)現(xiàn)當(dāng)前的系統(tǒng)流程和目錄結(jié)構(gòu)是存在很多問題的,大概總結(jié)下:
加載登錄頁的時候才獲取產(chǎn)品模式,如果登錄頁加載完成,而產(chǎn)品模式還未獲取或者獲取不到,那么登錄頁顯示的產(chǎn)品信息有可能是錯誤的; 每次進(jìn)入一個具體頁面,如果同時包含了數(shù)審和防火墻的功能,都要重新判斷一次,當(dāng)前的功能是數(shù)審的還是防火墻的; 目錄結(jié)構(gòu)不清晰,不清楚哪些模塊是公共模塊,哪些是數(shù)審獨有的模塊,哪些是防火墻獨有的模塊; 可維護(hù)性和可擴(kuò)展性差。數(shù)審的代碼和防火墻的代碼混在一個文件內(nèi),改代碼的時候需要重頭看一遍才知道哪塊代碼屬于數(shù)審,哪塊代碼屬于防火墻。如果想要添加一個功能,還得繼續(xù)加邏輯判斷,代碼越來越臃腫; 業(yè)務(wù)邏輯混亂,與后端通信使用了同一個接口。 拆分后流程設(shè)計項目拆分后,區(qū)分?jǐn)?shù)審和防火墻功能的流程如上圖所示。
訪問系統(tǒng)時,先加載入口文件 main.js,該文件中寫了路由攔截相關(guān)的邏輯,在路由攔截時,如果沒有產(chǎn)品模式,則要先獲取產(chǎn)品模式,否則會被攔截,進(jìn)不去系統(tǒng)。獲取產(chǎn)品模式后,根據(jù)當(dāng)前產(chǎn)品模式,會注冊對應(yīng)的登錄頁、路由配置、接口請求等。當(dāng)注冊完畢后,每次訪問具體的頁面,都應(yīng)該是獨立的模塊了。
目錄結(jié)構(gòu)設(shè)計項目拆分后的目錄結(jié)構(gòu)如上兩個圖所示。
該目錄結(jié)構(gòu)經(jīng)過拆分,已經(jīng)可以清晰地看到不同產(chǎn)品之間分離出來的文件了,從入口文件開始,經(jīng)過路由攔截后,會加載指定的登錄頁,然后把對應(yīng)產(chǎn)品需要的文件合并到公共文件中。比如:http 請求、路由配置等。最終結(jié)果,程序只會把需要的文件加載進(jìn)去。
解決的問題經(jīng)過重新設(shè)計,解決了當(dāng)前項目存在的一些問題:
在加載登錄頁之前,通過路由攔截,必須先獲取產(chǎn)品模式,才能進(jìn)入系統(tǒng),登錄頁是在獲取到產(chǎn)品模式之后才加載的,不會出現(xiàn)產(chǎn)品信息顯示錯誤的問題; 只有在第一次進(jìn)入系統(tǒng)或刷新頁面的時候,才會重新獲取產(chǎn)品模式,合并產(chǎn)品模式對應(yīng)的文件,合并的文件是拆分后的文件,不需要在文件內(nèi)再次判斷該有數(shù)審的功能還是防火墻的功能。 目錄結(jié)構(gòu)清晰,防火墻相關(guān)的功能模塊文件都放在 views-fw 文件夾內(nèi)。 提高了項目的可維護(hù)性和可擴(kuò)展性,降低了代碼的偶合度。數(shù)審的代碼和防火墻的代碼基本已經(jīng)拆分開,如果想要添加一個防火墻的功能,只需要在防火墻相關(guān)的文件夾內(nèi)新增對應(yīng)功能模塊的文件即可。 業(yè)務(wù)邏輯清晰,與后端通信使用的是不同的接口,公共模塊使用的接口按原來的不變,數(shù)審獨有的接口在 url 前面增加了 audit 前綴,防火墻獨有的接口在 url 前面增加了 firewall 前綴。 關(guān)鍵代碼/** * @Name: main.js * @Author: cqfeng * @Description: 項目入口 js 文件 * @MainFunction: 引入和注冊一些全局資源 **///...省略的代碼...// 路由攔截,使用全局導(dǎo)航守衛(wèi)beforeEachrouter.beforeEach(async (to, from, next) => { // 如果沒有產(chǎn)品模式,先獲取產(chǎn)品模式 if (!store.state.productMode.productMode) { await store.dispatch(’productMode/SET_PRODUCT_MODE’); }//...省略的代碼...
/** * @Name: product-mode.js * @Author: cqfeng * @Description: 產(chǎn)品模式相關(guān)邏輯處理文件 * @MainFunction: 保存當(dāng)前產(chǎn)品模式,根據(jù)不同產(chǎn)品模式配置 產(chǎn)品登錄頁、http 請求 等資源 **/import Vue from ’vue’;import portService from ’@/assets/js/service/http/http’; // axios請求import router from ’@/router/index’; // 默認(rèn)路由配置,動態(tài)路由配置import httpAAS from ’@/assets/js/service/http/http-aas’; // 數(shù)審獨有的 http 請求import httpFW from ’@/assets/js/service/http/http-fw’; // 防火墻獨有的 http 請求import globalConstant from ’@/assets/js/const/global-constant’; // 項目全局常量export default { namespaced: true, state: { productMode: ’’, // 產(chǎn)品模式,進(jìn)入系統(tǒng)或刷新頁面時獲取 }, mutations: { // 修改產(chǎn)品模式 changeProductMode: function (state, value) { state.productMode = value; }, }, actions: { async SET_PRODUCT_MODE({ commit, state }) { let res = await portService.getProductMode(); if (res.data.code === 0) { commit(’changeProductMode’, res.data.data.productMode); } // 如果是數(shù)審產(chǎn)品 if (state.productMode === globalConstant.COMMON.AAS) { // 設(shè)置產(chǎn)品登錄頁 router.addRoutes([ { path: ’/login’, name: ’login’, component: resolve => { require([’@/views/login.vue’], resolve); }, } ]); // 合并 http 請求,掛載到 Vue 原型上 Vue.prototype.portService = Object.assign(portService, httpAAS); } // 如果是防火墻產(chǎn)品 else if (state.productMode === globalConstant.COMMON.DBSG) { // 設(shè)置產(chǎn)品登錄頁 router.addRoutes([ { path: ’/login’, name: ’login’, component: resolve => { require([’@/views/views-fw/login.vue’], resolve); }, } ]); // 合并 http 請求,掛載到 Vue 原型上 Vue.prototype.portService = Object.assign(portService, httpFW); } } }};總結(jié)
經(jīng)過拆分,數(shù)審和防火墻的代碼目錄已經(jīng)算是基本分開了,這個過程花費的力氣也很大,也引發(fā)了我的一些思考,一套代碼多個項目的這種方案是否算好的方案,還有沒有其他更好的方案。如果項目一開始,就按照一套代碼多個項目的設(shè)計來開發(fā),會不會后期的維護(hù)成本會低一些?這些問題我也沒有答案,希望后來者能夠繼承歷史經(jīng)驗,更好地開發(fā)出優(yōu)秀的項目。
其他實現(xiàn)方式起初設(shè)計拆分方案的時候,有兩種方案,一種是通過獲取產(chǎn)品模式動態(tài)改變當(dāng)前產(chǎn)品功能,一種是在打包時通過打包參數(shù)打包指定產(chǎn)品包。最終的方案是選擇第一種。但是,在這個過程中也參考了一些網(wǎng)上的實現(xiàn)方案,這里列出來方便以后需要用到進(jìn)行參考。
//www.jb51.net/article/188869.htm
//www.jb51.net/article/207835.htm
以上就是vue 項目代碼拆分的方案的詳細(xì)內(nèi)容,更多關(guān)于vue 項目代碼拆分的資料請關(guān)注好吧啦網(wǎng)其它相關(guān)文章!
相關(guān)文章:
