核心区别

git submodule类似于引用,而git subtree类似于拷贝,比如你在一篇博客中想用到你另一篇博客的内容,git submodule是使用那篇博客的链接,而git subtree则是将内容完全copy过来。

submodule命令

  1. 添加submodule
1
2
git submodule add -b branchA http://github.com/../repoA.git pathA
git submodule add http://github.com/../repoB.git pathB

执行以上命令后会生成.gitmodule的文件,文件存储子模块信息:

1
2
3
4
5
6
7
[submodule "repoA"]
    path = pathA
    url = http://github.com/../repoA.git
    branch = branchA
[submodule "ModuleB"]
    path = ModuleB
    url = http://github.com/../repoB.git

提交.gitmodule文件

1
2
git commit -m 'add submodule'
git push
  1. clone新库初始化submodule clone之后各模块内容为空目录,需要执行:
1
git submodule init
  1. 拉取所有子模块 需要在.gitmodules文件中指定branch:分支名
1
2
3
 git submodule foreach git pull
 git submodule foreach git pull origin master
  1. 更新所有模块 更新后每个子模块并非在指定分支上,而是关联最近一次commitID。 使用git submodule foreach为每一个子模块执行切换命令:
1
git submodule foreach git checkout master

切换到所有master分支上(ModuleB为ResourceEvaluate,暂时需要单独执行)

  1. 删除子模块
1
2
3
4
5
6
git rm --cached moduleA
rm -rf moduleA
vi .gitmodules //删除moduleA相关的内容
git add .
git commit -m "remove moduleA"
git push origin master

subtree命令

  1. subtree添加子模块 通过subtree添加子模块,–squash可省略,其功能是只有最新的提交记录被引入,去掉后则是引入所有历史提交记录
1
2
3
4
#增加远程仓库并设置引用名`ModuleA`,此步可省略,主要是为了简化后面的操作
git remote add ModuleA http://github.com/../ModuleA.git master
#`subtree`添加子模块
git subtree add --prefix=ModuleA --squash  ModuleA master
  1. subtree更新
1
git subtree pull -P ModuleA ModuleA master
  1. subtree提交
1
git subtree push --prefix=ModuleA ModuleA master
/submodulesubtree结果
远程仓库空间占用submodule只是引用,基本不占用额外空间子模块copy,会占用较大的额外空间submodule占用空间较小,略优
本地空间占用可根据需要下载会下载整个项目所有模块基本都要下载,二者差异不大
仓库克隆克降后所有子模块为空,需要注册及更新,同时更新后还需切换分支克隆之后即可使用submodule步骤略多,subtree占优
更新本地仓库更新后所有子模块后指向最后一次提交,更新后需要重新切回分支,所有子模块只需一条更新语句即可所有子模块需要单独更新各有优劣,相对subtree更好用一些
提交本地修改只需关心子模块即可,子模块的所有操作与普通git项目相同提交执行命令相对复杂一些submodule操作更简单,submodule占优