如何在大型專案中使用Git子模組開發

Maxliu發表於2018-12-24
Git

寫在前面

公司需要開發一個內部系統，要求每個部門都要接入。老闆欽點，工期又壓得短，於是浩浩湯湯的上百人就調過來了。

再簡單的事情，只要人多起來就會變得複雜，開發的世界也是如此。

痛點

一個幾百人的大專案，使用Git協作的時候，想一想我們的痛點：

  1. 專案過大，每個人clone等待時間過長
  2. 一會沒有拉取程式碼就會發現有上百條更新待拉取
  3. 一人提交出錯，上百人待機（筆者真實體驗）
  4. 程式碼回溯困難，查詢具體的修改記錄無異於大海撈針

解決方案

這時候Git子模組就派上用場。

首先需要的當然是一個合理的架構，由於公司的保密原則這裡就不貼專案了，本文主要描述在協作中子模組的用法。

專案結構

專案主體結構大概是這樣的：

└── src
    ├── layout // 公共佈局目錄
    ├── public // 公共頁面目錄
    ├── router // 路由入口
    ├── components // 通用元件
    ├── modules    // 模組專案開發目錄（子模組）
    |    ├── tms    // 子模組必須
    |    │    ├── components // 模組通用元件
    |    │    ├── pages // 模組頁面
    |    │    ├── router // 模組路由
    |    │    └── store // 模組vuex資料
    |    └── ... // 各子模組
    ├── app.vue   // 跟元件
    └──  main.js   // 專案入口
複製程式碼

一個部門一個子模組，每個子模組必須包含master（生產）、dev（開發）分支（推薦 gitflow 工作流）。

開發流程

克隆專案

如所有的webpack專案一樣，src只是業務程式碼，開發配置都放在src外層，所以跑起開發環境首先需要克隆主專案。

$ git clone https://github.com/test/main.git
複製程式碼

新增子模組

當然我們一般不用master分支做開發，正確的姿勢是clone專案之後馬上切換到基於dev的開發分支（原則上業務組不需要關注主專案的開發，主專案由架構組負責，但是為了保證程式碼的最新，並且將子模組新增合併進dev分支中，所以切換到主分支dev）。

$ git checkout -b dev origin/dev
複製程式碼

這時候如果你的專案中已經有子模組了，你會發現modules資料夾下已經有了一個個子模組，但是顯然現在這些模組都是空目錄（預期的結果，我們不需要關注其他模組）。同時專案根目錄下有一個.gitmodules檔案，內容如下：

[submodule "modules/suba"]
	path = modules/suba
	url = https://github.com/test/suba.git
複製程式碼

這裡就是你的子模組關聯檔案，每新增一個子模組就會新增一條記錄，如果是第一次新增Git子模組會自動生成。

開發環境有了，現在需要關聯你的子模組：

$ git submodule add https://github.com/test/subb.git modules/subb
複製程式碼

首次新增的子模組會拉取整個專案，開啟muodules/subb資料夾，整個子模組專案都完好地列在那裡，同時.gitmodules裡新增了一條子模組記錄modules/subb。

編輯子模組

同樣的，我們也不應該在子模組的master分支上做任何編輯，這時候我們需要將子模組切換到基於dev的開發分支。

進入子模組目錄下：

$ cd modules/subb/
$ git checkout -b feature/some-change origin/dev
複製程式碼

當你在子模組做完一些修改一些修改之後，你想要把這這些修改推送到遠端。

$ git commit -am 'test commit submodule'
$ git checkout dev
$ git merge feature/some-change
$ git push origin dev
$ git branch -d feature/some-change
複製程式碼

這時候你的子模組的修改就已經提交到遠端了，但是如果你進如到主專案的根目錄檢視差異，你會發現主專案中多了一些修改：

$ cd ../../
$ git diff
>   diff --git a/subb b/subb
    index 433859c..b78179a 160000
    --- a/subb
    +++ b/subb
    @@ -1 +1 @@
    -Subproject commit 433859c90e539d2a1b9fda27b32bef0d0acae9e6
    +Subproject commit b78179adab252a524ff2a41d6407a7daa6dad34f
複製程式碼

這是因為你修改了子模組subb並提交了，但是主專案的指標依舊指向那個老的commit id，如果你不提交這個修改的話，別人拉取主專案並且使用git submodule update更新子模組還是會拉取到你修改前的程式碼。

所以這時候你需要把主專案也提交一遍：

$ git commit -am "test commit submodule"
$ git push origin dev
複製程式碼

這樣，你的修改就已經全部提交了。

新成員加入

當有新成員你加入你的子模組並且需要拉取程式碼的時候：

$ git clone https://github.com/test/main.git
$ git checkout -b dev origin/dev
$ git submodule init
$ git submodule update subb
複製程式碼

git submodule update [submodule name]是指定拉取指定子模組的用法，如果你需要更新所有的子模組只需要使用git submodule update就可以了，一般我們在協作中只關注自己的模組。

那麼接下來新成員也可以延續我們上面的開發流程了。

刪除子模組

當然也有需求變動或者新增錯誤的時候，這時候就需要刪除子模組了，值得吐槽的是git沒有直接刪除子模組的命令，所以只能逐步刪除相關檔案：

  • 在版本控制中刪除子模組：
$ git rm -r modules/subb
複製程式碼
  • 在編輯器中刪除如下相關內容，也可以使用命令vi .gitmodules在vim中刪除：
 [submodule "modules/subb"]
          path = modules/subb
          url = https://github.com/test/subb.git
          branch = dev
複製程式碼
  • 在編輯器中刪除如下相關內容，也可以使用命令vi .git/config在vim中刪除：
 [submodule "modules/subb"]
         url = https://github.com/test/subb.git
         active = true
複製程式碼
  • 刪除.git下的快取模組：
$ rm -rf .git/modules/subb
複製程式碼

接下來提交修改：

$ git commit -am "delete subb"
$ git push origin dev
複製程式碼

釋出專案

當整個開發流程都結束了，終於到了釋出的時刻，當然需要在主專案更新你的所有子模組：

$ git checkout master
$ git pull origin master
$ git submodule update
$ yarn build
複製程式碼

這時候就可以釋出你整個專案了 ?，關於協作中使用子模組的操作就寫到這裡，如果有疑問請在評論區留言。

-- The End

相關文章