如何使用 Git Stash 避免代码丢失：深入指南

在软件开发过程中，我们经常会遇到这样的情况：你正在一个分支上辛勤工作，实现某个新功能或者修复一个棘手的 bug。突然，你被要求紧急切换到另一个分支去处理一个更重要的问题，或者需要基于当前分支的干净状态创建一个新的分支。这时，你可能会面临一个两难的境地：

• 如果直接提交当前的工作，可能会提交一些不完整、未测试的代码，这会污染提交历史，甚至引入新的问题。
• 如果直接切换分支，未提交的更改可能会丢失，或者与目标分支产生冲突，导致代码混乱。

幸运的是，Git 提供了一个强大的工具——git stash，它可以帮助你优雅地解决这个问题，避免代码丢失，并保持工作区的干净。本文将深入探讨 git stash 的用法，并结合实际场景演示如何利用它来避免代码丢失，提高开发效率。

1. Git Stash 是什么？

git stash 命令可以将你当前工作目录和暂存区中的所有修改（包括已跟踪和未跟踪的文件）保存到一个名为 "stash" 的特殊存储区域中。这个存储区域独立于你的分支，类似于一个临时的代码仓库。通过 git stash，你可以：

• 暂时保存未完成的工作： 将当前的修改“藏”起来，让你的工作目录恢复到干净的状态（与最近一次提交一致）。
• 切换分支： 干净的工作目录允许你自由地切换到其他分支，而不用担心代码冲突或丢失。
• 稍后恢复工作： 当你处理完紧急任务后，可以随时从 stash 中恢复之前保存的修改，继续你的工作。

可以将 git stash 理解为一个“草稿箱”，你可以把未完成的工作暂时放在里面，需要的时候再拿出来。

2. Git Stash 的基本用法

git stash 的基本用法非常简单，主要包括以下几个命令：

2.1. git stash push (或 git stash save)：保存修改

这是最常用的 git stash 命令，用于将当前工作目录和暂存区的修改保存到 stash 中。

bash
git stash push -m "我的工作草稿"

• -m 选项用于添加一条描述信息，方便你日后识别这个 stash。
• 如果不加 -m 选项，Git 会自动生成一条默认的描述信息。
• git stash save 是 git stash push 的旧版本命令，功能相同，但 git stash push 更推荐使用，因为它更灵活，支持更多选项。

示例：

假设你正在开发一个新功能，修改了 index.html 和 style.css 两个文件，并且已经将 index.html 添加到了暂存区。这时，你可以使用以下命令将这些修改保存到 stash：

bash
git stash push -m "新功能开发中 - 首页样式调整"

执行完这个命令后，你的工作目录会恢复到干净的状态，index.html 和 style.css 的修改都会被保存到 stash 中。

2.2. git stash list：查看 Stash 列表

这个命令用于查看当前仓库中所有的 stash。

bash
git stash list

输出结果类似于：

stash@{0}: On main: 新功能开发中 - 首页样式调整
stash@{1}: WIP on feature/login: 修复登录 bug
stash@{2}: On main: 添加测试用例

• 每个 stash 都有一个唯一的标识符，例如 stash@{0}、stash@{1} 等。
• 标识符后面的数字表示 stash 的创建顺序，数字越小，stash 创建的时间越晚。
• 冒号后面的信息是你在创建 stash 时添加的描述信息（或者 Git 自动生成的描述信息）。

2.3. git stash apply：应用 Stash

这个命令用于将 stash 中的修改应用到当前工作目录。

bash
git stash apply stash@{0}

• stash@{0} 是你要应用的 stash 的标识符。
• 如果不指定标识符，默认应用最近创建的 stash（即 stash@{0}）。

git stash apply 会将 stash 中的修改合并到当前工作目录，但不会从 stash 列表中删除该 stash。这意味着你可以多次应用同一个 stash。

注意： 应用 stash 时可能会产生冲突，就像 git merge 或 git rebase 一样。如果发生冲突，你需要手动解决冲突，然后将修改添加到暂存区，最后提交。

