目前前端項目大多基於Vue、React、Angular等框架來實現,這一類框架都有一個明顯的特點:基於模塊化以及組件化思維。所以,開發者在使用上述框架時,實際上是在寫一個一個的組件,並且組件與組件之間呈嵌套的形式。當一個項目中多次出現同一功能時,他們會選擇將其提取出來,並且放到components文件夾中,以達到復用的目的,但是這些復用都是基於同一項目的,所以,當寫另一個項目時,又要開始寫一些重複的代碼。

個推擁有多條業務線,在進行前端項目時總會遇到重複寫代碼的困境,所以,我們做了PCMS項目,主要為了解決跨項目之間的組件復用問題,其中的技術棧是基於Vue的,所以PCMS同時也是基於Vue項目實現的。

接下來我將基於自己在前端工作過程中的實踐,跟大家分享基於CMS的組件復用實踐。

想要實現跨項目之間的組件復用,需要解決以下問題,

1.組件與組件之間,組件與項目之間需要解耦

2.組件需要給出使用方法(文檔)

3.組件需要能夠獨立運行

4.組件需要有版本管理並且可以按需載入

5.需要一個工具把這些組件管理並且展示出來

普通項目/PCMS項目

區塊特徵

在上述五大問題中,首先要解決組件與組件以及項目之間的解耦問題,為此,我們需要將組件內部和其它組件以及項目耦合的部分剔除,然後通過props傳入,為了方便區分這些props與普通props,我們把他們放到了一個名為ds的對象中 。通常,這些耦合部分會是一些API或VUEX調用或者前端路由操作等。

同時, 為了方便這些組件的編寫和維護,我們給組件制定了更加嚴格的約束,同時將這些符合約束的復用組件稱為「區塊」,意思是可以獨立於項目的一個功能區域。

在解耦過程中,我們發現這些區塊的代碼可以有一些重複部分,比如ds的一些優化和mock的註冊等,所以我們開發了一個vue插件。在項目使用區塊時,為了完成按需載入時的引用方式以及生產環境下Mock數據的剔除,我們又開發了一個webpack插件。

在具體實踐過程中,為了實現組件的復用,需要按照固定的結構去寫組件,還需要在項目中修改main.js和webpack配置工作,所以,我們開發了CLI工具和GUI工具來生成項目和組件基本文件,同時管理和調試組件。

完成了CLI和GUI工具之後,具體的開發流程如下所示:

1. 使用CLI生成項目

2. 開發頁面

3. 從GUI工具查找合適的區塊,直接使用或者下載代碼微調

4. 頁面開發完成

5. 對於可復用的功能,使用CLI生成區塊基本文件,進行區塊開發

6. 開發完畢,項目上線發布區塊庫

7. 下一次開發項目時,可以直接使用該區塊或者下載代碼

使用了區塊的開發模式後,雖然開發流程與之前相比並沒有太大區別,但有效提升了開發的速度,同時還能將任務拆分得更細,對於團隊中的初學者來說,一個有使用文檔的業務組件更加容易被他們接受,對於業務的上手速度也更快。

本文根據個推高級前端開發工程師沈創在個推TechDay全國巡迴沙龍廣州站的演講內容進行整理,略有刪減。


推薦閱讀:
查看原文 >>
相关文章