iT邦幫忙

第 11 屆 iThome 鐵人賽

DAY 4
0
Software Development

用設計模式與Typescript,在React異世界築起堅固保壘!系列 第 4

[Day4] 結婚後一起住會比較省錢 ─ Mono-Repo

嗨 大家好 我是一路爬坡的阿肥

老家有台用了十年的筆電
在前陣子進行大清理後,意外發現卡頓的次數少很多
像現在這樣邊寫文章邊開 Chrome 放音樂還是很順 ?
果然東西跟人一樣,時間久了就要清掉有的沒的
才能繼續往前


開始之前先聽首歌吧!

一起去跑步 也許有岔路
也許被斑馬擋住
至少我們 沒有甚麼 到不了的路
─《一起去跑步》

一起去跑步

兩種管理程式碼的方式

在 Git、npm 等成為開發流程的主流後,為了能獨立各自的開發環境,我們會為每個專案建立一個 repository 進行版控和套件管理,這種方式就稱為 Multi-Repo

不過產品線的範圍變大時,專案 B、C 都是基於專案 A 的底層程式去做新服務的開發,或甚至專案之間都有一些相依的程式碼時,除非能將這些共用的程式另外做成套件,並且保證每次的更動在多個專案下都能運作,不然通常會很難維護在同一支產品線下的各個專案。

Mono-Repo

跟 Multi-Repo 相反,Mono-Repo是將相關的產品專案都放在同一個 repository。

Mono-Repo 的好處主要有:

  • Better developer testing - 可以立即知道修改程式碼後,所有相關的專案是否還能正常運作
  • Sharing of common components - 只要開發一次元件,就能給所有專案使用
  • Effective code reviews - 要在專案之間檢視程式碼時,可以省下切換的時間

不過有幾個問題是:

  • 程式碼日益龐大,目錄結構就會愈複雜。因此在建立初期,最後可以做好規劃,並保有彈性
  • 建置測試的時間可能會愈花愈長。所以在開發工具與環境設定時,盡量能區分專案各自的範圍,只針對影響的範圍進行測試

Lerna ft. Yarn Workspaces

簡單來說:

Lerna是在 Javascript 專案中,實現 Mono-Repo 的管理工具,透過設定與指令,協助開發者進行套件與各個子專案的管理。

Yarn Workspaces是套件管理工具Yarn發展出來的開發環境設定,可以讓多個子專案聚集為一個工作區(Workspace),並且在專案的 root 就為工作區進行套件的管理與更新。

所以搭配 Lerna 的基本設定跟指令大致上會長像這樣:

// package.json
"workspaces": [
    "packages/*"
],

//lerna.json
{
  "packages": ["packages/*"],
  "version": "independent",
  "useWorkspaces": true,
  "npmClient": "yarn"
}

// 在 root 安裝外部套件
`yarn add -DW <npm pkg1> <npm pkg2> ...`

// 在 package 加入外部套件作為 peerDependencies
`yarn workspace @project-name/pkg-name add -P <npm pkg1> <npm pkg2> ...`

// 在 package 加入內部套件作為 dependencies
`yarn lerna add @project-name/pkg-name1  --scope=@project-name/pkg-name2`

跟設計模式有什麼關係?

沒有關係!(被揍)
不過因為這系列的文章和範例程式檔,會以 Monorepo 的方式管理,加上在某些性質的產品或專案上,用 Monorepo 管理的確是有它的好處在,所以藉由這個機會跟大家介紹,也順手練習一下 Monorepo 的起手式。

另外有興趣的話可以下載或 fork 我的Github 專案玩玩看。

小結

不知道看完內文後,對於阿肥我下的標題是不是覺得很貼切(自以為)
明天開始就正式進入本系列的重點囉!


參考資料


上一篇
[Day3] 虛實之間 就用 React 築起所見即所得的世界吧!
下一篇
[Day5] 老闆:來一碗大腸麵線 ─ 工廠方法(Factory Method) <模式篇>
系列文
用設計模式與Typescript,在React異世界築起堅固保壘!30

尚未有邦友留言

立即登入留言