## 7.11 子模板 子模块允许将一个 Git 仓库作为另一个 Git 仓库的子目录。 它能将另一个仓库克隆到自己的项目中，同时还保持提交的独立。 ### 7.11.1 **开始使用子模块** 将一个已存在的 Git 仓库添加为正在工作的仓库的子模块： ``` $ git submodule add [url] ``` 此时版本库中会有一个新的`.gitmodules`文件。 该配置文件保存了项目 URL 与已经拉取的本地目录之间的映射。如果有多个子模块，该文件中就会有多条记录。 要重点注意的是，该文件也像`.gitignore`文件一样受到（通过）版本控制。而在`git status`输出中列出的另一个是项目文件夹记录。 ### 7.11.2 **克隆含有子模块的项目** 如果克隆一个含有子模板的项目，默认会包含该子模块目录，但其中还没有任何文件。此时需要运行两个命令： ``` $ git submodule init ``` 用来初始化本地配置文件，和 ``` $ git submodule update ``` 从该项目中抓取所有数据并检出父项目中列出的合适的提交。 或者在克隆时，直接使用 `--recursive` ，Git 会自动初始化并更新仓库中的每一个子模块。 ### 7.11.3 在包含子模块的项目上工作 **拉取上游修改** 如果想要在子模块中查看新工作，可以进入到目录中运行`git fetch`与`git merge`，合并上游分支来更新本地代码。 在版本库的根目录下运行以下命令查看子模板具体的修改。 ``` $ git diff --submodule ``` 如果不想在子目录中手动抓取与合并，那么还有种更容易的方式。 运行命令让Git 自动进入子模块然后抓取并更新。 ``` $ git submodule update --remote ``` 此命令默认更新并检出子模块仓库的`master`分支，可以通过修改 `.gitmodules` 来更改默认的分支： ``` $ git config -f .gitmodules submodule.[submodule].branch [branch] ``` **在子模块上工作** 如果本地的子模板中有修改没有提交，运行： ``` $ git submodule update --remote ``` 不会覆盖，它只会将远程仓库中的修改抓取到本地，类似于`git fetch`。如果想要抓取的同时进行合并，可以使用 `--merge` 选项： ``` $ git submodule update --remote --merge ``` **发布子模块改动** `git push`命令接受可以设置为 `check` 或 `on-demand` 的`--recurse-submodules`参数。 * 如果任何提交的子模块改动没有推送那么 `check` 选项会直接使`push`操作失败 * 而 `on-demand` 选项会尝试一并推送子模板的改动，但是如果子模板的推送失败，整个 `push` 操作失败 ### 7.11.4 子模块技巧 **子模块遍历** 如果项目中包含了大量子模块，可以使用`foreach`子模块命令，它能在每一个子模块中运行任意命令： ``` $ git submodule foreach 'git stash' ``` **有用的别名** 可以通过设置别名来替代一些较长的子模板命令。例如： ``` $ git config alias.sdiff '!'"git diff && git submodule foreach 'git diff'" $ git config alias.spush 'push --recurse-submodules=on-demand' $ git config alias.supdate 'submodule update --remote --merge' ``` ### 7.11.5 子模块的问题 在有子模块的项目中切换分支可能会造成麻烦。 如果在创建一个新分支后在其中添加一个子模块，之后切换到没有该子模块的分支上时，仍然会有一个还未跟踪的子模块目录。