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
cd ..

　　創建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
cd ..

　　

在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
cd ..

　　使用git status可以看到多了兩個需要提交的文件，其中.gitmodules指定submodule的主要信息，包括子模塊的路徑和地址信息，moduleA指定了子模塊的commit id，使用git diff可以看到這兩項的內容。這里需要指出父項目的git並不會記錄submodule的文件變動，它是按照commit id指定submodule的git header，所以.gitmodules和moduleA這兩項是需要提交到父項目的遠程倉庫的。

On branch master
Your branch is up-to-date with 'origin/master'.
Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)
	new file:   .gitmodules
	new file:   moduleA

　　

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

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

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

　　

方法二，采用遞歸參數--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
cd ..

　　

4. 更新子模塊

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

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

cd project2
git pull
git submodule update
cd ..

　　方法二，先進入子模塊，然后切換到需要的分支，這里是master分支，然后對子模塊pull，這種方法會改變子模塊的分支。

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

　　

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

　　

 

案例：

討論 商城 項目 mall 中的 admin 是編譯項目包 ，每次編譯都會產生很多修改，不利於我們對比代碼 ，現將mall 中的 admin 移出 mall 項目代碼庫 ，admin 新起一個代碼庫 http://gitlab.jmchuangke.com/php/admin.git ，並將 admin 代碼庫作為 mall項目的 一個 submodule ， mall代碼庫的 dev 分支已經 移出了 admin， 各位各自的分支 需合並 dev 分支到各自的開發分支上 ，合並后 admin 目錄將消失 ，

在項目目錄下執行命令 git submodule add http://gitlab.jmchuangke.com/php/admin.git admin 即可添加admin成功，

后續 admin有更新 執行命令 git pull 后， 執行 命令 git submodule foreach git pull 即可拉取新的 admin新包

參考 ：https://www.cnblogs.com/nicksheng/p/6201711.html