2.4. git stash pop：应用并删除 Stash

这个命令与 git stash apply 类似，但它会在应用 stash 后立即从 stash 列表中删除该 stash。

bash
git stash pop stash@{0}

• stash@{0} 是你要应用的 stash 的标识符。
• 如果不指定标识符，默认应用并删除最近创建的 stash（即 stash@{0}）。

git stash pop 是一个更常用的命令，因为它通常更符合我们的使用习惯：应用 stash 后，我们通常不再需要它了。

2.5. git stash drop：删除 Stash

这个命令用于从 stash 列表中删除指定的 stash。

bash
git stash drop stash@{0}

• stash@{0} 是你要删除的 stash 的标识符。
• 如果不指定标识符，则会报错。

2.6. git stash clear：清空 Stash 列表

这个命令用于清空 stash 列表，删除所有的 stash。

bash
git stash clear

警告： 这个命令会永久删除所有的 stash，请谨慎使用。

2.7. git stash show：查看 Stash 的详细信息

这个命令用于查看指定 stash 的详细信息，包括修改了哪些文件以及具体的修改内容。

bash
git stash show -p stash@{0}

• -p 选项表示显示 patch，即具体的修改内容。
• stash@{0} 是你要查看的 stash 的标识符。
  • 如果不指定标识符，默认显示最近创建的 stash（即 stash@{0}）的详细信息。

2.8. git stash branch：从 Stash 创建分支

这个命令用于从指定的 stash 创建一个新的分支。

bash
git stash branch <new-branch-name> stash@{0}

• <new-branch-name> 是新分支的名称。
• stash@{0} 是你要基于哪个 stash 创建分支。
  • 如果不指定标识符，默认基于最近创建的 stash（即 stash@{0}）创建分支。

这个命令非常有用，特别是当你发现之前保存的 stash 实际上是一个重要的功能或 bug 修复时。它可以让你在一个干净的分支上继续开发，而不会影响其他分支。

3. Git Stash 的高级用法

除了基本用法外，git stash 还有一些高级用法，可以让你更灵活地控制 stash 的行为。

3.1. git stash push --patch (或 -p)：选择性地 Stash

有时，你可能只想 stash 部分修改，而不是所有的修改。这时，你可以使用 --patch 选项（或简写 -p）。

bash
git stash push -p -m "选择性 stash"

执行这个命令后，Git 会逐个询问你每个修改过的文件，并让你选择是否要 stash 该文件的修改。你可以输入以下命令来控制 stash 的行为：

• y: stash 这个文件的修改。
• n: 不 stash 这个文件的修改。
• q: 退出 stash 操作。
• a: stash 这个文件以及后续所有文件的修改。
• d: 不 stash 这个文件以及后续所有文件的修改。
• /: 使用正则表达式搜索。
• s: 将当前的 hunk（代码块）拆分成更小的 hunk。
• e: 手动编辑当前的 hunk。
• ?: 显示帮助信息。

3.2. git stash push --include-untracked (或 -u)：Stash 未跟踪的文件

默认情况下，git stash 只会 stash 已跟踪的文件（即已经添加到暂存区或已经提交过的文件）的修改。如果你想同时 stash 未跟踪的文件（即 Git 尚未跟踪的文件），可以使用 --include-untracked 选项（或简写 -u）。

bash
git stash push -u -m "stash 包括未跟踪的文件"

3.3. git stash push --all (或 -a)：Stash 所有文件（包括忽略的文件）

如果你想 stash 所有文件，包括 Git 忽略的文件（例如 .gitignore 文件中指定的文件），可以使用 --all 选项（或简写 -a）。

bash
git stash push -a -m "stash 所有文件"

警告： 这个命令会 stash 所有文件，包括一些你可能不想 stash 的文件，例如编译生成的临时文件、依赖包等。请谨慎使用。

4. Git Stash 的最佳实践

以下是一些使用 git stash 的最佳实践，可以帮助你更有效地利用它：

