Git Submodule管理項(xiàng)目子模塊的使用

使用場(chǎng)景

當(dāng)項(xiàng)目越來(lái)越龐大之后，不可避免的要拆分成多個(gè)子模塊，我們希望各個(gè)子模塊有獨(dú)立的版本管理，并且由專門的人去維護(hù)，這時(shí)候我們就要用到git的submodule功能。

常用命令

git clone repository> --recursive 遞歸的方式克隆整個(gè)項(xiàng)目
git submodule add repository> path> 添加子模塊
git submodule init 初始化子模塊
git submodule update 更新子模塊
git submodule foreach git pull 拉取所有子模塊

如何使用

1. 創(chuàng)建帶子模塊的版本庫(kù)

例如我們要?jiǎng)?chuàng)建如下結(jié)構(gòu)的項(xiàng)目

project
 |--moduleA
 |--readme.txt

創(chuàng)建project版本庫(kù)，并提交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版本庫(kù)，并提交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項(xiàng)目中引入子模塊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可以看到多了兩個(gè)需要提交的文件，其中.gitmodules指定submodule的主要信息，包括子模塊的路徑和地址信息，moduleA指定了子模塊的commit id，使用git diff可以看到這兩項(xiàng)的內(nèi)容。這里需要指出父項(xiàng)目的git并不會(huì)記錄submodule的文件變動(dòng)，它是按照commit id指定submodule的git header，所以.gitmodules和moduleA這兩項(xiàng)是需要提交到父項(xiàng)目的遠(yuǎn)程倉(cāng)庫(kù)的。

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. 克隆帶子模塊的版本庫(kù)

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

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

方法二，采用遞歸參數(shù)--recursive，需要注意同樣submodule默認(rèn)是不在任何分支上的，它指向父項(xiàng)目存儲(chǔ)的submodule commit id。

git clone project.git project3 --recursive

3. 修改子模塊

修改子模塊之后只對(duì)子模塊的版本庫(kù)產(chǎn)生影響，對(duì)父項(xiàng)目的版本庫(kù)不會(huì)產(chǎn)生任何影響，如果父項(xiàng)目需要用到最新的子模塊代碼，我們需要更新父項(xiàng)目中submodule commit id，默認(rèn)的我們使用git status就可以看到父項(xiàng)目中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. 更新子模塊

更新子模塊的時(shí)候要注意子模塊的分支默認(rèn)不是master。

方法一，先pull父項(xiàng)目，然后執(zhí)行g(shù)it submodule update，注意moduleA的分支始終不是master。

cd project2
git pull
git submodule update
cd ..

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

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

然后提交到遠(yuǎn)程服務(wù)器

git add .
git commit -m "remove submodule"

但是我自己本地實(shí)驗(yàn)的時(shí)候，發(fā)現(xiàn)用下面的方式也可以，服務(wù)器記錄的是.gitmodules和moduleA，本地只要用git的刪除命令刪除moduleA，再用git status查看狀態(tài)就會(huì)發(fā)現(xiàn).gitmodules和moduleA這兩項(xiàng)都已經(jīng)改變了，至于.git/config，仍會(huì)記錄submodule信息，但是本地使用也沒(méi)發(fā)現(xiàn)有什么影響，如果重新從服務(wù)器克隆則.git/config中不會(huì)有submodule信息。

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

到此這篇關(guān)于Git Submodule管理項(xiàng)目子模塊的使用的文章就介紹到這了,更多相關(guān)Git Submodule 子模塊內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！