作為程序員的我們應該都有一個(gè)感受，一旦進(jìn)入某個(gè)項目，從開(kāi)發(fā)，到發(fā)布生產(chǎn)，到 hotfix，到后期維護，那基本都有你的份，正在開(kāi)發(fā)某個(gè) feature，老板突然跳出來(lái)說(shuō)讓你做生產(chǎn)上的 hotfix 更是家常便飯，面對這種情況，使用 Git 的我們通常有兩種解決方案：

1. 草草提交未完成的 feature，然后切換分支到 hotfix
2. git stash | git stash pop 暫存工作內容，然后再切換到 hotfix

第二種方式較第一種還好很多，可是面對下面這些場(chǎng)景，stash 依舊不是很好的解決方案

我們面對的場(chǎng)景

1. 正在 main 分支上跑長(cháng)時(shí)間的測試，切換到 hotfix 或 feature, 測試就會(huì )中斷
2. 項目非常大，頻繁的切換索引，成本非常高
3. 有幾年前 release 的舊版本，設置和當前不一樣，IDE restructure 適配切換也會(huì )帶來(lái)很大的開(kāi)銷(xiāo)
4. 切換分支，需要重新設置相應的環(huán)境變量，比如 dev/qa/prod
5. 需要切換到同事的代碼，幫助調試代碼復現問(wèn)題

有的同學(xué)想到，git clone 多個(gè) repo 不就可以了嗎？這是解決上述問(wèn)題的一個(gè)方法，但背后同樣隱藏很多問(wèn)題：

1. 多個(gè) repo 的狀態(tài)是不好同步的，比如沒(méi)辦法快速 cherry-pick, 一個(gè) repo checkout 的分支，另外一個(gè) repo 需要重新 checkout
2. git history/log 是重復的，當項目歷史非常長(cháng)，.git 文件夾下的內容是非常占用磁盤(pán)空間的
3. 同一個(gè)項目，多個(gè) repo，不易管理

那如何做才能滿(mǎn)足這些特殊場(chǎng)景，又不出現這些上述這些問(wèn)題呢？

git-worktree

其實(shí)，這是 Git 2015 年就開(kāi)始支持的功能，卻很少有人知道它，git-worktree 的使用非常方便，在終端輸入：

git worktree --help

就可以快速看到幫助文檔說(shuō)明：

用簡(jiǎn)單的話(huà)來(lái)解釋 git-worktree 的作用就是：

僅需維護一個(gè) repo，又可以同時(shí)在多個(gè) branch 上工作，互不影響

上面紅色框線(xiàn)命令有很多，我們常用的其實(shí)只有下面這四個(gè)：

 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>]

在展開(kāi)說(shuō)明之前，需要和大家普及兩個(gè)你可能忽視的 Git 知識點(diǎn)：

1. 默認情況下， git init 或 git clone 初始化的 repo，只有一個(gè) worktree，叫做 main worktree
2. 在某一個(gè)目錄下使用 Git 命令，當前目錄下要么有 .git 文件夾；要么有 .git 文件，如果只有 .git 文件，里面的內容必須是指向 .git 文件夾的

第二句話(huà)感覺(jué)挺繞的，下面用例子說(shuō)明，就很容易明白了

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

該命令默認會(huì )根據 HEAD 所在的 commit-ish (當然也可以指定 git log 中的任意一個(gè) commit-ish) 創(chuàng )建一個(gè)名為 feature2 的分支，分支磁盤(pán)位置如上面結構所示

cd ../feature/feature2/ 會(huì )發(fā)現，這個(gè)分支下并不存在 .git 文件夾，卻存在一個(gè) .git 文件，打開(kāi)文件，內容如下：

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

到這里，你再理解一下上面的知識點(diǎn)2，是不是就清晰許多了呢？

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

一般情況下，項目組都有一定的分支命名規范，比如 feature/JIRAID-Title, hotfix/JIRAID-Title, 如果僅僅按照上面命令新建 worktree，分支名稱(chēng)中的 / 會(huì )被當成文件目錄來(lái)處理

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

運行完該命令，文件目錄結構是這樣的

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

6 directories

很顯然這不是我們想要的，這時(shí)我們就需要 -b 參數的支持了，就像 git checkout -b 一樣

執行命令：

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

再來(lái)看一下目錄結構

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

7 directories

進(jìn)入 JIRA234-fix-naming 目錄，默認是在 hotfix/JIRA234-fix-naming 分支上

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

git worktree list

所有的worktree 都在共用一個(gè) repo，所以在任意一個(gè) worktree 目錄下，都可以執行如下命令來(lái)查看 worktree 列表

git worktree list

執行完命令后，可以查看到我們上面創(chuàng )建的所有 worktree 信息, main worktree 也會(huì )顯示在此處

/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 的工作做完了，也是要及時(shí)刪除的，否則也會(huì )浪費很多磁盤(pán)空間

git worktree remove

這個(gè)命令很簡(jiǎn)單了，worktree 的名字叫什么，直接就 remove 什么就好了

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

此時(shí)，分支名弄錯的那個(gè) 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]

假設你創(chuàng )建一個(gè) worktree，并在里面有改動(dòng)，突然間這個(gè)worktree 又不需要了，此刻你按照上述命令是不能刪掉了，此時(shí)就需要 -f 參數來(lái)幫忙了

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

刪除了 worktree，其實(shí)在 Git 的文件中，還有很多 administrative 文件是沒(méi)有用的，為了保持清潔，我們還需要進(jìn)一步清理

git worktree prune

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

總結

到這里，你應該理解，整個(gè) git-worktree 的使用流程就是下面這四個(gè)命令：

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

你也應該明白 git worktree 和 git clone 多個(gè) repo 的區別了。只維護一個(gè) repo，創(chuàng )建多個(gè) worktree，操作間行云流水

我的實(shí)踐：通常使用 git worktree，我會(huì )統一目錄結構，比如 feature 目錄下存放所有 feature 的worktree，hotfix 目錄下存放所有 hotfix 的 worktree，這樣整個(gè)磁盤(pán)目錄結構不至于因為創(chuàng )建多個(gè) worktree 而變得混亂

在磁盤(pán)管理上我有些強迫癥，理想情況下，某個(gè) repo 的 worktree 最好放在這個(gè) repo 的文件目錄里面，但這就會(huì )導致 Git track 新創(chuàng )建的 worktree 下的所有文件，為了避免 Git track worktree 的內容，來(lái)來(lái)回回修改 gitignore 文件肯定是不合適的。

以下文章來(lái)源于日拱一兵 ，作者tan日拱一兵