• 添加描述信息： 在创建 stash 时，务必使用 -m 选项添加一条清晰的描述信息，方便你日后识别和管理 stash。
• 定期清理 stash： 随着时间的推移，stash 列表可能会变得越来越长，包含很多过时的 stash。定期使用 git stash list 查看 stash 列表，并使用 git stash drop 删除不再需要的 stash。
• 谨慎使用 git stash clear： git stash clear 会永久删除所有的 stash，请确保你真的不再需要这些 stash 后再使用。
• 使用 git stash branch： 如果你发现之前保存的 stash 实际上是一个重要的功能或 bug 修复，请使用 git stash branch 从该 stash 创建一个新的分支，以便更好地管理和跟踪这些修改。
• 理解 stash 的原理： git stash 并不是一个完美的解决方案，它也有一些局限性。例如，它不能处理二进制文件的冲突，也不能处理重命名文件的冲突。在使用 git stash 时，请务必理解它的原理和局限性，避免出现意外情况。
• 不要过度使用 stash： Stash 只是暂存修改，不是正式提交，过度使用容易造成管理混乱。对于确定可以提交的代码，应尽早提交。

5. 实际场景示例

下面通过几个实际场景示例来演示如何使用 git stash 避免代码丢失，并提高开发效率。

5.1. 场景一：紧急修复线上 Bug

你正在开发一个新功能，修改了多个文件。突然，你接到一个紧急任务，需要立即修复一个线上 Bug。

1. 保存当前工作：

   bash
git stash push -m "新功能开发中 - 暂停"
   2. 切换到线上分支：

   bash
git checkout main
   3. 创建修复分支：

   bash
git checkout -b hotfix/bug-fix
   4. 修复 Bug 并提交：

   ```bash

   ... 修复 Bug ...

   git add .
   git commit -m "修复线上 Bug"
   ```
   5. 合并修复分支：

   bash
git checkout main
git merge hotfix/bug-fix
   6. 切换回开发分支：

   bash
git checkout feature/new-feature
   7. 恢复之前的工作：

   bash
git stash pop

5.2. 场景二：临时切换任务

你正在开发一个新功能，需要修改多个文件。突然，你需要临时切换到另一个任务，查看一下其他分支的代码。

1. 保存当前工作：

   bash
git stash push -m "新功能开发中 - 临时切换任务"
   2. 切换到目标分支：

   bash
git checkout other-branch
   3. 查看代码：

   ```bash

   ... 查看代码 ...

   ```
   4. 切换回开发分支：

   bash
git checkout feature/new-feature
   5. 恢复之前的工作：

   bash
git stash pop

5.3 场景三：基于干净状态创建新分支

你正在开发一个新功能，已经修改了 index.html 和 style.css。现在你需要创建一个新的分支来尝试另一种实现方案，但你希望这个新分支是基于当前分支的干净状态（即不包含 index.html 和 style.css 的修改）。

1. 保存当前工作：

   bash
git stash push -m "尝试新方案 - 保存旧方案"
   2. 创建新分支：

   bash
git checkout -b feature/new-feature-alternative
   这时，feature/new-feature-alternative 分支是干净的，不包含任何未提交的修改。
   3. 在新的分支上尝试另一种实现方案：
   ```bash

   ... 尝试新方案 ...

   ``
4. 如果尝试不成功，可以随时删除该分支，并切换到原来的分支，用git stash pop`恢复继续开发。

6. 总结

git stash 是一个非常有用的 Git 工具，它可以帮助你避免代码丢失，保持工作区的干净，并提高开发效率。通过本文的介绍，你应该已经掌握了 git stash 的基本用法和高级用法，并了解了如何在实际场景中应用它。

记住，git stash 只是一个临时性的解决方案，它并不能替代 git commit。对于已经完成的工作，应该及时提交，而不是一直放在 stash 中。同时，也要定期清理 stash，避免 stash 列表变得过于庞大。

希望本文能够帮助你更好地理解和使用 git stash，让你的开发工作更加轻松和高效！