Git submodule重复问题：多模块引用下如何避免utils重复？

问题背景 #

我有4个Git项目：utils、tool_a、tool_b、main_app。其中tool_a、tool_b、main_app都把utils作为submodule使用。现在我想在main_app里添加tool_a和tool_b作为submodule，这会导致utils模块被重复引入3次。同时我需要tool_a和tool_b能作为独立项目运行（必须包含utils），请问有没有办法避免utils模块重复？

针对这个问题，有几个实用的解决思路：

1. 共享子模块目录，修改.gitmodules配置 #

在main_app环境下让所有utils共享同一份目录，同时保留tool_a/tool_b独立运行时的子模块依赖：

• 先在main_app中保留原本的utils子模块，路径设为./utils
• 添加tool_a子模块：git submodule add --name tool_a <tool_a仓库地址> ./tool_a
• 进入tool_a目录，移除自带的utils子模块：git submodule deinit -f ./utils，同时删除tool_a目录下.gitmodules里的utils相关条目
• 回到main_app根目录，编辑.gitmodules，给tool_a的utils添加相对路径配置，指向main_app的utils：

  [submodule "tool_a/utils"]
      path = tool_a/utils
      url = ../utils.git  # 用相对路径指向main_app的utils仓库，也可以直接写utils的完整仓库地址
      ignore = dirty
  

• 执行git submodule update --init，此时tool_a的utils会和main_app的utils共享存储，不会重复拉取。用同样的方法处理tool_b。

这样tool_a/tool_b单独拉取时，依然可以正常初始化自己的utils子模块；在main_app里则共享同一份utils，避免重复。

2. 改用Git子树替代子模块 #

子树会把utils的代码直接合并到目标仓库，但仍能和原utils仓库保持同步：

• 给tool_a添加utils子树：git subtree add --prefix utils <utils仓库地址> main
• 后续要同步utils的更新，执行：git subtree pull --prefix utils <utils仓库地址> main
• 在main_app中添加tool_a/tool_b作为子树时，可在构建脚本里配置路径优先级，让tool_a/tool_b优先使用main_app根目录的utils，忽略自身的utils目录。

这种方式不需要处理复杂的子模块依赖，虽然仓库体积会略有增加，但能彻底解决重复引入问题，且tool_a/tool_b独立运行时不受影响。

3. 构建层面做路径映射 #

如果不想改动Git版本管理结构，直接在构建/运行环节做兼容：

• 在main_app的构建配置（比如Makefile、CMake、package.json等）里，指定tool_a和tool_b在编译或运行时，直接引用main_app根目录的utils，忽略它们自身子模块中的utils
• 举个例子：Node.js项目可以用module.exports.paths配置路径映射；C++项目用CMake的include_directories把main_app的utils目录设为优先查找路径

这种方式零改动Git仓库，只需要调整构建逻辑，适合不想折腾版本管理的场景。

内容的提问来源于stack exchange，提问作者Avi Elgal