快速理解 Git submodule

一句话理解

submodule = 在一个 Git 仓库里,引用另一个 Git 仓库的某个提交。

也就是说:

• 主仓库不直接"吃进去"另一个仓库的全部历史

• 而是记录那个子仓库当前指向的 commit

• 别人拉主仓库时,也能把这个子仓库一起拉下来

你可以把它理解成:主项目里"挂载"了另一个独立维护的仓库,主仓库只会记录其commit。

它解决什么问题

常见场景:

• 你的项目依赖一个独立组件,但你不想把代码直接复制进来

• 多个项目共用同一个库

• 需要固定依赖在某个版本,而不是总跟着最新代码跑

submodule 和直接拷贝代码的区别

直接拷贝代码:

• 简单

• 但后续同步更新麻烦

• 容易改乱来源

用 submodule:

• 子仓库仍然是独立 Git 仓库

• 有自己的提交历史

• 主仓库只记录"我现在依赖它的哪个 commit"

最核心的认知

  1. submodule 不是普通文件夹

它里面其实是另一个 Git 仓库。

  1. 主仓库记录的是子仓库的 commit 指针

不是自动跟着子仓库最新分支走。

  1. clone 主仓库时,submodule 默认不会自动完整拉下来

需要额外初始化

常用操作命令

  1. 添加submodule
    git submodule add

示例:

git submodule add https://github.com/example/shared-lib.git libs/shared-lib

命令会生成两个文件:

  • gitmodules: 记录submodule的地址和路径
  • libs/shared-lib: 子模块入口
  1. clone/初始化项目
    第一次 clone 项目,submodule 是空的,需要初始化子模块:
    git submodule update --init --recursive

--recursive 表示如果子模块里还有子模块,也一并处理。

  1. 查看submdule 状态

    git submodule status

  2. 更新/同步 submodule

    git submodule update --init --recursive

相关推荐
Hvitur2 天前
Git - 多分支合并
git·github
考虑考虑2 天前
git刷新远程分支列表
git·后端·gitlab
AI大模型-小华2 天前
Codex 自动测试怎么用?从生成测试用例到修复失败用例
git·测试用例·ai编程·软件开发·codex·chatgpt pro·codex cli
七分辣度3 天前
GitHub/Git 常用命令及使用场景
git·github
慧都小项4 天前
MyEclipse Inline Diff 实用指南:逐处核对 AI 修改再提交
git·ai编程·myeclipse·java 代码审查·ai 代码修改
德育处主任4 天前
让 Claude Code 在你睡觉时接着干活:tmux、权限策略与验收清单
git·ai编程·命令行
为思念酝酿的痛6 天前
Git基本操作
git·github
wno7047 天前
常用的Git命令清单
大数据·git·elasticsearch
真上帝的左手8 天前
3. 代码管理-Git-进阶
git·源代码管理
YIN_尹8 天前
【git原理与使用】git基本操作及底层原理(二)
大数据·git·elasticsearch