git submodule 的使用

Question

开发过程中，经常会有一些通用的部分希望抽取出来做成一个公共库来提供给别的工程来使用，而公共代码库的版本管理是个麻烦的事情。而且一旦更新了就要同步到多个引用的系统中，这个时候使用 git submodule ，然后执行：git submodule update 就全部搞定了。

下面就以 Android 开发为例，讲述下 submodule 的具体用法。

假设一个 Android Demo 的目录是这样的：app, extras。其中 app 是程序的主要目录，extras 目录是引用的一些 library， 比如程序中引用了 volley 的 library。

添加

为当前工程添加 submodule，命令如下：

git submodule add 仓库地址 路径
即
git submodule add  https://android.googlesource.com/platform/frameworks/volley  extras

命令执行完成，会在当前工程根路径下生成一个名为 .gitmodules 的文件，其中记录了子模块的信息。添加完成以后，再将子模块所在的文件夹添加到工程中即可。

更新

如果过了一段时间 volley 库有更新，这时候我们的 app 也需要更新，命令如下：

git submodule update

删除

ubmodule 的删除稍微麻烦点：首先，要在 .gitmodules 文件中删除相应配置信息。然后，执行 git rm –cached 命令将子模块所在的文件从 git 中删除。

下载的工程带有 submodule

当使用 git clone 下来的工程中带有 submodule 时，初始的时候，submodule 的内容并不会自动下载下来的，此时，只需执行如下命令：

git submodule update --init --recursive

即可将子模块内容下载下来后工程才不会缺少相应的文件。