Git SubModule使用

背景

在实际工作中,我们经常会遇到有些复杂的项目,根据功能拆分成很多子模块,或者同一个子模块在不同的项目中被依赖使用。一旦子模块有更新,所有工程里的相关代码都要更新,重复工作而且可能出错。
为了解决这个问题,我们可以使用Git的submodule功能。子模块( submodule )是一个内嵌在 git 仓库(父工程)中的 git 仓库,有点儿拗口。通过子模块,可以将外部的仓库作为子目录放到自己的仓库中,既能方便的管理依赖,又可以保持依赖本身的独立性。

使用

在git管理平台上新建两个项目,主项目TestMain和子模块项目TestSub,在TestMain中添加TestSub,同时TestSub有其独立的版本控制。

1. 将主项目clone到本地

git clone [主项目远程仓库地址]

2. 添加子模块

进入主项目TestMain目录,使用以下命令创建一个子模块

git submodule add [子模块远程仓库地址] 

此时项目仓库中会多出两个文件

  • .gitmodules:保存子模块的相关信息
  • testsub:子模块代码
    这时候可以通过git status查看当前状态



    git submodule 查看子模块版本信息



    然后git commit,push,成功后在主项目的远程仓库里可以看到子模块文件夹,并带上其仓库的版本号

3. 使用带有子模块的项目

后续使用者clone主项目后,子模块默认是空的,需要我们在项目根目录下执行如下命令完成子模块的下载

git submodule init
git submodule update

git submodule update --init --recursive 

还有一种更简单的办法,在clone主项目的时候带参数,这样会递归地将项目中所有子模块的代码拉取。

git clone --recurse-submodules [主项目url]

对于已经clone过存在的项目,用git pull 命令同样如此

git pull --recurse-submodules

拉取子模块代码后,子模块默认显示在临时分支上,如果要进行开发,记得进入子模块切换到指定分支,如果子模块太多且分支一样,可以执行以下命令批量切换。

git submodule foreach git checkout xxx

如果不小心在临时分支上做了修改,要记得合并到主分支,否则修改可能会丢失。

4. 更新子模块

子模块是不断在维护更新的,在我们自己的项目里,一般不会去改动子模块。
第一种情况,子模块远程有更新,如果想保持本地子项目与远程仓库版本一致,就需要用以下命令更新子模块至远程仓库的最新版。

git submodule update --remote

注意:命令 git submodule update 是更新主项目内子模块到最新版本,即与主项目远程仓库记录的子模块版本一致
当然也可以进入到子模块目录下,用传统的git pull获取最新代码。如果主项目的子项目特别多,此时可以用以下命令执行

git submodule foreach git pull

第二种情况,如果本地主项目的子模块有更新,按以下步骤
a. 进入到子项目中对更新的代码进行一次提交操作,并推送到远程
b. 再回退到主项目中,对主项目进行一次提交,推送
注意:不管主项目是否有更新,只要子项目修改过代码并提交过,主项目就需要再提交一次,因为子项目的修改是会同步到主项目中的,这样才能保证开发的一致性!

5. 删除子模块

a. 执行 git submodule deinit testsub,自动在 .git/config 中删除了子模块相关信息。这个命令如果添加上参数 --force,则子模块工作区内即使有本地的修改,也会被移除。
b. 执行 git rm testsub,移除了 testsub 文件夹,并自动在 .gitmodules 中相关信息。
此时,主项目中关于子模块的信息基本已经删除(可能.git/modules 目录下还有残余),但是不影响,继续commit,push,完成对子模块的删除。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,997评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,603评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,359评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,309评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,346评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,258评论 1 300
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,122评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,970评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,403评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,596评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,769评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,464评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,075评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,705评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,848评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,831评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,678评论 2 354