Git Submodule管理项目子模块

使用场景

当项目愈来愈庞大以后，不可避免的要拆分红多个子模块，咱们但愿各个子模块有独立的版本管理，而且由专门的人去维护，这时候咱们就要用到git的submodule功能。

经常使用命令

git clone <repository> --recursive 递归的方式克隆整个项目
git submodule add <repository> <path> 添加子模块
git submodule init 初始化子模块
git submodule update 更新子模块
git submodule foreach git pull 拉取全部子模块

如何使用

1. 建立带子模块的版本库

例如咱们要建立以下结构的项目

project
  |--moduleA
  |--readme.txt

建立project版本库，并提交readme.txt文件

git init --bare project.git
git clone project.git project1
cd project1
echo "This is a project." > readme.txt
git add .
git commit -m "add readme.txt"
git push origin master

建立moduleA版本库，并提交a.txt文件

git init --bare moduleA.git
git clone moduleA.git moduleA1
cd moduleA1
echo "This is a submodule." > a.txt
git add .
git commit -m "add a.txt"
git push origin master

在project项目中引入子模块moduleA，并提交子模块信息

cd project1
git submodule add ../moduleA.git moduleA
git status
git diff
git add .
git commit -m "add submodule"
git push origin master

使用git status能够看到多了两个须要提交的文件，其中.gitmodules指定submodule的主要信息，包括子模块的路径和地址信息，moduleA指定了子模块的commit id，使用git diff能够看到这两项的内容。

这里须要指出父项目的git并不会记录submodule的文件变更，它是按照commit id指定submodule的git header，因此.gitmodules和moduleA这两项是须要提交到父项目的远程仓库的。

2. 克隆带子模块的版本库

方法一，先clone父项目，再初始化submodule，最后更新submodule，初始化只须要作一次，以后每次只须要直接update就能够了，须要注意submodule默认是不在任何分支上的，它指向父项目存储的submodule commit id。

git clone project.git project2
cd project2
git submodule init
git submodule update

方法二，采用递归参数--recursive，须要注意一样submodule默认是不在任何分支上的，它指向父项目存储的submodule commit id。

git clone project.git project3 --recursive

3. 修改子模块

修改子模块以后只对子模块的版本库产生影响，对父项目的版本库不会产生任何影响，若是父项目须要用到最新的子模块代码，咱们须要更新父项目中submodule commit id，默认的咱们使用git status就能够看到父项目中submodule commit id已经改变了，咱们只须要再次提交就能够了。

cd project1/moduleA
git branch
echo "This is a submodule." > b.txt
git add .
git commit -m "add b.txt"
git push origin master
cd ..
git status
git diff
git add .
git commit -m "update submodule add b.txt"
git push origin master

4. 更新子模块

更新子模块的时候要注意子模块的分支默认不是master。

方法一，先pull父项目，而后执行git submodule update，注意moduleA的分支始终不是master。

cd project2
git pull
git submodule update

方法二，先进入子模块，而后切换到须要的分支，这里是master分支，而后对子模块pull，这种方法会改变子模块的分支。

cd project3/moduleA
git checkout master
cd ..
git submodule foreach git pull

5. 删除子模块

网上有好多用的是下面这种方法

git rm --cached moduleA
rm -rf moduleA
rm .gitmodules
vim .git/config

删除submodule相关的内容，例以下面的内容

[submodule "moduleA"]
      url = /Users/nick/dev/nick-doc/testGitSubmodule/moduleA.git

而后提交到远程服务器

git add .
git commit -m "remove submodule"

可是我本身本地实验的时候，发现用下面的方式也能够，服务器记录的是.gitmodules和moduleA，本地只要用git的删除命令删除moduleA，再用git status查看状态就会发现.gitmodules和moduleA这两项都已经改变了，至于.git/config，仍会记录submodule信息，可是本地使用也没发现有什么影响，若是从新从服务器克隆则.git/config中不会有submodule信息。

git rm moduleA
git status
git commit -m "remove submodule"
git push origin master

更多参考