Git Submodule管理項目子模塊

使用場景

當項目愈來愈龐大以後，不可避免的要拆分紅多個子模塊，咱們但願各個子模塊有獨立的版本管理，而且由專門的人去維護，這時候咱們就要用到git的submodule功能。

經常使用命令

git clone <repository> --recursive 遞歸的方式克隆整個項目
git submodule add <repository> <path> 添加子模塊
git submodule init 初始化子模塊
git submodule update 更新子模塊
git submodule foreach git pull 拉取全部子模塊

如何使用

1. 建立帶子模塊的版本庫

例如咱們要建立以下結構的項目

project
  |--moduleA
  |--readme.txt

建立project版本庫，並提交readme.txt文件

git init --bare project.git
git clone project.git project1
cd project1
echo "This is a project." > readme.txt
git add .
git commit -m "add readme.txt"
git push origin master

建立moduleA版本庫，並提交a.txt文件

git init --bare moduleA.git
git clone moduleA.git moduleA1
cd moduleA1
echo "This is a submodule." > a.txt
git add .
git commit -m "add a.txt"
git push origin master

在project項目中引入子模塊moduleA，並提交子模塊信息

cd project1
git submodule add ../moduleA.git moduleA
git status
git diff
git add .
git commit -m "add submodule"
git push origin master

使用git status能夠看到多了兩個須要提交的文件，其中.gitmodules指定submodule的主要信息，包括子模塊的路徑和地址信息，moduleA指定了子模塊的commit id，使用git diff能夠看到這兩項的內容。

這裏須要指出父項目的git並不會記錄submodule的文件變更，它是按照commit id指定submodule的git header，因此.gitmodules和moduleA這兩項是須要提交到父項目的遠程倉庫的。

2. 克隆帶子模塊的版本庫

方法一，先clone父項目，再初始化submodule，最後更新submodule，初始化只須要作一次，以後每次只須要直接update就能夠了，須要注意submodule默認是不在任何分支上的，它指向父項目存儲的submodule commit id。

git clone project.git project2
cd project2
git submodule init
git submodule update

方法二，採用遞歸參數--recursive，須要注意一樣submodule默認是不在任何分支上的，它指向父項目存儲的submodule commit id。

git clone project.git project3 --recursive

3. 修改子模塊

修改子模塊以後只對子模塊的版本庫產生影響，對父項目的版本庫不會產生任何影響，若是父項目須要用到最新的子模塊代碼，咱們須要更新父項目中submodule commit id，默認的咱們使用git status就能夠看到父項目中submodule commit id已經改變了，咱們只須要再次提交就能夠了。

cd project1/moduleA
git branch
echo "This is a submodule." > b.txt
git add .
git commit -m "add b.txt"
git push origin master
cd ..
git status
git diff
git add .
git commit -m "update submodule add b.txt"
git push origin master

4. 更新子模塊

更新子模塊的時候要注意子模塊的分支默認不是master。

方法一，先pull父項目，而後執行git submodule update，注意moduleA的分支始終不是master。

cd project2
git pull
git submodule update

方法二，先進入子模塊，而後切換到須要的分支，這裏是master分支，而後對子模塊pull，這種方法會改變子模塊的分支。

cd project3/moduleA
git checkout master
cd ..
git submodule foreach git pull

5. 刪除子模塊

網上有好多用的是下面這種方法

git rm --cached moduleA
rm -rf moduleA
rm .gitmodules
vim .git/config

刪除submodule相關的內容，例以下面的內容

[submodule "moduleA"]
      url = /Users/nick/dev/nick-doc/testGitSubmodule/moduleA.git

而後提交到遠程服務器

git add .
git commit -m "remove submodule"

可是我本身本地實驗的時候，發現用下面的方式也能夠，服務器記錄的是.gitmodules和moduleA，本地只要用git的刪除命令刪除moduleA，再用git status查看狀態就會發現.gitmodules和moduleA這兩項都已經改變了，至於.git/config，仍會記錄submodule信息，可是本地使用也沒發現有什麼影響，若是從新從服務器克隆則.git/config中不會有submodule信息。

git rm moduleA
git status
git commit -m "remove submodule"
git push origin master

更多參考