不切换Git分支，如何同时在多个分支上工作

1、git-worktree

这是 Git 2015 年就开始支持的功能，却很少有人知道它，git-worktree 的使用非常方便，在终端输入

git worktree --help

它的作用就是：

仅需维护一个 repo，又可以同时在多个 branch 上工作，互不影响

看帮助文档说明，我们常用的有4个

 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 init 或 git clone 初始化的 repo，只有一个 worktree，叫做 main worktree
在某一个目录下使用 Git 命令，当前目录下要么有 .git 文件夹；要么有 .git 文件，如果只有 .git 文件，里面的内容必须是指向 .git 文件夹的

git corktree 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

接下来，你就可以在 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 也会显示在此处

worktree 的工作做完了，也是要及时删除的，否则也会浪费很多磁盘空间

git worktree remove

这个命令很简单了，worktree 的名字叫什么，直接就 remove 什么就好了

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

此时，分支名弄错的那个 hotfix 就被删掉了

假设你创建一个 worktree，并在里面有改动，突然间这个worktree 又不需要了，此刻你按照上述命令是不能删掉了，此时就需要 -f 参数来帮忙了

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

删除了 worktree，其实在 Git 的文件中，还有很多 administrative 文件是没有用的，为了保持清洁，我们还需要进一步清理。

git corktree 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 文件肯定是不合适的。