這篇文章主要介紹了詳解git submodule使用以及注意事項(xiàng)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧。
一、背景
在平時的軟件開發(fā)過程中常常會有這樣的場景，自己負(fù)責(zé)的某個模塊會依賴其他模塊或者第三方的library。這時你自己的模塊是一個獨(dú)立的代碼倉庫，你想要實(shí)現(xiàn)這樣一種功能，當(dāng)你從你的模塊的代碼倉庫里把代碼拉到本地來的時候，能自動的將你依賴的模塊或第三方庫都拉到指定的目錄當(dāng)中去。
當(dāng)然要實(shí)現(xiàn)這個功能的方法有很多，比如使用repo之類的工具，又比如如果你使用的是svn作為版本管理工具，那么你可以使用svn的external機(jī)制來引用第三方的project。
這里要說的是使用git作為版本管理工具的情況。
二、git submodule
其它的細(xì)枝末節(jié)就不再贅述了，咱直奔主題。
先來看具體用例：
目前有一個模塊A，其代碼倉庫的地址為：projectA.git， 它需要引用另一個模塊B, 其代碼倉庫的地址為：projectB.git。
假設(shè)模塊A的本地目錄為：projectA
希望引用模塊B為模塊A的子模塊，其在模塊A目錄下的路徑為： projectA/projectB
這里我們通過git 的submodule機(jī)制來實(shí)現(xiàn)。
比如在命令行里可以直接使用如下命令：
cd projectA
git submodule add projectB.git projectB
注： 這個submodule的 子目錄指定時不能以 “/”結(jié)尾， 比如上面的命令，就不能寫成 projectB/ 這個樣子。
就這么簡單的一句git命令就可以搞定了，當(dāng)然這還沒完，運(yùn)行完這個命令之后，在projectA目錄執(zhí)行g(shù)it status命令，可以看到如下的結(jié)果：
這時需要使用git commit命令和git push命令，將添加模塊B為模塊A的子模塊的結(jié)果push到模塊A的代碼倉庫里面去。
三、git clone包含子模塊的代碼倉庫
此時，就可以使用git clone命令來抓取模塊A的代碼倉庫，但要同時抓取到子模塊的倉庫的話，還需要一些方法：
正常的使用git clone命令，然后再使用 git submodule init 和git submodule update來獲取子模塊
git clone projectA.git
cd projectA
git submodule init
git submodule update
其運(yùn)行結(jié)果如下：
在使用git clone命令時，加上–recurse-submodules或–recursive 這樣的遞歸參數(shù)
git clone --recursive projectA.git
其運(yùn)行結(jié)果如下：
四、tortoisegit操作submodule
如果是使用tortoisegit的話，也可以使用圖形化界面進(jìn)行submodule的相關(guān)操作，如添加submodule就選擇如下圖所示的菜單：
添加子模塊的界面大概就是下面這個樣子：
這里和上面一樣“path”一欄不能以”/”結(jié)尾。 填寫之后，點(diǎn)擊OK，就會在主模塊的目錄下添加對應(yīng)的子模塊。
在clone時也是一樣的，它既可以只是clone，然后用上面菜單中，Submodule Update 選項(xiàng)來抓取子模塊的內(nèi)容，也可以在clone時選擇遞歸參數(shù)，如下所示：
五、忽略submodule中的修改或新增文件
我們引用第三方的project，大多數(shù)情況都是想以“只讀”的方式引用，不關(guān)心第三方project抓取下來之后是不是被修改，或者是在其目錄中添加了untracked的file， 因?yàn)槲覀冎皇抢〉谌降膒roject，而不會(往往時不能或不允許)對第三方project進(jìn)行提交。
以上面的模塊A和模塊B的例子來說，如果模塊A和模塊B中都有進(jìn)行修改，其結(jié)果可能就是如下這個樣子：
這并不是我們想要的結(jié)果。一開始的時候我的想法是使用 .gitignore 來忽略submodule的修改，但是無法做到，后來經(jīng)過一番搜索，終于找到了解決良藥。在添加了submodule之后，project的目錄下回生成一個.gitmodules文件，這個文件記錄了子模塊的路徑和倉庫地址等信息，如下圖所示：
我們要做的就是在[submodule “projectB”]中添加一個ignore子項(xiàng)，這個ignore子項(xiàng)可以有上個可選的值，untracked, dirty和all, 它們的意思分別是：
untracked ：忽略 在子模塊B(也就是projectB目錄)新添加的，未受版本控制內(nèi)容
dirty ： 忽略對projectB目錄下受版本控制的內(nèi)容進(jìn)行了修改
all ： 同時忽略untracked和dirty
這里我們先選擇dirty(至少先保證不提交對子模塊B的任何修改)，其他的可以根據(jù)具體需求來進(jìn)行選擇。
添加ignore子項(xiàng)之后的.gitmodules文件的內(nèi)容如下所示：
然后我們再使用git status查看，可以得到圖下結(jié)果：
可以看出，之前 “modified: projectB(modified content)” 已經(jīng)不見了， 此時對修改后的.gitmodules文件進(jìn)行commit和push， 之后在查看status或做commit時就可以忽略掉對子模塊B修改的部分了。
到此這篇關(guān)于詳解git submodule使用以及注意事項(xiàng)的文章就介紹到這了,更多相關(guān)git submodule使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
文章轉(zhuǎn)自腳本之家，原文鏈接：https://www.jb51.net/article/193748.htm
申請創(chuàng)業(yè)報道，分享創(chuàng)業(yè)好點(diǎn)子。點(diǎn)擊此處，共同探討創(chuàng)業(yè)新機(jī)遇！
