git submodule的在项目依赖中的使用

868 阅读2分钟

在依赖库的管理上,每种编程语言都会有自己独特的包管理机制,例如golang的mod管理。

其实还有一种更通用的,与语言无关的管理方式——git submodule 子模块管理。

这里假设项目D,为其它多项目 项目A项目B等所依赖,则可以使用git submodule来实现项目A项目B项目D的依赖管理,实现如下关系图:

创建子模块依赖

为项目创建子模块,只需一条简单指令。例如,为项目A增加项目D子模块:

git submodule add <项目D git 仓库地址> <项目A映射子目录>

设置子模块依赖版本

子模块作为一个独立项目,其版本管理也是独立的。项目A最终依赖于项目D的某一个版本,要实现版本绑定,可以按如下步骤操作:

cd <项目A映射子目录>
git checkout <commit hash 1>
cd <项目A目录>
git add <项目A映射子目录>
git commit <...>

经过如上的绑定,项目A 就绑定了 项目Dcommit hash 1这个版本。

删除子模块依赖

有时候,项目变化,可能需要解除子模块的绑定,例如要删除 项目A 对项目D的子模块依赖,可以按照如下步骤操作:

git rm --cached <项目A映射子模块>
rm -rf <项目A映射子模块>
vi .gitmodules # 删除.gitmodules中关于项目D的子模块描述项
vim .git/config # 删除.git/config中关于项目D的子模块描述项
rm -rf .git/module/<项目A映射子模块>

如此即可以彻底删除 项目A中的项目D相关的子模块依赖信息。

总结

git submodule实现项目依赖如此简单,以至于小编在项目中,忍不住大量使用,特别是私库的依赖管理。

希望大家也能尝试,亲身体会它简单的设计思路和丝滑用法。