gitsubmodule版本指定（git submodule update）

大家好，我是讯享网，很高兴认识大家。

我独立开发了《联机桌游合集》，是个网页，可以很方便的跟朋友联机玩斗地主、五子棋、象棋等游戏。这些游戏是不同的前端项目，而这些项目有很多公共依赖，我是如何管理的呢？

我使用的方案中，Git Submodules 承担着非常重要的角色。今天先给大家介绍下 Git Submodules，以后我会给大家更详细的介绍如何管理不同项目的公共依赖。

本文会根据我的大量的 submodules 实践经验（包括工作和个人开发），只解释常用的命令。当你了解这些命令，你完全可以像我一样使用 Git Submodules。

有2个概念：主项目、submodule（子模块）。这两者各自都是完整的 Git 仓库。

注意事项

关系是保存在主项目的 Git 仓库中。

被当作 submodule 的 Git 仓库，其实不知道自己变成了 submodule，它更不知道爸爸们有谁。（意思是，当你打开某个被当作 submodule 的 Git 仓库首页时，或者拉下这个仓库时，没有任何痕迹表明它是个submodule。因为父子信息不存在这里，只存在爸爸那里。）

.gitmodules 文件

父子关系的信息保存在主项目的文件，如果不是新加 submodule，这个文件通常不必改变了，因为信息比较固定。

submodule 的版本号

主项目还保存了对应 submodule 的版本号（commit id），没有冗余存储 submodule 的代码。

可以看到，这其实是个跳转到另一个仓库的链接，指明了具体的 commit id。

这个版本号，是需要经常变更的。

方法一，像普通仓库一样更新

之前说过，submodule 仓库也是个普通的 Git 仓库，它并不知道自己有多少个爸爸。

我们可以直接这个仓库，像给普通 Git 仓库提交更新一样，去更新它。

方法二，在主项目中更新

例如主项目在文件夹，A里面包含：

讯享网

我们可以进入B文件夹，你会发现在B中，也可以执行等命令，此时的命令都会是针对仓库B的，你可以在这里切换分支、提交更新，这时候，提交的都是submodule的变更。

这是更推荐的方式。因为很多时候 submodule 是对主项目仓库有依赖的。可能它是个组件库，没有运行环境，需要在主项目中debug。这点非常方便！

注意事项

当你在文件夹B中做commit后，文件夹B里面就有了新的 commit id。此时主项目A中所记录的 submodule 的commit id也会更新。所以，你回到文件夹A后，会发现A有变更了，变更内容是：旧commid id变成了新的commit id。

下面是：

方法一，cd submodule 后

在 submodule 中，所有git操作就当作一个普通的 Git 仓库就行，你可以切换分支、提交代码、拉取更新等。

这个方法，你可以拉取到 submodule 的master最新代码。但是如果这时候的commit id跟主项目里记录的 submodule 的 commit id 不一致，你会在主项目仓库看到diff，你可能需要提交主项目更新。

方法二，主项目执行

这个方法会自动拉取submodule的主分支（通常叫master或main）的最新版本。效果跟方法一一致。

如果你不带参数，就会更新所有 submodules。

注意事项，更新后需提交主项目变更。

当我们更新子项目后，相当于是把主项目记录的 submodule 的 commit id 给更新了，需要提交下主项目的变更。

方法三，主项目执行

注意，这个方法会使 submodule 的分支处于主项目里指定的 commit id。可能并不是拉 submodule 的 master 最新代码。

所以，这种方法仅适用于，当主仓库里记录的 submodule 的 commit id 已经是最新的（可能被其他同事提交过）。或者你期望 submodule 跟主仓库记录的保持一致时，也可以使用该方法。

方法一，按需clone submodule

这就按需clone了submodule。什么时候有用呢？跨团队协作某个主项目时，一些其它团队的submodule我们没必要安装，就不必执行和了。

合并第2、3步骤

第2、3步可以合并。使用以下命令：

注意顺序，跟的位置不可以调换噢。

方法二，一次性clone所有 submodule

只要不写submodule，那么就一次性检查该主项目的所有submodule，都拉下来。

合并第2、3步骤

合并第1、2、3步骤

cd到主项目，执行：

下面可以指定 submodule 放到哪个子文件夹

通过官方文档，你可以了解到更多场景，但是我从来没使用过其它场景了，因为用不到。本文描述的完全满足了我所有日常使用场景。

而高级场景会导致协作变困难，因为不是所有开发者都懂这些更复杂的命令和配置：

想了解，可以阅读 Git Submodules 官方文档，搜索命令相关关键字：

我是HullQin，公众号线下聚会游戏的作者（欢迎关注我，交个朋友）。转发本文前需获得作者HullQin授权。我独立开发了《联机桌游合集》，是个网页，可以很方便的跟朋友联机玩斗地主、五子棋等游戏，不收费无广告。还开发了参加Game Jam 2022。喜欢可以关注我噢～我有空了会分享做游戏的相关技术，会在这个专栏里分享：。

gitsubmodule版本 指定（git submodule update）