阅读 415

git submodule-Android组件化单项目多仓库管理方案

每日音乐:

1、基本介绍:

  • 在进行Android组件化过程中当项目比较大的时候便于复用,或者多个项目共用module。这个时候需要抽取项目公共模块,而且现在基本是使用git作为版本控制工具,这样就变成App Project 有多个module,每个module都是一个独立的git repository。而且我们希望单个的module都可以独立维护,可以更方便查看和随时随地同步更新。
  • 为了达成这样的目的我们可以使用git-submodulegit-repo 、gitslave 、git-subtree
  • git-repo更适合管理比较大、module比较多、module会经常变更的项目,Android源码就是采用这种方式管理;如果module比较少的情况,使用git-submodule完全够用。

2、使用步骤:

  1. 进入到主项目根目录中输入命令
    • git submodule add <子module的git地址> : 从远程仓库将子module导入到该项目中,这时候会自动生成.gitmodules文件
    • git submodule add <子module的git地址> <主项目内的文件夹>: 从远程仓库将子module导入到该项目中的特定文件夹中。
    • git submodule init:初始化本地.gitmodules文件。
    • git submodule update:在父项目中更新子module的修改。
    • git submodule foreach git pull:拉取所有子模块。
    • git submodule foreach git submodule update:如果你的submodule又依赖了submodule,可以使用git submodule foreach命令来实现一次性全更新。
    • git clone --recurse-submodules <主项目仓库地址> :获取主项目和所有子项目源码【git pull <主项目仓库地址>的时候不会同时获取submodules的源码】。
  2. 进入到子module目录中输入命令
    • 走正常的git add、git commit、git push流程。

3、注意点:

3.1、更新 submodule 的坑:

  • 在父项目中git pull只会更新父项目中的代码,并不会更新子module项目中的代码,这时忘记了调用 git submodule update,那么git push极有可能再次把旧的 submodule 依赖信息提交上去。
  • git pull 之后,立即执行 git status, 如果发现 submodule 有修改,立即执行 git submodule update
  • 如果你的 submodule 又依赖了 submodule,那么很可能你需要在 git pullgit submodule update 之后,再分别到每个 submodule 中再执行一次 git submodule update,这里可以使用 git submodule foreach git submodule update命令来实现。

3.2、修改 submodule 的坑:

  • 默认 git submodule update 并不会将 submodule 切到任何 branch,所以,默认下 submodule 的 HEAD 是处于游离状态的 (‘detached HEAD’ state)。所以在修改前,记得一定要用 git checkout master 将当前的 submodule 分支切换到 master,然后才能做修改和提交。
  • 如果你不慎忘记切换到 master 分支,又做了提交,可以用 cherry-pick 命令挽救。具体做法如下:
  • git checkout master将 HEAD 从游离状态切换到 master 分支 , 这时候,git 会报 Warning 说有一个提交没有在 branch 上,记住这个提交的 change-id(假如 change-id 为 aaaa)。
  • git cherry-pick aaaa来将刚刚的提交作用在 master 分支上。
  • git push将更新提交到远程版本库中。

3.3、删除 submodule 的坑:

  • 直接删除子模块并不能完全删除,再次添加的时候会报错'<submodule>' already exists in the index.
  • 用以下命令可以完全删除submodule:
    git rm --cached submodule子项目名字
    rm -rf submodule子项目名字
复制代码

参考:blog.devtang.com/2013/05/08/…