Git在已有的项目中引入Submodule子模块管理：添加、更新、删除（实战示例代码）

一时失言乱红尘 2023-10-15 21:16 4阅读 0赞

### 前言 ###

在进行Git版本控制的过程中，有时候我们需要在已有的项目中引入子模块，以便复用其他独立的Git存储库的代码或文件。本文将详细介绍如何在已有项目下添加、更新和删除Git的Submodule子模块，并提供相关的示例代码。

### 实战场景 ###

假设我们已经有一个主项目（my-main-project）的Git存储库，并且需要在该项目中创建一个名为devices的文件夹，并引入两个子模块module1和module2。

### 一、添加子模块 ###

首先，进入my-main-project目录，在命令行或终端中执行以下命令来添加子模块。其中，`URL-to-module1`和`URL-to-module2`是指module1和module2的Git存储库的URL地址。

cd my-main-project
    git submodule add <URL-to-module1> devices/module1
    git submodule add <URL-to-module2> devices/module2

添加后，Git会自动为子模块创建一个独立的目录，并从远程仓库中克隆子模块的代码到这个目录中。

### 二、提交子模块 ###

添加完子模块后，需要将这些修改提交到主项目的Git存储库中。执行以下命令：

git commit -m "Add submodule: module1 and module2"

这将把子模块的修改作为一个提交记录添加到主项目的版本历史中。  
提交完不要忘了合并到主分支上，要不然其他项目开发人员更新不到子模块。这里LZ是`master`提交的子模块，所以pull最新的代码，push上去即可

git pull origin master
    git push origin master

### 三、更新子模块 ###

在其他开发人员克隆主项目之后，他们需要执行一些额外的步骤来初始化和更新子模块。他们可以通过以下命令完成初始化和更新子模块：

git submodule init
    git submodule update

这将初始化子模块并将其拉取到本地。

### 四、删除子模块 ###

在某些情况下，我们可能需要删除不再需要的子模块。要删除子模块，可以执行以下步骤：

1.  删除主项目的`.gitmodules`文件中子模块的相关条目，删除所有的子模块的话，整个`.gitmodules`文件删掉即可，否则会报错。
2.  删除主项目的`.git/config` 删除配置项中子模块相关条目。
3.  删除主项目的`.git/module/*`删除模块下的子模块目录，每个子模块对应一个目录，注意只删除对应的子模块目录即可
4.  删除子模块的目录及其内容。在以上的示例中，删除`devices`文件夹下要删除的子模块目录，如果删除所有子模块，那整个文件夹都删除。
5.  执行1-4步骤后，再执行添加子模块命令时候，如果仍然报错，执行如下命令删除暂存区下主项目的.git目录中与子模块相关的条目

#删除主项目的.git目录中与子模块相关的条目：git rm --cached 子模块名称
    git rm --cached devices/module1
    git rm --cached devices/module2

再次提交这些修改：

git commit -m "Remove submodule: module1 and module2"

这样就可以彻底删除主项目中的子模块，提交完不要忘了合并到主分支上。

### 五、注意事项 ###

在使用Git的Submodule子模块时，请注意以下事项：

*  子模块的修改不会自动反映到主项目中。如果需要引入子模块的新版本，需要手动更新子模块。
 *  不要直接在子模块目录中进行修改和提交，应该进入子模块的目录，在子模块的上下文中进行修改和提交。
 *  克隆主项目时，如果子模块的URL是使用SSH协议的，而且你缺乏对应的SSH密钥，那么克隆可能会失败。这时候，你可以使用HTTPS协议的URL来克隆主项目。

### 总结 ###

在本文中，LZ讲解了我们如何在已有的Git项目中添加、提交、更新和删除Submodule子模块。使用示例代码演示了在已有项目中添加devices文件夹，并引入两个子模块module1和module2的过程。还介绍了如何提交这些修改到主项目中，以及其他开发人员如何初始化和更新子模块。最后，我们学习了如何删除不再需要的子模块。