git submodule 实践及总结

合作开发,不得不使用git来进行项目管理,下面来记录下关于git的踩坑记录。

子模块概念

对于一些比较大的工程,为了便模块复用,常常需要抽取子项目,分布式管理项目依赖,会用到子模块(git submodule)。

子模块跟父工程之间是两个独立的git仓库,只是父工程存储了它依赖的子仓库的版本号信息而已,信息提交相互独立。

子模块创建

子模块添加

# 在主工程仓库中添加子依赖子模块
$ git submodule add <远程子模块仓库地址> <相对于项目的本地路径>

下面模拟添加,执行完添加之后会返现本地多了一个.gitmodules隐藏文件。

$ git submodule add https://github.com/xxx/module.git module
$ cat .gitmodules
[submodule "module"]
    path = module
    url = https://github.com/xxx/module.git

设置子模块依赖分支

$ git submodule set-branch (--branch|-b <branch>) [--] <path>

# 例如设置 module 子模块依赖分支为 develop
$ git submodule set-branch -b develop module

$ cat .gitmodules
[submodule "module"]
    path = module
    url = https://github.com/xxx/module.git
    branch = develop

查看.gitmodules文件发现其指定了一个依赖的子模块,path指明在主仓库的位置,url指明子模块仓库的远程地址。
并且在主工程仓库的.git/config配置文件中加入了submodule字段

[submodule "module"]
    url = https://github.com/xxx/module.git
    active = true

clone带有子模块的仓库

在主工程仓库添加完子模块并push到远端之后,同事需要clone或者pull主工程仓库之后,会发现子模块依赖信息(有.gitmodules文件),但是子模块文件目录下面是空的,这个时候需要手动对子模块信息初始化并更新。

$ git submodule init

# 执行结果
Submodule 'module' (https://github.com/xxxx/module.git) registered for path 'module'

补充:当有该仓库下依赖了多个子模块,但是只想初始化指定的子模块,可以在指令后面追加需要初始化模块path

$ git submodule init [<path>…]
# 例如 git submodule init demo1 demo2

这时.git/config配置文件中会包含有依赖的子模块信息,再执行更新,从远程拉取依赖的commit id子模块代码

git submodule update

# 执行结果
Cloning into '/.../MainProject/module'...
Submodule path 'module': checked out 'submodule commit id'

当多层依赖子模块时(子模块里面依赖有子模块),这个时候就比较麻烦了,每次clone下来之后首先要在第一层依赖的子模块的仓库对子模块进行initupdate,之后再进入依赖有子模块的子模块仓库再进行initupdate,以此递归下去,比较麻烦,此时可以使用下面指令一次性完成递归initupdate

$ git submodule update --init --recursive

也或者直接在clone的时候完成多层依赖的子模块们的initupdate

$ git clone --recurse-submodules <远程主工程仓库地址>

这样便省去了手动递归执行$ git submodule init$ git submodule update

注意:不管是使用系统的递归克隆还是手动递归执行的初始化和更新,此时子模块的HEAD都有可能处于游离状态,需要手动切换到对应的分支

子模块信息更改

主工程都记录有依赖的子工程的提交版本,查看主工程依赖的commit id

$ git submodule status

# 结果
414b65085b41f4270322716df924625fdbcedf7b module (heads/master)

我们可以cd到子工程仓库目录下面,对子工模块代码做一些修改,在commit之前主仓库status会显示module modified content,显示子模块原先提交版本上有脏数据;在commit之后主仓库的status会显示module new commits,依赖的子模块的提交版本号发生变化,在子模块仓库代码提交并更新到远端之后,便可以提交更新依赖的子模块的提交版本号。

注意:主工程的提交及更新并不会对子模块代码造成影响,只会影响其依赖的子模块提交版本

如果同事更新了子模块代码,然后更新了父项目中依赖的版本号。你在主仓库执行git pull之后会发现子模块文件有变更,执行git diff会发现如下更改

$ git diff
-Subproject commit f88b46fefb73438e2e65c2b7bc7baba8a64ae5d2 #同事新提交的子模块版本
+Subproject commit c577a495c14159b3693c54af2a0bb9760d748246 #我们原来依赖的子模块的老版本

这时我们如果对父工程仓库代码直接进行提交,便会更改父仓库依赖的子模块版本号,别人更新下来的父仓库还是依赖老的子模块提交版本。虽然后期可以通过更新依赖版本更正过来,但是也会给平时的合作开发带来不必要的麻烦,因此每次对主仓库进行git pull之后,还要执行git submodule update对依赖的子模块代码进行一次更新。
但是如果子模块里面还依赖有子模块,我们就需要cd到对应的目录下面,一层层调用子模块更新,此时为了方便,我们可以用git submodule update --recursive指令完成多层子模块代码的更新。

子模块删除

删除一共分为3步
1、从.git/config中删除子模块条目

$ git submodule deinit -f <path>

# 例如:想删除名字叫 module 的子模块
$ git submodule deinit -f module

2、从.git/modules目录中删除子模块目录

$ rm -rf .git/modules/<path>

# 例如:想删除名字叫 module 的子模块
$ rm -rf .git/modules/module

3、删除.gitmodules中子模块条目,并删除项目目录下的子模块目录

$ git rm -f <path>

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

推荐阅读更多精彩内容