Press "Enter" to skip to content

subtree vs submodule

内容纲要

简述

在开发中,稍微复杂一点的项目都会有多个功能模块,大致结构可能是这样

project
 |–moduleA
  |–submoduleC
  |–submoduleD
 |–moduleB

同时,模块A可能被project2、proejct3等多个项目使用,project和ABCD各个模块可能在不同的git仓库中,这时,就需要使用git的的模块功能,目前git提供的子模块功能主要有
submodule和subtree两种。

submodule

初始化项目目录

mkdir root
cd root
git init
mkdir region
cd region
git init

增加三个字模块

git submodule add -b ResourceEvaluate http://scm.lsf.com/bitbucket/scm/lsf/ModuleB.git ModuleB
git submodule add http://sifan.liu@scm.ModuleB.com/bitbucket/scm/nic/ModuleB_backend_ModuleA.git ModuleA
git submodule add http://sifan.liu@scm.ModuleB.com/bitbucket/scm/nic/nzy_region_resourceevaluation.git ModuleC

执行以上命令后会生成.gitmodule的文件,文件存储子模块信息,格式大致如下

[submodule "ModuleB"]
    path = ModuleB
    url = http://scm.lsf.com/bitbucket/scm/lsf/ModuleB.git
    branch = ResourceEvaluate
[submodule "ModuleA"]
    path = ModuleA
    url = http://sifan.liu@scm.ModuleB.com/bitbucket/scm/nic/ModuleB_backend_ModuleA.git
[submodule "ModuleC"]
    path = ModuleC
    url = http://sifan.liu@scm.ModuleB.com/bitbucket/scm/nic/nzy_region_resourceevaluation.git

之后提交.gitmoduley文件

git commit -m 'add submodule '
git push

以上完成子模块的增加
检出

git clone http:/scm.ModuleB.com/bitbucket/scm/~sifan.liu/region.git

检出后各模块内容为空目录, 需要执行初始化

git submodule init

注册各子模块与远程仓库的关系

git submodule update --remote

更新所有模块

注意: 更新之后模块并非在指定的分支上, 而是关联在最近一次的commitID

git submodule foreach git checkout master

切换到所有master分支上(ModuleB为ResourceEvaluate,暂时需要单独执行)
其余所有操作可单独在各个模块上执行。

subtree

增加远程仓库并设置引用名,此步可省略,主要是为了简化后面的操作

git remote add ModuleA http://sifan.liu@scm.ModuleB.com/bitbucket/scm/nic/ModuleB_backend_ModuleA.git master  
git remote add ModuleA http://sifan.liu@scm.ModuleB.com/bitbucket/scm/nic/ModuleB_backend_ModuleA.git master  

通过subtree添加子模块,–squash可省略,其功能是只有最新的提交记录被引入,去掉后则是引入所有历史提交记录

git subtree add --prefix=ModuleA --squash ModuleA master

更新

git subtree pull -P ModuleA ModuleA master

提交

git subtree push --prefix=ModuleA ModuleA master

submodule 与 subtree的差异

  1. 核心区别:

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

  1. cons & pros
/ submodule subtree 对比
远程仓库空间占用 submodule 只是引用, 所以不占用额外空间 子模块copy,会占用较大的额外空间 submodule 占用空间小,略优
本地空间占用 可根据需要下载 会下载整个项目 所有模块基本都要下载,二者差异不大
仓库克隆 克降后所有子模块为空,需要注册及更新,同时更新后还需切换分支 克隆之后即可使用 submodule步骤略多,subtree占优
更新本地仓库 更新后所有子模块后指向最后一次提交,更新后需要重新切回分支,所有子模块只需一条更新语句即可 所有子模块需要单独更新 各有优劣,相对subtree更好用一些(笔者觉得submodule更好)
提交本地修改 只需关心子模块即可,子模块的所有操作与普通git项目相同 提交执行命令相对复杂一些 submodule操作更简单,submodule占优

原文链接:https://blog.csdn.net/liusf1993/article/details/72765131

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注