使用 Git Submodule 管理微服务项目：从繁琐到高效 - 指南

使用 Git Submodule 管理微服务项目：从繁琐到高效

1、引言

在微服务架构盛行的今天，即使是中小型项目，也往往包含多个独立服务。传统的管理方式下，开发者需要逐个克隆微服务仓库，并手动维护构建顺序，这一过程既耗时又容易出错。

过去，我曾尝试用 Golang 编写一个跨平台的批量拉取工具来解决这个问题，虽然功能上确实减轻了部分负担，但仍然带来了额外的维护成本和学习成本。相比之下，Git Submodule 提供了更优雅的原生解决方案，它能帮助我们集中化、自动化地管理微服务项目，从而极大提升团队协作效率。

2、Git Submodule 核心概念

Git Submodule 是 Git 提供的一项功能，允许在一个 Git 仓库中嵌入其他仓库（作为子目录存在）。这样每个子模块（微服务）既能独立维护版本历史和分支，又能与主项目保持紧密的关联。

与传统管理方式的对比：

• 传统方式：10 个微服务需要 10 次克隆操作，还要手动维护构建顺序；
• Submodule 方式：只需一次克隆操作即可获取全部微服务，构建顺序可通过主仓库的构建文件（如 Maven POM）自动管理。

3、实操指南

3.1、初始化主项目并添加微服务子模块

1. 创建主项目目录

mkdir gitsubmodule-demo-main
cd gitsubmodule-demo-main
git init

2. 添加微服务子模块

git submodule add https://gitee.com/kennylee/gitsubmodule-demo-parents.git parent
git submodule add https://gitee.com/kennylee/gitsubmodule-demo-user-service.git user
git submodule add https://gitee.com/kennylee/gitsubmodule-demo-order-service.git order
git submodule add https://gitee.com/kennylee/gitsubmodule-demo-common.git common

3. 提交配置并推送

git commit -m "添加微服务子模块"
git remote add origin git@gitee.com:kennylee/gitsubmodule-demo-main.git
git push --set-upstream origin main

执行以上命令后，Git 会创建 .gitmodules 文件，记录每个子模块的路径和对应的仓库URL。

3.2、一键克隆完整项目

团队成员获取代码时，只需一条命令即可克隆所有微服务：

# 克隆主项目及所有子模块（微服务）并且切换到master分支
git clone --recursive https://gitee.com/kennylee/gitsubmodule-demo-main.git
cd gitsubmodule-demo-main
# 统一切换子模块的分支master
git submodule foreach --recursive 'git checkout master'
# 全部子项目拉取最新代码
git submodule foreach --recursive 'git pull'