git submodule子模块添加、使用、删除指令介绍…

项目中经常使用别人维护的模块，在git中使用子模块的功能能够大大提高开发效率。使用子模块后，不必负责子模块的维护，只需要在必要的时候同步更新子模块即可。

子模块添加

子模块添加命令如下：

1
git submodule add <url> <path>

其中，url为子模块的下载地址，path为该子模块存储的目录路径。

注意：目录路径不能以/结尾（会造成修改不生效）、不能是现有工程已有的目录（不能順利 Clone）

执行成功后，git status会看到项目中修改了.gitmodules，并增加了一个新文件。

查看修改内容可以看到增加了子模块，并且新文件下为子模块的提交hash摘要:

1
git diff --cached

再使用git commit提交添加的子模块

子模块的clone

git clone项目后，默认子模块下无任何内容，需要在项目根目录执行如下命令完成子模块的下载：

1
2
3
4
5
6
7
8
git submodule update --remote # 获取子模块的所有commit，防止后续出现游离节点。
git pull # clone主工程

# 更新子模块
git submodule init
git submodule update
或使用
git submodule update --init --recursive

如果不想使用多条指令，在克隆新项目时，使用以下指令：

1
git clone --recurse-submodules <项目路径>

子模块pull

子模块的维护者提交了更新后，使用子模块的项目必须手动更新才能包含最新的提交。

在项目中，进入到子模块目录下，执行git pull更新，git log查看相应提交。

完成后返回到主项目目录，可以看到子模块有待提交的更新，使用git add，提交子模块更新后的状态即可。

删除子模块

如果子模块的项目维护地址发生了变化，或者需要替换子模块，需要删除原有的子模块。
删除子模块较复杂，步骤如下：

  1. rm -rf <子模块目录> 删除子模块目录及源码, 或者直接删除文件夹；
  2. 编辑 .gitmodules，删除项目目录下.gitmodules文件中子模块相关条目；
  3. 编辑.git/config，删除配置项中子模块相关条目；
  4. rm .git/module/*，删除模块下的子模块目录，每个子模块对应一个目录，注意只删除对应的子模块目录即可;

执行以上命令后，再执行添加子模块命令即可，如果仍然报错，执行如下：

1
git rm -r --cached <子模块目录>

完成删除后，提交到仓库即可。

修改子模块url

1.手动修改.gitmodules文件

1
2
3
[submodule "demo"]
    path = demo
    url = newURL

2.命令行立即生效

1
2
git submodule sync
git submodule update --init

如果存在无法同步的commit，则：

1
2
3
4
cd demo/
git fetch --all
git checkout main
git reset --hard origin/main