子模块设置

背景信息

子模块（submodule）是Git为管理仓库共用而衍生出的一个工具，通过子模块您可以将公共仓库作为子目录包含到您的仓库中，并能够双向同步该公共仓库的代码，借助子模块您能将公共仓库隔离、复用，能随时拉取最新代码以及对它提交修复，能大大提高您的团队效率。

有种情况经常会遇到：某个工作中的项目A需要包含并使用项目B（第三方库，或者你独立开发的，用于多个父项目的库），如果想要把它们当做两个独立的项目，同时又想在项目A中使用项目B，可以使用Git的子模块功能。 子模块允许您将一个Git仓库作为另一个Git仓库的子目录。 它能让你将另一个仓库克隆到自己的项目中，同时还保持提交的独立。

子模块将被记录在一个名叫“.gitmodules”的文件中，其中会记录子模块的信息：

[submodule "module_name"]      #子模块名称
path = file_path               #子模块在本仓库（父仓）中文件的存储路径。
url = repo_url                 #子模块（子仓库）的远程仓地址

这时，位于“file_path”目录下的源代码，将会来自“repo_url”。

控制台操作

• 控制台添加子模块
  • 入口一：

    可以在仓库文件列表中的某个文件夹下添加子模块。

    单击扩展按钮，选择“新建子模块”，如下图所示。

    

  • 入口二：

    可以在仓库的“代码”页签中，添加子模块。

    单击扩展按钮，选择“新建子模块”，如下图所示。

    

  • 入口三：

    可以在仓库设置中，为仓库创建子模块。

    其操作路径为“设置 > 仓库管理 > 子模块设置 > 新建子模块”。

  • 填写说明：

    使用以上三种方法均可进入“新建子模块”页面。

    请参考下表填写，完成后单击“确定”按钮，即可完成新建子仓库操作。

    表1 新建子模块—字段说明

    字段	填写说明
    子模块仓库路径	选择一个仓库作为子仓库。
    子模块仓库分支	选择同步子仓库的目标分支到父仓库。
    子模块文件路径	配置子模块文件在本仓库下的路径，注意用“/”分割层级。
    提交信息	作为您新建子仓库的备注信息，可以在文件历史中查找到本次操作，限制2000个字符。

    

    子模块新建完成后，可以在仓库文件列表的对应目录内找到子模块（子仓库）内容，其对应的文件左侧图标为。

Git客户端操作

1. 添加Submodule。

   git submodule add <repo> [<dir>] [-b <branch>] [<path>]

   示例：

   git submodule add git@***.***.com:****/WEB-INF.git

2. 拉取包含submodule的仓库。

   git clone <repo> [<dir>] --recursive

   示例：

   git clone git@***.***.com:****/WEB-INF.git --recursive

3. 获取远端Submodule更新。

   git submodule update --remote

4. 推送更新到子库。

   git push --recurse-submodules=check

5. 删除Submodule。
   1. 删除“.gitsubmodule”中对应submodule的条目。
   2. 删除“.git/config”中对应submodule的条目。
   3. 执行命令，删除子模块对应的文件夹。

      git rm --cached {submodule_path}    #注意更换为您的子模块路径

      

      注意：路径不要加后面的“/”。

      示例：你的submodule保存在“src/main/webapp/WEB-INF/”目录，则执行命令为：

      git rm --cached src/main/webapp/WEB-INF