Git submodule - Git子模块简介

目录

1. 建立仓库
   1.1 创建主仓库
   1.2 创建子仓库
2. 提交内容
   2.1 提交到主工程的仓库
   2.2 提交到子模块的仓库
3. 克隆带子模块的仓库到本地
4. 更新子仓库
5. 总结
6. 参考文档

正文

软件开发中有一个DRY(Don’t Repeat yourself)原则，或者说DIE(Duplication Is Evil)原则，指的是尽可能减少一切重复工作，重用一切可能重用的东西，小到提取重复性代码，大到重用一个模块。时间就是金钱，效率就是生命。
使用Git管理项目的时候，如果涉及到模块重用，比如你需要用到别的仓库提供的功能，虽然你可以直接把别人仓库（当然也可以是自己的仓库）的代码复制到你的工程目录下，但是这样当别的仓库更新了，我们也想相应的更新我们所依赖的代码，或者我们对依赖的代码做了些更改想要合并到原仓库，这时候事情就比较麻烦了。所以，我们希望主模块和子模块的的管理是分开的，也就是主模块的更改、提交等，是不涉及子模块的，反过来子模块也一样。但是又希望他们之间有一个依赖关系，怎么办呢？
Git为了这种困境提供了一个解决方案：子模块（submodule）。
为了便于理解，我们把当前工作工程仓库成为主仓库，主仓库所依赖的子模块仓库成为子仓库。

建立仓库

创建主仓库

mkdir demo && cd demo && git init

创建子仓库

创建子仓库用到的命令是git submodule add <repo> [<path>]。其中repo是你要添加为子模块的仓库URL，path是主工程下的一个路径，就相当与你在主工程下创建的一个专门用于保存子仓库代码的文件夹，名字是任意的，只不过习惯上用third_party利于区分和理解。例如我们将pybind11添加为子模块，其相对路径为third_party/pybind11，我们可以使用以下命令：

git submodule add https://github.com/pybind/pybind11 third_party/pybind11

值得注意的是，pybind11这个目录在在使用命令前是不能存在与third_party目录之下的。并且，此命令执行完成以后，子仓库的代码就被拉取到third_party/pybind11之中了。

提交内容

主仓库和子仓库之间，除了子仓库位于主仓库内，主仓库对子仓库的代码有所依赖以外，他们之间是没有其他任何联系的。他们呢就相当于两个仓库，主仓库不会跟踪子仓库内容的变化，反过来子仓库也不去跟踪子仓库的任何信息。就类似古代周边某些附属小国，虽然名面上朝贡、附属，但实际上小国的治理和天朝是分开的。

提交到主工程的仓库

对主工程内容的提交操作，与一般无子工程的仓库操作并无二致。

提交到子模块的仓库

如果有需要对子模块的内容进行修改并提交到其仓库，可以进入到子模块仓库所在目录，再进行相应的操作。例如，我们使用cd third_party/pybind11进入到子模块仓库，这时候我们可以使用git add, git commit等对更改进行操作，这些操作之对子模块仓库产生影响。

克隆带子模块的仓库到本地

当我们需要克隆一个带子仓库的仓库时，我们希望子仓库的内容也是跟主仓库一起保存在本地的。当使用git clone xxxx.git将主仓库克隆到本地后，子仓库所在目录只有一个空目录，子仓库内容其实并为下载到本地。有两种方法：

1. 在克隆主仓库时加上--recurse-submodules，使用这种方法，子仓库内容也会同时下载下来，如果子仓库还包含子仓库，也会被同时下载下来。

git clone xxxx.git --recurse-submodules

2. 第二种方法是使用下面两条命令：

git submodule init
git submodule update

值得注意的是，不管使用以上那两种方法，子仓库的内容虽然下载下来了，但是此时子仓库的状态是处于一种HEAD detached的状态，也就是此时，你对子仓库的更改，就算你已经commit但是当你下次使用git submodule update你所作的更改也会丢失。所以，你学要checkout`到一个工作分支，例如：

git checkout master

更新子仓库

更新子仓库内容有两种方法，一种是进入到子仓库所在目录，进行常规的拉取和合并操作；

cd ./third_party/pybind11 
git fecth 
git merge

另一种是使用git submodule update --remote：

git submodule update --remote 
git submodule update --remote <submodule ame>

两条命令的区别是，如果不带子仓库名，默认会更新所有子仓库，如果只想更新其中某个，需要指定需要更新的子仓库名。

总结

对于带子仓库的仓库，有两种情况：

1. 本地新建仓库，需要建立与远程子仓库的依赖关系；
2. 克隆已有带子仓库的仓库到本地。
   第一种情况：

git submodule add <repo> [<path>]

第二种情况：

git submodule init [<path>]
git submodule update
git checkout <branch>

至此，依赖关系建立起来了，两个仓库之间便可以独自操作。
可以使用git add, git commit, git status等各自操作。一句话，说的底盘听水的：在主仓库目录下，操作的是主仓库内容；cd third_party/sumdir进入到子仓库，操作的便是子仓库内容。

References

1. Git-Tools-Submodules
2. Manual: man git submodule

本文首发于个人公众号TensorBoy。如果你觉得内容还不错，欢迎分享并关注我的公众号TensorBoy，扫描下方二维码获取更多精彩原创内容！