文章目录
Git Submodule 介绍和使用指南
Git submodule（子模块）是 Git 中的一个功能，允许你将一个 Git 仓库作为另一个 Git 仓库的子目录。这在你需要将一个项目作为另一个项目的依赖项，同时又想保持它们作为独立项目时非常有用。
什么是 Git Submodule
Git submodule 允许你将一个仓库嵌入到另一个仓库中作为子目录。子模块保持自己的提交历史、分支和标签，与主项目分离但又与之关联。
使用场景
- 项目依赖第三方库，但需要对该库进行特定修改
- 将大项目拆分为多个独立但又关联的仓库
- 共享代码库被多个项目使用
基本操作
添加子模块
git submodule add <repository_url> <path>
例如：
git submodule add https://github.com/example/lib.git libs/mylib
这会在项目中创建一个 .gitmodules 文件，记录子模块信息。
克隆包含子模块的项目
git clone <repository_url>
git submodule init
git submodule update
或者使用组合命令：
git clone --recurse-submodules <repository_url>
更新子模块
git submodule update --remote
这会获取子模块的最新提交并更新父项目中记录的提交ID。
进入子模块
cd <submodule_path>
然后你就可以像操作普通 Git 仓库一样操作子模块。
更新父项目中的子模块引用
当子模块有更新时，需要在父项目中提交新的子模块引用：
git add <submodule_path>
git commit -m "Update submodule to latest version"
高级用法
递归子模块
git submodule update --init --recursive
删除子模块
- 删除
.gitmodules中的相关条目 - 删除
.git/config中的相关条目 - 执行：
git rm --cached <submodule_path> rm -rf <submodule_path> rm -rf .git/modules/<submodule_name>
注意事项
- 子模块是固定指向特定提交的，不是跟踪分支
- 克隆主项目时默认不包含子模块内容
- 修改子模块后需要在主项目中提交引用变更
- 子模块中的更改需要先在子模块中提交，然后在主项目中更新引用
替代方案
在某些情况下，可以考虑以下替代方案：
- Git subtree（将子项目代码合并到主项目中）
- 包管理器（如 npm、pip 等）
- 依赖管理系统（如 Composer、Cargo 等）
选择 submodule 还是其他方案取决于项目的具体需求和团队的工作流程。