多個前端項目中公共組件使用方案(npm包方式)

1、背景

公司有多個前端項目,每個項目獨立部署,各個項目里可能會使用相同的組件或者頁面。對于這樣的組件或者頁面如何管理呢?我們可以把公共的組件或者頁面抽離,單獨存放在一個項目里,然后在其他項目里引入這個公共的項目

2、方案

2.1 創建一個公共組件項目commonpack(名字自己定義),如下圖


image.png

outPages目錄里是公共組件pageA和pageB,然后在根目錄下創建index.js,向外暴露組件pageA和pageB。index.js文件里面代碼如下

import pageA from './outPages/pageA'
import pageB from './outPages/pageB'
export {
  pageA,
  pageB
}

2.2 創建一個標準的前端項目packageone,packagetwo,那么packageone,packagetwo如何來引入公共組件項目commonpack里的組件pageA和pageB呢?有3個方案。

方案一:npm發布引用

公共組件項目commonpack的組件編寫完成后,將其發布到npm。開發packageone,packagetwo的人員通過npm install命令將commonpack以node_module的方式引入
npm install commonpack --save
另外,每次改動代碼再次發布時,需要修改package.json文件中的版本號,不然發布不成功。
這種方法在開發階段不便捷,改個公共組件,改完還得發包,發完后其他項目使用還得從新安裝。

方案二:npm link

首先進入commonpack包,在控制臺輸入

npm link

這會創建一個軟連接,并保存到目錄C:\Users\Administrator\AppData\Roaming\npm\node_modules下面。
然后進入packageone和packagetwo,在控制臺輸入

npm link commonpack

這就將這個公共的項目通過軟連接的方式引入到項目里面來了。下圖可以看到在node_modules中common包和其他的包文件夾樣式是不一樣的,common文件夾只是一個軟鏈接。

image.png

這時修改commonpack項目下面的任意代碼都會實時生效,不用打包,不用更新引入包,也不用重啟。
需要注意的是,當項目包依賴更新后,也就是執行了 npm install xxx 之后,需要重新link common項目。而且使用npm link后本地package.json里沒有記錄,無法直觀的查看本地包的引用。

方案三:npm本地file引用(推薦)

分別進入packageone和packagetwo,在控制臺輸入命令:

npm install ../commonpack/

其中/commonpack/是commonpack的相對路徑,這里也可以輸入絕對路徑。
這樣就將commonpack這個工程以node_module的方式引入到packageone和packagetwo項目中了。可以正常使用commonpack在index.js中導出的組件了。
命令執行完后,package.json里會多一條記錄


image.png

同樣這時修改common項目下面的任意代碼都會實時生效,不用打包,不用更新引入包,也不用重啟。而且在package.json中有引入記錄。

3、舉例

我們在packageone項目里引入公共組件pageA和pageB


image.png

效果如下


image.png

github項目地址:https://github.com/Amosyue/npmPackages

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

推薦閱讀更多精彩內容