Git子模块Submodule操作

什么是submodule?

官方的解释:

 

顾名思义就是一个项目的子项目,相当于项目中的一个文件夹,里面又是一个独立的项目,这个项目专门用来作为父项目的依赖/库使用

submodule的使用

克隆含有子模块的项目

 通常我们都是clone公司的项目下来后跑不起来,就是缺少了submodule,然而clone父项目下来后submodule只是一个空的文件夹

 此时我们需要运行两个命令:

1.初始化本地配置文件(.gitmodules文件,这个文件记录了父项目中子模块的路径和url信息)

git submodule init

 2.从该项目中抓取所有数据并检出父项目中列出的合适的提交(大白话说就是拉取子项目,执行完这句原本空文件夹的子模块目录就有东西了)

git submodule update

以上简写的合并写法:

git submodule update --init

如果子模块中又有嵌套的子模块,则加上--recursive参数递归检出所有子模块的及它的嵌套子模块:

git submodule update --init --recursive

当然官方还给出了更简单的方式,即在clone父项目的时候同时初始化所有下面的子模块:

 也就是在clone父项目的时候加上--recurse-submodules:

git clone --recurse-submodules 你的父项目git地址

为自己的项目添加子模块

除了最常用的怎么拉取子模块之外,有时我们可能想自己给项目添加子模块做为依赖库使用,那么我们就要了解一下如何给项目添加子模块了

首先子模块也是一个独立的项目,它有自己对应的git仓库地址,所以我们只需要提前在GitHub上建好子模块仓库然后添加到父项目就可以了,下面是官方的说明:

 添加子模块的命令:

git submodule add 子模块的git仓库地址

添加的时候注意当前所处的文件夹路径,在哪个文件夹下执行的命令它就会在哪个文件夹下创建和子模块仓库同名的文件夹目录,如果想自己创建在别的位置可以在命令后面自己指定存放路径

执行完后执行git status会发现除了新增了一个子模块文件夹之外项目的根目录下还多出了一个.gitmodules文件,没错这个文件就是上面初始化的配置文件,里面记录了项目子模块的文件夹路径和git仓库url地址,方便以后clone项目时检出子模块

.gitmodules文件类似这个内容格式:

[submodule "xxx"]
	path = xxx
	url = https://github.com/user/xxx

如果项目添加了多个子模块,这里就会生成多条记录,该文件也像 .gitignore 文件一样受到（通过）版本控制。 它会和该项目的其他部分一同被拉取推送(提交)。 这就是克隆该项目的人知道去哪获得子模块的原因。

NOTE:我们看一段官方原话:

 我对其的理解(仅是我的理解,如有错望指出):submodule不会受到git的追踪,提交时git只会将它视为一个子模块,不会追踪它的具体内容