标签:解决 新版本 child 复用 基本使用 reac code 嵌套 abc
一个中大型项目往往会依赖几个模块,git
提供了子库的概念。可以将这些子模块存放在不同的仓库中,通过submodule
或subtree
实现仓库的嵌套。本讲为Git
应用详解的倒数第二讲,胜利离我们不远了!
submodule
submodule
:子模块的意思,表示将一个版本库作为子库引入到另一个版本库中:
需要使用如下命令:
git submodule add 子库地址 保存目录
比如:
git submodule add git@github.com:AhuntSun/git_child.git mymodule
执行上述命令会将地址对应的远程仓库作为子库,保存到当前版本库的mymodule
目录下:
随后查看当前版本库的状态:
可以发现新增了两个文件。查看其中的.gitmodules
文件:
可以看到当前文件的路径和子模块的url
,随后将这两个新增文件添加、提交并推送。在当前仓库git_parent
对应的远程仓库中多出了两个文件:
其中mymodule
文件夹上的3bd7f76
对应的是子仓库git_child
中的最新提交:
点击mymodule
文件夹,会自动跳转到子仓库中:
通过上述分析,可以得出结论:两个仓库已经关联起来了,并且仓库git_child
为仓库git_parent
的子仓库;
当被依赖的子版本库发生变化时:在子版本库git_child
中新增文件world.txt
并提交到远程仓库:
这个时候依赖它的父版本库git_parent
要如何感知这一变化呢?
这个时候git_parent
只需要进入存放子库git_child
的目录mymodule
,执行git pull
就能将子版本库git_child
的更新拉取到本地:
当父版本库git_parent
依赖的多个子版本库都发生变化时,可以采用如下方法遍历更新所有子库:首先回到版本库主目录,执行以下指令:
git submodule foreach git pull
该命令会遍历当前版本库所依赖的所有子版本库,并将它们的更新拉取到父版本库git_parent
:
拉取完成后,查看状态,发现mymodule
目录下文件发生了变化,所以需要执行一次添加、提交、推送操作:
如果将使用了submodule
添加依赖了子库的父版本库git_parent
,克隆一份到本地的话。在克隆出来的新版本库git_parent2
中,原父版本库存放依赖子库的目录虽在,但是内容不在:
进入根据git_parent
复制出来的仓库git_parent2
,会发现mymodule
目录为空:
解决方法:可采用多条命令的分步操作,也可以通过参数将多步操作进行合并。
这是在执行了clone
操作后的额外操作,还需要做两件事:
手动初始化submodule
:
git submodule init
手动拉取依赖的子版本库;:
git submodule update --recursive
执行完两步操作后,子版本库中就有内容了。由此完成了git_parent
的克隆;
分步操作相对繁琐,还可以通过添加参数的方式,将多步操作进行合并。通过以下指令基于git_parent
克隆一份git_parent3
:
git clone git@github.com:AhuntSun/git_parent.git git_parent3 --recursive
--recursive
表示递归地克隆git_parent
依赖的所有子版本库。
git
没有提供直接删除submodule
子库的命令,但是我们可以通过其他指令的组合来达到这一目的,分为三步:
将submodule
从版本库中删除:
git rm --cache mymodule
git rm
的作用为删除版本库中的文件,并将这一操作纳入暂存区;
submodule
从工作区中删除;.gitmodules
目录删除;完成三步操作后,再进行添加,提交,推送即可完成删除子库的操作:
subtree
subtree
与submodule
的作用是一样的,但是subtree
出现得比submodule
晚,它的出现是为了弥补submodule
存在的问题:
submodule
不能在父版本库中修改子版本库的代码,只能在子版本库中修改,是单向的;submodule
没有直接删除子版本库的功能;而subtree
则可以实现双向数据修改。官方推荐使用subtree
替代submodule
。
首先创建两个版本库:git_subtree_parent
和git_subtree_child
然后在git_subtree_parent
中执行git subtree
会列出该指令的一些常见的参数:
首先需要给git_subtree_parent
添加一个子库git_subtree_child
:
第一步:添加子库的远程地址:
git remote add subtree-origin git@github.com:AhuntSun/git_subtree_child.git
添加完成后,父版本库中就有两个远程地址了:
这里的subtree-origin
就代表了远程仓库git_subtree_child
的地址。
第二步:建立依赖关系:
git subtree add --prefix=subtree subtree-origin master --squash
//其中的--prefix=subtree可以写成:--p subtree 或 --prefix subtree
该命令表示将远程地址为subtree-origin
的,子版本库上master
分支的,文件克隆到subtree
目录下;
注意:是在某一分支(如
master
)上将subtree-origin
代表的远程仓库的某一分支(如master
)作为子库拉取到subtree
文件夹中。可切换到其他分支重复上述操作,也就是说子库的实质就是子分支。
--squash
是可选参数,它的含义是合并,压缩的意思。
master
)中的提交一个一个地拉取到本地再去创建一个合并提交;拉取完成后,父版本库中会增添一个subtree
目录,里面是子库的文件,相当于把依赖的子库代码拉取到了本地:
此时查看一下父版本库的提交历史:
会发现其中没有子库李四的提交信息,这是因为--squash
参数将他的提交压缩为一次提交,并由父版本库张三进行合并和提交。所以父版本库多出了两次提交。
随后,我们在父版本库中进行一次推送:
结果远程仓库中多出了一个存放子版本库文件的subtree
目录,并且完全脱离了版本库git_subtree_child
,仅仅是属于父版本库git_subtree_parent
的一个目录。而不像使用submodule
那样,是一个点击就会自动跳转到依赖子库的指针:
subtree
的远程父版本库:submodule
的远程父版本库:即submodule
与subtree
子库的区别为:
在子库中创建一个新文件world
并推送到远程子库:
在父库中通过如下指令更新依赖的子库内容:
git subtree pull --prefix=subtree subtree-origin master --squash
此时查看一下提交历史:
发现没有子库李四的提交信息,这都是--squash
的作用。子库的修改交由父库来提交。
--squash
该参数的作用为:防止子库指定分支上的提交历史污染父版本库。比如在子库的master
分支上进行了三次提交分别为:a
、b
、c
,并推送到远程子库。
首先,复习一下合并分支时遵循的三方合并原则:
当提交4
和6
需要合并的时候,git
会先寻找二者的公共父提交节点,如图中的2
,然后在提交2
的基础上进行2
、4
、6
的三方合并,合并后得到提交7
。
父仓库执行pull
操作时:如果添加参数--squash
,就会把远程子库master
分支上的这三次提交合并为一次新的提交abc
;随后再与父仓库中子库的master
分支进行合并,又产生一次提交X
。整个pull
的过程一共产生了五次提交,如下图所示:
存在的问题:
由于--squash
指令的合并操作,会导致远程master
分支上的合并提交abc
与本地master
分支上的最新提交2
,找不到公共父节点,从而合并失败。同时push
操作也会出现额外的问题。
最佳实践:要么全部操作都使用--squash
指令,要么全部操作都不使用该参数,这样就不会出错。
错误示范:
为了验证,重新创建两个仓库A
和B
,并通过subtree
将B
设置为A
的子库。这次全程都没有使用参数--squash
,重复上述操作:
--squash
的情况下,将远程子库A
变化的文件拉取到本地:git subtree pull --prefix=subtree subtree-origin master
此时查看提交历史:
可以看到子库儿子
的提交信息污染了父版本库的提交信息,验证了上述的结论。
所以要么都使用该指令,要么都不使用才能避免错误;如果不需要子库的提交日志,推荐使用--squash
指令。
补充:
echo ‘new line‘ >> test.txt
:表示在test.txt
文件末尾追加文本new line
;如果是一个>
表示替换掉test.txt
内的全部内容。
subtree
的强大之处在于,它可以在父版本库中修改依赖的子版本库。以下为演示:
进入父版本库存放子库的subtree
目录,修改子库文件child.txt
,并推送到远程父仓库:
此时远程父版本库中存放子库文件的subtree
目录发生了变化,但是独立的远程子库git_subtree_child
并没有发生变化。
修改独立的远程子库:
可执行以下命令,同步地修改远程子版本库:
git subtree push --prefix=subtree subtree-origin master
如下图所示,父库中的子库文件child.txt
新增的child2
内容,同步到了独立的远程子库中:
修改独立的本地子库:
回到本地子库git_subtree_child
,将对应的远程子库进行的修改拉取到本地进行合并同步:
由此无论是远程的还是本地的子库都被修改了。
实际上使用
subtree
后,在外部看起来父仓库和子仓库是一个整体的仓库。执行clone
操作时,不会像submodule
那样需要遍历子库来单独克隆。而是可以将整个父仓库和它所依赖的子库当做一个整体进行克隆。
父版本库拉取远程子库进行更新同步会出现的问题:
子仓库第一次修改:
经历了上述操作,本地子库与远程子库的文件达到了同步,其中文件child.txt
的内容都是child~4
。在此基础上本地子库为该文件添加child5~6
:
然后推送到远程子库。
父仓库第一次拉取:
随后父版本库通过下述指令,拉取远程子库,与本地父仓库git_subtree_parent
中的子库进行同步:
git subtree pull --p subtree subtree-origin master --squash
结果出现了合并失败的情况:
我们查看冲突产生的文件:
发现父版本库中的子库与远程子库内容上并无冲突,但是却发生了冲突,这是为什么呢?
探究冲突产生的原因之前我们先解决冲突,先删除多余的内容:
随后执行git add
命令和git commit
命令标识解决了冲突:
解决完冲突后将该文件推送到独立的远程子库,发现文件并没有发生更新,也就是说git
认为我们并没有解决冲突:
子仓库第二次修改与父仓库第二次拉取:
再次修改本地子库的文件并推送到对应的远程仓库,父版本库再次将远程子库更新的文件拉取到本地进行同步:
这次却成功了!为什么同样的操作,有的时候成功有的时候失败呢?
原因出现在--squash
指令中。实际上,--squash
指令把子库中的提交信息合并了,导致父仓库在执行git pull
操作时找不到公共的父节点,从而导致即使文件没有冲突的内容,也会出现合并冲突的情况。其实不使用--squash
也会有这种问题,问题的根本原因仍然是三方合并时找不到公共父节点。我们打开gitk
:
从图中不难看出,当使用subtree
时,子库与父库之间是没有公共节点的,所以时常会因为找不到公共节点而出现合并冲突的情况,此时只需要解决冲突,手动合并即可。
不使用
subtree
时,普通的版本库中的各分支总会有一个公共节点:
再次强调:使用--squash
指令时一定要小心,要么都使用它,要么都不使用。
git subtree split
当开发过程中出现某些子库完全可以复用到其他项目中时,我们希望将它独立出来。
git subtree split
指令,该指令会把关于独立出来的子库的每次提交都记录起来。但是,这样存在弊端:
company.util
,当一次提交同时修改了company.util
和company.server
两个子库时。util
只会记录对自身修改的提交,而不会记录对company.server
的修改,这样在别人看来这次提交就只修改了util
,这是不完整的。以上就是本讲的全部内容,主要介绍了
git
子库的基本使用方法。下一讲将是Git
应用详解系列的完结篇:Git
工作流Gitflow
。我们下一讲再见!
Git应用详解第十讲:Git子库:submodule与subtree
标签:解决 新版本 child 复用 基本使用 reac code 嵌套 abc
原文地址:https://www.cnblogs.com/AhuntSun-blog/p/12736934.html