使用場景
當項目越來越龐大之后，不可避免的要拆分成多個子模塊，我們希望各個子模塊有獨立的版本管理，并且由專門的人去維護，這時候我們就要用到git的submodule功能。
常用命令
git clone repository> --recursive 遞歸的方式克隆整個項目
git submodule add repository> path> 添加子模塊
git submodule init 初始化子模塊
git submodule update 更新子模塊
git submodule foreach git pull 拉取所有子模塊
如何使用
1. 創(chuàng)建帶子模塊的版本庫
例如我們要創(chuàng)建如下結(jié)構(gòu)的項目
project
|--moduleA
|--readme.txt
創(chuàng)建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 ..
創(chuàng)建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可以看到這兩項的內(nèi)容。這里需要指出父項目的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 ..
方法二，采用遞歸參數(shù)--recursive，需要注意同樣submodule默認是不在任何分支上的，它指向父項目存儲的submodule commit id。
git clone project.git project3 --recursive
3. 修改子模塊
修改子模塊之后只對子模塊的版本庫產(chǎn)生影響，對父項目的版本庫不會產(chǎn)生任何影響，如果父項目需要用到最新的子模塊代碼，我們需要更新父項目中submodule commit id，默認的我們使用git status就可以看到父項目中submodule commit id已經(jīng)改變了，我們只需要再次提交就可以了。
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父項目，然后執(zhí)行g(shù)it 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. 刪除子模塊
網(wǎng)上有好多用的是下面這種方法
git rm --cached moduleA
rm -rf moduleA
rm .gitmodules
vim .git/config
刪除submodule相關(guān)的內(nèi)容，例如下面的內(nèi)容
[submodule "moduleA"]
url = /Users/nick/dev/nick-doc/testGitSubmodule/moduleA.git
然后提交到遠程服務器
git add .
git commit -m "remove submodule"
但是我自己本地實驗的時候，發(fā)現(xiàn)用下面的方式也可以，服務器記錄的是.gitmodules和moduleA，本地只要用git的刪除命令刪除moduleA，再用git status查看狀態(tài)就會發(fā)現(xiàn).gitmodules和moduleA這兩項都已經(jīng)改變了，至于.git/config，仍會記錄submodule信息，但是本地使用也沒發(fā)現(xiàn)有什么影響，如果重新從服務器克隆則.git/config中不會有submodule信息。
git rm moduleA
git status
git commit -m "remove submodule"
git push origin master
到此這篇關(guān)于Git Submodule管理項目子模塊的使用的文章就介紹到這了,更多相關(guān)Git Submodule 子模塊內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:- git中submodule子模塊的添加、使用和刪除的示例代碼
- 詳解git submodule使用以及注意事項
- Git Submodule使用完整教程(小結(jié))
