[[72462]]

前言

　　對于一些比較大的工程，為了便于復用，常常需要抽取子項目。例如我開發的猿題庫客戶端現在包括3門考試，客戶端涉及的公共UI、公共底層邏輯、公共的第三方庫、以及公共的答題卡掃描算法就被我分別抽取成了子項目。這些子項目都以git submodule的形式，增加到工程中。

在使用了git submodule一段時間后，我發現了一些submodule的問題，在此分享給大家。
更新submodule的坑

　　submodule項目和它的父項目本質上是2個獨立的git倉庫。只是父項目存儲了它依賴的submodule項目的版本號信息而已。如果你的同事更新了submodule，然后更新了父項目中依賴的版本號。你需要在git pull之后，調用 git submodule update來更新submodule信息。

　　這兒的坑在于，如果你git pull之后，忘記了調用 git submodule update，那么你極有可能再次把舊的submodule依賴信息提交上去。對于那些習慣使用 git commit -a的人來說，這種危險會更大一些。所以建議大家:
1.git pull之后，立即執行git status, 如果發現submodule有修改，立即執行git submodule update
2.盡量不要使用 git commit -a， git add命令存在的意義就是讓你對加入暫存區的文件做二次確認，而 git commit -a相當于跳過了這個確認過程。

　　更復雜一些，如果你的submodule又依賴了submodule，那么很可能你需要在git pull 和 git submodule update之后，再分別到每個submodule中再執行一次git submodule update，這里可以使用 git submodule foreach命令來實現： git submodule foreach git submodule update

修改submodule的坑

　　有些時候你需要對submodule做一些修改，很常見的做法就是切到submodule的目錄，然后做修改，然后commit和push。

　　這里的坑在于，默認git submodule update并不會將submodule切到任何branch，所以，默認下submodule的HEAD是處于游離狀態的(‘detached HEAD’ state)。所以在修改前，記得一定要用git checkout master將當前的submodule分支切換到master，然后才能做修改和提交。

　　如果你不慎忘記切換到master分支，又做了提交，可以用cherry-pick命令挽救。具體做法如下：
1.用 git checkout master 將HEAD從游離狀態切換到 master 分支, 這時候，git會報Warning說有一個提交沒有在branch上，記住這個提交的change-id（假如change-id為 aaaa)
2.用 git cherry-pick aaaa 來將剛剛的提交作用在master分支上
3.用 git push 將更新提交到遠程版本庫中

　　以下是相關命令的操作示范和命令行輸出結果：
1. ui_common git:(df697f9) git checkout master
2.Warning: you are leaving 1 commit behind, not connected to
3.any of your branches:
4.
5.  df697f9 forget to check out master
6.
7.If you want to keep them by creating a new branch, this may be a good time
8.to do so with:
9.
10. git branch new_branch_name df697f911e5a0f09d883f8f360977e470c53d81e
11.
12.Switched to branch 'master'
13. ui_common git:(master) git cherry-pick df697f9

使用第三方工具

　　對于submodule的重度使用者，有幾個工具可作推薦：
1.Repo Google用于管理Android項目的工具。
2.Gitslave
3.Git Subtree

　　以上工具，我都沒有實際用過，所以無法提供更多信息。

Tips

　　由于常常使用submodule的相關命令，可以在 ~/.gitconfig文件中將其設置別名，方便操作，我設置的所有相關別名如下：
1.[alias]
2.  st = status -s
3.  ci = commit
4.  l = log --oneline --decorate -12 --color
5.  ll = log --oneline --decorate --color
6.  lc = log --graph --color
7.  co = checkout
8.  br = branch
9.  rb = rebase
10.  dci = dcommit
11.  sbi = submodule init
12.  sbu = submodule update
13.  sbp = submodule foreach git pull
14.  sbc = submodule foreach git co master

參考鏈接
1.《why-your-company-shouldnt-use-git-submodules》 (需翻墻)

2.《Git_submodule_tutorial》
 

來源：唐巧的技術博客