Git Submodule简单使用

[TOC]

Git Submodule

近期用到了这个命令，主要是为了实现在一个git仓库中，引入其他git仓库，这种适用于你想在主工程中引入其他library库，主工程以submodule的形式包含子工程，子工程可以有自己的git操作，比如commit、push、rebase等。

这里笔者用一个实际的例子来介绍这个命令的使用，不知道大家有没有在原生工程嵌入React Native？熟悉React Native工程的同学会知道有个一个android工程，如下图：

android submodule

你会发现下面还会有一个iOS工程，我们客户端开发一般都会各自维护一个git仓库，为了让Android跟iOS不在同一个工程提交commit，主要是为了方便维护，所以就想着怎么在RN工程中引入Android工程和iOS工程，明白我们的需求之后，我们知道git中有submodule的操作，所以下面直接实操吧。

添加submodule工程

git submodule add http://git.code.oa.com/TCW/Crowdsource-android.git android

执行完这条命令之后，通过git status，可以看到变更信息：

On branch master
Your branch is up-to-date with 'origin/master'.
Changes to be committed:
  (use "git reset HEAD ..." to unstage)

    new file:   .gitmodules
    new file:   android

然后添加子模块：

git add .getmodules android
git commit -m "add android submodule."
git submodule init

ok，到这里你成功添加了一个submodule.

修改Submodule

进入submodule.

cd android

我这里的submodule是android.

这时我修改了android工程里面的内容，git status一下：

modify submodule

提交submodule的内容到远程：

git add .
git commit -m "嵌入React Native"
git push

提交后，看下Submodule在主工程中的变更：

cd ..
git status

如下图：

modify submodule

这时候，提交主工程的变更：

git add .
git commit -m "update android submodule"
git push

ok，这里已经成功修改了submodule.

更新Submodule

这里有个问题，你在自己机器完成了submodule的添加和修改，那其他同学想更新怎么办？

在主工程根目录运行以下命令：

git submodule foreach git pull

还需要更新下submodule:

cd android
git pull

ok，这样其他团队成员就能拉到最新的工程代码啦。

总结

关于如何在RN工程中通过submodule方式引入android工程已经大致实操了一遍，还有clone submodule和remove submodule的操作就不演示了，可以参考下面提供的链接。

更多参考

使用Git Submodule管理子模块