git管理子模块

git管理子模块

git管理子模块

当项目越来越庞大之后，不可避免的要拆分成多个子模块，我们希望各个子模块有独立的版本管理，并且由专门的人去维护，这时候我们就要用到git的submodule/subtree功能。

sumodule是引用，subtree是复制

/	submodule	subtree	结果
远程仓库空间占用	submodule只是引用，基本不占用额外空间	子模块copy，会占用较大的额外空间	submodule占用空间较小，略优
本地空间占用	可根据需要下载	会下载整个项目	所有模块基本都要下载，二者差异不大
仓库克隆	克降后所有子模块为空，需要注册及更新，同时更新后还需切换分支	克隆之后即可使用	submodule步骤略多，subtree占优
更新本地仓库	更新后所有子模块后指向最后一次提交，更新后需要重新切回分支，所有子模块只需一条更新语句即可	所有子模块需要单独更新	各有优劣，相对subtree更好用一些
提交本地修改	只需关心子模块即可，子模块的所有操作与普通git项目相同	提交执行命令相对复杂一些	submodule操作更简单，submodule占优

submodule

常用命令

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

创建带子模块的项目

例如我们要创建如下结构的项目

project
  |--moduleA
  |--readme.txt

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

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

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

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

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

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

使用git status可以看到多了两个需要提交的文件：.gitmodules和moduleA。使用git diff可以看到这两项的内容。这里需要指出父项目的git并不会记录submodule的文件变动，它是按照commit id指定submodule的git header，所以.gitmodules和moduleA这两项是需要提交到父项目的远程仓库的。

On branch master
Your branch is up-to-date with 'origin/master'.
Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)
    new file:   .gitmodules  # 指定submodule的主要信息，包括子模块的路径和地址信息
    new file:   moduleA  # 指定了子模块的commit id

克隆带子模块的项目

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

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

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

git clone project.git project --recursive

项目中修改子模块

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

# 进入子模块进行修改提交
cd project/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
cd ..

项目中获取子模块

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

cd project/moduleA
git checkout master

方法一：子模块更新

cd project/moduleA
git pull

方法二：主目录更新

cd project
git submodule foreach git pull

项目中删除子模块

删除缓存和文件夹

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

删除配置信息

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

然后提交到远程服务器

git add .
git commit -m "remove submodule"

subtree