如何不切換Git分支，同時在多個分支上工作？

作為程式員的我們應該都

種還好很多，可是面對下面這些場景，stash 依舊不是很好的解決方案。

https://blog.didispace.com/git-work-on-different-branch/#%E6%88%91%E4%BB%AC%E9%9D%A2%E5%AF%B9%E7%9A%84%E5%9C%BA%E6%99%AF 我們面對的場景

1. 正在 main 分支上跑長時間的測試，切換到 hotfix 或 feature, 測試就會中斷
2. 項目非常大，頻繁的切換索引，成本非常高
3. 有幾年前 release 的舊版本，設定和目前不一樣，IDE restructure 适配切換也會帶來很大的開銷
4. 切換分支，需要重新設定相應的環境變量，比如 dev/qa/prod
5. 需要切換到同僚的代碼，幫助調試代碼複現問題

有的同學想到，git clone 多個 repo 不就可以了嗎？這是解決上述問題的一個方法，但背後同樣隐藏很多問題：

1. 多個 repo 的狀态是不好同步的，比如沒辦法快速 cherry-pick, 一個 repo checkout 的分支，另外一個 repo 需要重新 checkout
2. git history/log 是重複的，當項目曆史非常長，

   .git

   檔案夾下的内容是非常占用磁盤空間的
3. 同一個項目，多個 repo，不易管理

那如何做才能滿足這些特殊場景，又不出現這些上述這些問題呢？

git-worktree

其實，這是 Git 2015 年就開始支援的功能，卻很少有人知道它，git-worktree 的使用非常友善，在終端輸入：

git worktree --help      

就可以快速看到幫助文檔說明：

用簡單的話來解釋 git-worktree 的作用就是：

僅需維護一個 repo，又可以同時在多個 branch 上工作，互不影響

上面紅色框線指令有很多，我們常用的其實隻有下面這四個：

git worktree add [-f] [--detach] [--checkout] [--lock] [-b <new-branch>] <path> [<commit-ish>]
git worktree list [--porcelain]
git worktree remove [-f] <worktree>
git worktree prune [-n] [-v] [--expire <expire>]      

在展開說明之前，需要和大家普及兩個你可能忽視的 Git 知識點：

1. 預設情況下，

   git init

   或

   git clone

   初始化的 repo，隻有一個

   worktree

   ，叫做

   main worktree

2. 在某一個目錄下使用 Git 指令，目前目錄下要麼有

   .git

   檔案夾；要麼有

   .git

   檔案，如果隻有

   .git

   檔案，裡面的内容必須是指向

   .git

   檔案夾的

如果您正在學習Spring Cloud，推薦一個連載多年還在繼續更新的免費教程： https://blog.didispace.com/spring-cloud-learning/

https://blog.didispace.com/git-work-on-different-branch/#git-worktree-add git worktree add

