git submodule 模块化管理

Git Submodule 是 Git 版本控制系统中的一项功能，它允许你将一个 Git 仓库嵌套在另一个仓库中。通过使用 Submodule，你可以在一个仓库中引入其他仓库的特定版本，同时保留这些子模块的独立性。

1、添加并初始化 Submodule

a、添加 Submodule

将一个仓库作为子模块添加到另一个仓库中命令（ git submodule add ），如将一个名为 submodule-repo 的仓库作为子模块添加进来

## <submodule-repo-url> 是子模块仓库的 URL，
## <submodule-path> 是子模块在主仓库中的路径

git submodule add <submodule-repo-url> <submodule-path>

b、初始化 Submodule

当克隆主仓库时，子模块的内容并不会自动初始化和更新，需要手动执行命令完成初始化。在主仓库的根目录下，运行以下命令来初始化子模块

## 初始化子模块
git submodule init

## 更新子模块，也可以 后缀 --init 一并执行
git submodule update

2、生成的 .gitmodules 文件

该文件位于主仓库的根目录下，用于存储子模块相关信息的文件。当使用 Git Submodule 时，.gitmodules 文件用于记录子模块的仓库地址、路径和其他配置信息。

每个子模块的配置以 [submodule "<子模块路径>"] 开头，并在下面列出相关的配置项。

[submodule "submodule1"]
	path = submodule1
	url = https://github.com/example/submodule1.git
	
[submodule "submodule2"]
	path = submodule2
	url = https://github.com/example/submodule2.git

ps：如果你对 .gitmodules 文件进行了修改，需要执行 git submodule sync 命令来同步主仓库和子模块之间的变更，否则变更的文件不会生效

3、修改 .gitmodules 配置信息

当需要修改子模块的配置时，可以按照以下步骤进行操作：

a、打开主仓库中的 .gitmodules 文件。

b、找到你想要修改的子模块的配置部分。每个子模块的配置以 [submodule "<子模块路径>"] 开头。

c、根据需要修改子模块的配置项。你可以修改子模块的路径（path）、远程仓库地址（url）或其他相关配置。

d、保存 .gitmodules 文件。

e、执行 git submodule sync 命令，将主仓库和子模块之间的变更同步起来。

在修改 .gitmodules 文件后，需要执行 git submodule sync 命令确保正确地同步主仓库和子模块之间的变更。

另外，如果你只是想更新子模块的代码，而不是修改其配置信息，你可以直接进入子模块的目录，执行相应的 Git 命令来更新子模块，而无需修改 .gitmodules 文件。

4、优缺点总结

将不同的代码仓库嵌套到主仓库中，使得项目可以更好地组织和管理，每个子模块可以有自己的开发团队，可以独立地进行开发、测试和维护，从而提高团队的协作效率。同时Git Submodule 使用会让项目变的相对复杂，需要额外的命令和操作来管理子模块，当主仓库依赖多个子模块时，子模块之间的依赖关系可能会变得复杂。如果子模块之间存在依赖冲突或版本不兼容的情况，可能需要进行额外的调试和解决冲突的工作。