使用Git Submodule管理子模塊

使用場景

基于公司的項目會越來越多隶垮,常常需要提取一個公共的類庫提供給多個項目使用暑塑,但是這個library怎么和git在一起方便管理呢歉眷?
我們需要解決下面幾個問題:

  • 如何在git項目中導入library庫?
  • library庫在其他的項目中被修改了可以更新到遠程的代碼庫中?
  • 其他項目如何獲取到library庫最新的提交?
  • 如何在clone的時候能夠自動導入library庫?

解決以上問題逻炊,可以考慮使用git的 Submodule來解決市咆。

什么是Submodule?

git Submodule 是一個很好的多項目使用共同類庫的工具秤掌,他允許類庫項目做為repository,子項目做為一個單獨的git項目存在父項目中愁铺,子項目可以有自己的獨立的commitpush闻鉴,pull茵乱。而父項目以Submodule的形式包含子項目,父項目可以指定子項目header孟岛,父項目中會的提交信息包含Submodule的信息瓶竭,再clone父項目的時候可以把Submodule初始化督勺。

在項目中使用Submodule

使用git命令可以直接添加Submodule

git submodule add git@github.com:jjz/pod-library.git pod-library

使用 git status命令可以看到

git status

    On branch master
    Changes to be committed:
    
        new file:   .gitmodules
        new file:   pod-library

可以看到多了兩個需要提交的文件:.gitmodulespod-library
.gitmodules 內(nèi)容包含Submodule的主要信息,指定reposirory,指定路徑:

    [submodule "pod-library"]
        path = pod-library
        url = git@github.com:jjz/pod-library.git

可以看到記錄了子項目的目錄和子項目的git地址信息斤贰。
pod-libray內(nèi)容只保護子項目的commit id智哀,就能指定到對于的git header上,例如:

Subproject commit 4ac42d2f8b9ba0c2f0f2f2ec87ddbd529275fea5

4ac42d2f8b9ba0c2f0f2f2ec87ddbd529275fea5就是子項目的commit id,父項目的git并不會記錄Submodule的文件變動荧恍,它是按照commit git指定Submodulegit header瓷叫。

另外,這兩個文件都需要提交到父項目的git中

還可以這樣使用命令添加Submodule

git add .gitmodules pod-ibrary
git commit -m "pod-library submodule"
git submodule init

修改Submodule

首先需要確認有對Submodule的commit權(quán)限送巡。
進入Submodule目錄里面:

cd pod-library/

修改其中的一個文件看下文件的可以用git status查看變動:

git status

modified:   pod-library/UseAFHTTP.h

提交Submodule的更改內(nèi)容:

git commit -a -m'test submodule'

然后push 到遠程服務(wù)器:

git push

然后再回到父目錄,提交Submodule在父項目中的變動:

cd ..
git status
on branch master

modified:   pod-library (new commits)

可以看到pod-library中已經(jīng)變更為Submodule最新的commit id:

Subproject commit 330417cf3fc1d2c42092b20506b0d296d90d0b5f

需要把Submodule的變動信息推送到父項目的遠程服務(wù)器

git commit -m'update submodule'
git push

這樣就把子模塊的變更信息以及子模塊的變更信息提交到遠程服務(wù)器了摹菠,從遠程服務(wù)器上更新下來的內(nèi)容就是最新提交的內(nèi)容了。

更新Submodule

更新Submodule有兩種方式:
在父項目的目錄下直接運行

git submodule foreach git pull

在Submodule的目錄下面更新
>cd pod-library
git pull

可以看到在Submodule的目錄中,使用git和單獨的一個項目是一樣的,注意更新Submodule的時候如果有新的commit id產(chǎn)生骗爆,需要在父項目產(chǎn)生一個新的提交次氨,pod-libray文件中的 Subproject commit會變?yōu)樽钚碌?code>commit id。

clone Submodule

clone Submodule有兩種方式 一種是采用遞歸的方式clone整個項目摘投,一種是clone父項目煮寡,再更新子項目。

  1. 采用遞歸參數(shù) --recursive

git clone git@github.com:jjz/pod-project.git --recursive

輸出結(jié)果:

    loning into 'pod-project'...
    remote: Counting objects: 57, done.
    remote: Compressing objects: 100% (45/45), done.
    remote: Total 57 (delta 13), reused 49 (delta 8), pack-reused 0
    Receiving objects: 100% (57/57), 18.79 KiB | 0 bytes/s, done.
    Resolving deltas: 100% (13/13), done.
    Checking connectivity... done.
    Submodule 'pod-library' (git@github.com:jjz/pod-library.git) registered for path 'pod-library'
    Cloning into 'pod-library'...
    remote: Counting objects: 34, done.
    remote: Compressing objects: 100% (25/25), done.
    remote: Total 34 (delta 8), reused 30 (delta 7), pack-reused 0
    Receiving objects: 100% (34/34), 12.95 KiB | 0 bytes/s, done.
    Resolving deltas: 100% (8/8), done.
    Checking connectivity... done.
    Submodule path 'pod-library': checked out '330417cf3fc1d2c
    
    42092b20506b0d296d90d0b5f'

可以看到init Submodule 會自動被clone下來

  1. 第二種方法先clone父項目谷朝,再初始化Submodule

git clone git@github.com:jjz/pod-project.git
cd pod-project
git submodule init