目前項目目錄結構是這樣的(

amend-crash-demo

是 repo 的 root

.
└── amend-crash-demo

1 directory
cd amend-crash-demo` 運作指令 `git worktree add ../feature/feature2
➜  amend-crash-demo git:(main) git worktree add ../feature/feature2
Preparing worktree (new branch 'feature2')
HEAD is now at 82b8711 add main file      

重新看目錄結構

.
├── amend-crash-demo
└── feature
    └── feature2

3 directories      

該指令預設會根據 HEAD 所在的 commit-ish (當然也可以指定 git log 中的任意一個 commit-ish) 建立一個名為 feature2 的分支，分支磁盤位置如上面結構所示

cd ../feature/feature2/

 會發現，這個分支下并不存在 

.git

 檔案夾，卻存在一個 

.git

 檔案，打開檔案，内容如下：

gitdir: /Users/rgyb/Documents/projects/amend-crash-demo/.git/worktrees/feature2      

到這裡，你再了解一下上面的知識點2，是不是就清晰許多了呢？

接下來，你就可以在 feature2 分支上做一切你想做的内容了(add/commit/pull/push)，和 main worktree 互不幹擾

一般情況下，項目組都有一定的分支命名規範，比如

feature/JIRAID-Title

,

hotfix/JIRAID-Title

, 如果僅僅按照上面指令建立 worktree，分支名稱中的

/

會被當成檔案目錄來處理

git worktree add ../hotfix/hotfix/JIRA234-fix-naming      

運作完該指令，檔案目錄結構是這樣的

.
├── amend-crash-demo
├── feature
│   └── feature2
└── hotfix
    └── hotfix
        └── JIRA234-fix-naming

6 directories      

很顯然這不是我們想要的，這時我們就需要 -b 參數的支援了，就像

git checkout -b

一樣

執行指令：

git worktree add -b "hotfix/JIRA234-fix-naming" ../hotfix/JIRA234-fix-naming      

再來看一下目錄結構

.
├── amend-crash-demo
├── feature
│   └── feature2
└── hotfix
    ├── JIRA234-fix-naming
    └── hotfix
        └── JIRA234-fix-naming

7 directories      

進入 

JIRA234-fix-naming

 目錄，預設是在 

hotfix/JIRA234-fix-naming

 分支上

worktree 建立起來很容易，不加管理，項目目錄結構肯定亂糟糟，這是我們不想看到的，是以我們需要清晰的知道某個 repo 都建立了哪些 worktree

git worktree list

所有的worktree 都在共用一個 repo，是以在任意一個 worktree 目錄下，都可以執行如下指令來檢視 worktree 清單

git worktree list      

執行完指令後，可以檢視到我們上面建立的所有 worktree 資訊, 

main worktree

 也會顯示在此處

/Users/rgyb/Documents/projects/amend-crash-demo                        82b8711 [main]
/Users/rgyb/Documents/projects/chore/chore                                   8782898 (detached HEAD)
/Users/rgyb/Documents/projects/feature/feature2                             82b8711 [feature2]
/Users/rgyb/Documents/projects/hotfix/hotfix/JIRA234-fix-naming     82b8711 [JIRA234-fix-naming]
/Users/rgyb/Documents/projects/hotfix/JIRA234-fix-naming              82b8711 [hotfix/JIRA234-fix-naming      

worktree 的工作做完了，也是要及時删除的，否則也會浪費很多磁盤空間

另外，如果您正在學習Spring Cloud，推薦一個連載多年還在繼續更新的免費教程：

https://blog.didispace.com/git-work-on-different-branch/#git-worktree-remove git worktree remove

這個指令很簡單了，worktree 的名字叫什麼，直接就 remove 什麼就好了

git worktree remove hotfix/hotfix/JIRA234-fix-naming      

此時，分支名弄錯的那個 hotfix 就被删掉了

/Users/rgyb/Documents/projects/amend-crash-demo                        82b8711 [main]
/Users/rgyb/Documents/projects/chore/chore                                   8782898 (detached HEAD)
/Users/rgyb/Documents/projects/feature/feature2                             82b8711 [feature2]
/Users/rgyb/Documents/projects/hotfix/JIRA234-fix-naming              82b8711 [hotfix/JIRA234-fix-naming]      

假設你建立一個 worktree，并在裡面有改動，突然間這個worktree 又不需要了，此刻你按照上述指令是不能删掉了，此時就需要 

-f

 參數來幫忙了

git worktree remove -f hotfix/JIRA234-fix-naming      

删除了 worktree，其實在 Git 的檔案中，還有很多 administrative 檔案是沒有用的，為了保持清潔，我們還需要進一步清理

https://blog.didispace.com/git-work-on-different-branch/#git-worktree-prune git worktree prune

這個指令就是清潔的兜底操作，可以讓我們的工作始終保持整潔

https://blog.didispace.com/git-work-on-different-branch/#%E6%80%BB%E7%BB%93 總結

到這裡，你應該了解，整個 git-worktree 的使用流程就是下面這四個指令：

git worktree add
git worktree list
git worktree remove
git worktree prune      

你也應該明白 git worktree 和 git clone 多個 repo 的差別了。隻維護一個 repo，建立多個 worktree，操作間行雲流水

我的實踐：通常使用 git worktree，我會統一目錄結構，比如 feature 目錄下存放所有 feature 的worktree，hotfix 目錄下存放所有 hotfix 的 worktree，這樣整個磁盤目錄結構不至于因為建立多個 worktree 而變得混亂

在磁盤管理上我有些強迫症，理想情況下，某個 repo 的 worktree 最好放在這個 repo 的檔案目錄裡面，但這就會導緻 Git track 新建立的 worktree 下的所有檔案，為了避免 Git track worktree 的内容，來來回回修改 gitignore 檔案肯定是不合适的！

那麼如何解決呢？關注公衆号“日拱一兵”，正在連載Git的進階技巧！一起來學習吧！