【Git】子模块:一个仓库包含另一个仓库

0.843字数 810阅读 16477

【问题】

有种情况我们经常会遇到:某个工作中的项目需要包含并使用另一个项目。 也许是第三方库,或者你独立开发的,用于多个父项目的库。 现在问题来了:你想要把它们当做两个独立的项目,同时又想在一个项目中使用另一个。

【解决方案】

  • 子模块允许你将一个 Git 仓库作为另一个 Git 仓库的子目录。 它能让你将另一个仓库克隆到自己的项目中,同时还保持提交的独立。
  • 子模块关键字:【git submodule】

【怎么使用子模块?】


【第一步】:在现有仓库中加入子模块

  1. 在现有仓库中增加子模块:
$ git submodule add https://github.com/chaconinc/DbConnector
  • 查看上面命令执行后现有仓库根目录有哪些变化 :增加了1个文件和一个目录:.gitmodules和DbConnector文件夹
$ git status
On branch master
Your branch is up-to-date with 'origin/master'.
Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)
    new file:   .gitmodules
    new file:   DbConnector
  • 查看[.gitmodules]文件
$ cat .gitmodules
[submodule "DbConnector"]
    path = DbConnector
    url = https://github.com/chaconinc/DbConnector
  • 查看子模块信息
$ git diff --cached --submodule
      diff --git a/.gitmodules b/.gitmodules
      new file mode 100644
      index 0000000..71fc376
      ---/dev/null
      +++b/.gitmodules
      @@ -0,0 +1,3 @@
      +[submodule "DbConnector"]
      +path = DbConnector
      +url = https://github.com/chaconinc/DbConnector
      Submodule DbConnector 0000000...c3f01dc (new submodule)
  • 提交增加的子模块到现有仓库的远程仓库
$ git commit -am 'added DbConnector module'
      [master fb9093c] added DbConnector module
       2 files changed, 4 insertions(+)
       create mode 100644 .gitmodules
       create mode 160000 DbConnector
#这里160000表示DbConnector是以目录记录,而不是子目录记录或文件

【第二步】:克隆包含子模块的仓库

  1. 克隆项目,并且初始化子模块,更新子模块代码
【方法一】
        1.克隆项目,子模块目录默认被克隆,但是是空的
          $ git clone https://github.com/chaconinc/MainProject
        2.初始化子模块:初始化本地配置文件
          $ git submodule init
        3.该项目中抓取所有数据并检出父项目中列出的合适的提交
          $ git submodule update
【方法二:】用--recursive命令,跟方法一样达到效果
          $ git clone --recursive https://github.com/chaconinc/MainProject
  1. 更新子模块代码(需要进入子项目目录)
【方法一】
          $ cd DbConnector
          $ git fetch
          $ git merge origin/master
【方法二】
          $ git submodule update --remote DbConnector
        # 这里默认更新master分支,如果更新其他分支
         $ git config -f .gitmodules submodule.DbConnector.branch stable
         $ git submodule update --remote
        $ git merge origin/master
  1. 查看子模块的信息
$ git config status.submodulesummary 1
$ git status
# 查看子模块提交信息
$ git log -p --submodule

【第三步】:修改子模块

  1. 切换到要修改代码的子模块分支;
$ cd DbConnector
$ git checkout stable
  1. 拉取服务器代码,并且合并到本地分支stable;
$ git submodule update --remote --merge
  1. 进行相关文件修改;
  2. 推送本次修改;
$ git push

【第四步】:主仓库推送相关注意点

  1. 主仓库推送时,确保子模块的修改已经推送,下面命令会检查子模块修改的内容是否推送,如果没有,主仓库推送也会失败
$ git push --recurse-submodules=check
  1. 上面推送,如果子模块没有推送,命令即失败;可以用on-demand代理check,Git会检查到子模块没有推送,会自动推送子模块,然后再推送主模块(如果子模块推送失败,那么主模块也推送失败)
$ git push --recurse-submodules=on-demand

【第五步】:主仓库包含多个子模块

  1. foreach可以遍历所有子模块,下面是把子模块存储起来
$ git submodule foreach 'git stash'
  • 移动刚刚储藏的子模块到新分支,然后开始新的bug修复等开发
$ git submodule foreach 'git checkout -b featureA'
  • 显示主项目和子模块的所有改动
$ git diff; git submodule foreach 'git diff'

【第六步】:主仓库包含多个子模块

  1. 一个分支包含子模块一个分支没有子模块,在这两个分支之间切换时,要注意子模块目录,如下详细说明:
1.新建一个分支
        $ git checkout -b add-crypto
        Switched to a new branch 'add-crypto'
2.创建一个子模块
        $ git submodule add https://github.com/chaconinc/CryptoLibrary
3.修改子模块代码,并提交
        $ git commit -am 'adding crypto library'
4.切换到master分支
        $ git checkout master
5.查看状态:
        $ git status
        On branch master
        Your branch is up-to-date with 'origin/master'.
        Untracked files:
            (use "git add <file>..." to include in what will be committed)
            CryptoLibrary/
            nothing added to commit but untracked files present (use "git add" to track)
# 这里可以看到CryptoLibrary是没有被跟踪的,这是add-crypto分支下增加的子模块的目录,特别要注意这点
6.清除未跟踪文件
        $ git clean -fdx
        Removing CryptoLibrary/
7.切换回有子模块的分支add-crypto
        $ git checkout add-crypto
        Switched to branch 'add-crypto'
8.会发现子模块的文件夹是没有的,必须重新更新
        $ ls CryptoLibrary/
        $ git submodule update --init
          Submodule path 'CryptoLibrary': checked out       'b8dda6aa182ea4464f3f3264b11e0268545172af'
        $ ls CryptoLibrary/
          Makefile  includes    scripts     src

【别名】一些命令太长了可以设置为别名,方便调用

  1. 显示主项目和子模块的所有改动
$ git config alias.sdiff '!'"git diff && git submodule foreach 'git diff'"
  • 推送主仓库,同时检查子模块,如果没有推送,结束此命令提示用户推送子模块先
$ git config alias.spush 'push --recurse-submodules=on-demand'
  • 推送主仓库,同时检查子模块,如果没有推送先推送子模块
$ git config alias.spush 'push --recurse-submodules=on-demand'
  • 更新子模块,并且合并代码到本地
$ git config alias.supdate 'submodule update --remote --merge'

推荐阅读更多精彩内容