輸出:

    Submodule 'pod-library' (git@github.com:jjz/pod-library.git) 
    registered for path 'pod-library'

更新Submodule:

git submodule update

運行結(jié)果:

  Cloning into 'pod-library'...
  remote: Counting objects: 34, done.
  remote: Compressing objects: 100% (25/25), done.
  remote: Total 34 (delta 8), reused 30 (delta 7), pack-reused 0
  Receiving objects: 100% (34/34), 12.95 KiB | 0 bytes/s, done.
  Resolving deltas: 100% (8/8), done.
  Checking connectivity... done.
  Submodule path 'pod-library': checked out '330417cf3fc1d2c42092b20506b0d296d90d0b5f'

刪除Submodule

git 并不支持直接刪除Submodule需要手動刪除對應(yīng)的文件:

cd pod-project
git rm --cached pod-library
rm -rf pod-library
rm .gitmodules

更改git的配置文件config:

vim .git/config

可以看到Submodule的配置信息:

[submodule "pod-library"]
  url = git@github.com:jjz/pod-library.git

刪除submodule相關(guān)的內(nèi)容,然后提交到遠程服務(wù)器:

git commit -a -m 'remove pod-library submodule'

代碼地址:
父項目:https://github.com/jjz/pod-project
子項目:https://github.com/jjz/pod-library

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末洲押,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子圆凰,更是在濱河造成了極大的恐慌杈帐,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,509評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件专钉,死亡現(xiàn)場離奇詭異挑童,居然都是意外死亡,警方通過查閱死者的電腦和手機跃须,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,806評論 3 394
  • 文/潘曉璐 我一進店門站叼,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人菇民,你說我怎么就攤上這事尽楔。” “怎么了第练?”我有些...
    開封第一講書人閱讀 163,875評論 0 354
  • 文/不壞的土叔 我叫張陵阔馋,是天一觀的道長。 經(jīng)常有香客問我娇掏,道長呕寝,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,441評論 1 293
  • 正文 為了忘掉前任婴梧,我火速辦了婚禮下梢,結(jié)果婚禮上客蹋,老公的妹妹穿的比我還像新娘。我一直安慰自己孽江,他們只是感情好讶坯,可當我...
    茶點故事閱讀 67,488評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著岗屏,像睡著了一般闽巩。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上担汤,一...
    開封第一講書人閱讀 51,365評論 1 302
  • 那天,我揣著相機與錄音洼冻,去河邊找鬼崭歧。 笑死,一個胖子當著我的面吹牛撞牢,可吹牛的內(nèi)容都是我干的率碾。 我是一名探鬼主播,決...
    沈念sama閱讀 40,190評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼屋彪,長吁一口氣:“原來是場噩夢啊……” “哼所宰!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起畜挥,我...
    開封第一講書人閱讀 39,062評論 0 276
  • 序言:老撾萬榮一對情侶失蹤仔粥,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后蟹但,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體躯泰,經(jīng)...
    沈念sama閱讀 45,500評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡桂肌,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,706評論 3 335
  • 正文 我和宋清朗相戀三年忽刽,在試婚紗的時候發(fā)現(xiàn)自己被綠了追迟。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片笑窜。...
    茶點故事閱讀 39,834評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡蛮瞄,死狀恐怖乘瓤,靈堂內(nèi)的尸體忽然破棺而出褂痰,到底是詐尸還是另有隱情念颈,我是刑警寧澤卵慰,帶...
    沈念sama閱讀 35,559評論 5 345
  • 正文 年R本政府宣布向族,位于F島的核電站,受9級特大地震影響件相,放射性物質(zhì)發(fā)生泄漏再扭。R本人自食惡果不足惜氧苍,卻給世界環(huán)境...
    茶點故事閱讀 41,167評論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望让虐。 院中可真熱鬧,春花似錦赡突、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,779評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至笼才,卻和暖如春漱受,著一層夾襖步出監(jiān)牢的瞬間骡送,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,912評論 1 269
  • 我被黑心中介騙來泰國打工虐先, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人蛹批。 一個月前我還...
    沈念sama閱讀 47,958評論 2 370
  • 正文 我出身青樓膀息,卻偏偏與公主長得像般眉,于是被迫代替她去往敵國和親潜支。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,779評論 2 354

推薦閱讀更多精彩內(nèi)容

  • 實例代碼:父項目:https://github.com/jjz/pod-project子項目:https://gi...
    姜家志閱讀 3,205評論 0 11
  • 做為一名程序員,大家對 ** Git ** 肯定都不陌生裁替,最近項目中用到了 Git 子模塊,今天弱判,給大家講一下 *...
    rangel閱讀 2,017評論 5 6
  • 寫在前面: 1、使用Git Submodule可能遇到的坑(http://blog.devtang.com/201...
    Funnyer閱讀 5,768評論 0 0
  • 本文作者陳云峰开伏,轉(zhuǎn)載請注明。 這篇文章記錄個人常用的一些命令捅伤,和記不住的一些命令,轉(zhuǎn)載了并不斷更新丛忆。 Git官網(wǎng) ...
    陳云峰閱讀 2,815評論 0 24
  • 我的同窗好友精博仍秤,華中師大的高材生熄诡,一名人民教師诗力,今天有幸得他邀請參加了他的婚禮,又一次見證了好朋友的婚禮姜骡,并送上...
    天行見閱讀 298評論 0 1