7.10 Git 工具 - 使用 Git 调试

使用 Git 调试

Git 也提供了两个工具来辅助你调试项目中的问题。由于 Git 被设计成适用于几乎所有类型的项目，这些工具是比较通用的，但它们可以在出现问题的时候帮助你找到 bug 或者错误。

文件标注

如果你在追踪代码中的一个 bug，并且想知道是什么时候以及为何会引入，文件标注通常是最好用的工具。它展示了文件中每一行最后一次修改的提交。所以，如果你在代码中看到一个有问题的方法，你可以使用 git blame 标注这个文件，查看这个方法每一行的最后修改时间以及是被谁修改的。这个例子使用 -L 选项来限制输出范围在第12至22行：

  1. $ git blame -L 12,22 simplegit.rb
  2. ^4832fe2 (Scott Chacon  2008-03-15 10:31:28 -0700 12)  def show(tree = 'master')
  3. ^4832fe2 (Scott Chacon  2008-03-15 10:31:28 -0700 13)   command("git show #{tree}")
  4. ^4832fe2 (Scott Chacon  2008-03-15 10:31:28 -0700 14)  end
  5. ^4832fe2 (Scott Chacon  2008-03-15 10:31:28 -0700 15)
  6. 9f6560e4 (Scott Chacon  2008-03-17 21:52:20 -0700 16)  def log(tree = 'master')
  7. 79eaf55d (Scott Chacon  2008-04-06 10:15:08 -0700 17)   command("git log #{tree}")
  8. 9f6560e4 (Scott Chacon  2008-03-17 21:52:20 -0700 18)  end
  9. 9f6560e4 (Scott Chacon  2008-03-17 21:52:20 -0700 19)
  10. 42cf2861 (Magnus Chacon 2008-04-13 10:45:01 -0700 20)  def blame(path)
  11. 42cf2861 (Magnus Chacon 2008-04-13 10:45:01 -0700 21)   command("git blame #{path}")
  12. 42cf2861 (Magnus Chacon 2008-04-13 10:45:01 -0700 22)  end

请注意，第一个字段是最后一次修改该行的提交的部分 SHA-1 值。接下来两个字段的值是从提交中提取出来的——作者的名字以及提交的时间——所以你就可以很轻易地找到是谁在什么时候修改了那一行。接下来就是行号和文件内容。注意一下 ^4832fe2 这个提交的那些行，这些指的是这个文件第一次提交的那些行。这个提交是这个文件第一次加入到这个项目时的提交，并且这些行从未被修改过。这会带来小小的困惑，因为你已经至少看到三种 Git 使用 ^ 来修饰一个提交的 SHA-1 值的不同含义，但这里确实就是这个意思。

另一件比较酷的事情是 Git 不会显式地记录文件的重命名。它会记录快照，然后在事后尝试计算出重命名的动作。这其中有一个很有意思的特性就是你可以让 Git 找出所有的代码移动。如果你在 git blame 后面加上一个 -C，Git 会分析你正在标注的文件，并且尝试找出文件中从别的地方复制过来的代码片段的原始出处。比如，你将 GITServerHandler.m 这个文件拆分为数个文件，其中一个文件是 GITPackUpload.m。对 GITPackUpload.m 执行带 -C 参数的blame命令，你就可以看到代码块的原始出处：

  1. $ git blame -C -L 141,153 GITPackUpload.m
  2. f344f58d GITServerHandler.m (Scott 2009-01-04 141)
  3. f344f58d GITServerHandler.m (Scott 2009-01-04 142) - (void) gatherObjectShasFromC
  4. f344f58d GITServerHandler.m (Scott 2009-01-04 143) {
  5. 70befddd GITServerHandler.m (Scott 2009-03-22 144)         //NSLog(@"GATHER COMMI
  6. ad11ac80 GITPackUpload.m    (Scott 2009-03-24 145)
  7. ad11ac80 GITPackUpload.m    (Scott 2009-03-24 146)         NSString *parentSha;
  8. ad11ac80 GITPackUpload.m    (Scott 2009-03-24 147)         GITCommit *commit = [g
  9. ad11ac80 GITPackUpload.m    (Scott 2009-03-24 148)
  10. ad11ac80 GITPackUpload.m    (Scott 2009-03-24 149)         //NSLog(@"GATHER COMMI
  11. ad11ac80 GITPackUpload.m    (Scott 2009-03-24 150)
  12. 56ef2caf GITServerHandler.m (Scott 2009-01-05 151)         if(commit) {
  13. 56ef2caf GITServerHandler.m (Scott 2009-01-05 152)                 [refDict setOb
  14. 56ef2caf GITServerHandler.m (Scott 2009-01-05 153)

这个功能很有用。通常来说，你会认为复制代码过来的那个提交是最原始的提交，因为那是你第一次在这个文件中修改了这几行。但 Git 会告诉你，你第一次写这几行代码的那个提交才是原始提交，即使这是在另外一个文件里写的。

二分查找

当你知道问题是在哪里引入的情况下文件标注可以帮助你查找问题。如果你不知道哪里出了问题，并且自从上次可以正常运行到现在已经有数十个或者上百个提交，这个时候你可以使用 git bisect 来帮助查找。bisect 命令会对你的提交历史进行二分查找来帮助你尽快找到是哪一个提交引入了问题。

假设你刚刚在线上环境部署了你的代码，接着收到一些 bug 反馈，但这些 bug 在你之前的开发环境里没有出现过，这让你百思不得其解。你重新查看了你的代码，发现这个问题是可以被重现的，但是你不知道哪里出了问题。你可以用二分法来找到这个问题。首先执行 git bisect start 来启动，接着执行 git bisect bad 来告诉系统当前你所在的提交是有问题的。然后你必须告诉 bisect 已知的最后一次正常状态是哪次提交，使用 git bisect good [good_commit]：

  1. $ git bisect start
  2. $ git bisect bad
  3. $ git bisect good v1.0
  4. Bisecting: 6 revisions left to test after this
  5. [ecb6e1bc347ccecc5f9350d878ce677feb13d3b2] error handling on repo

Git 发现在你标记为正常的提交(v1.0)和当前的错误版本之间有大约12次提交，于是 Git 检出中间的那个提交。现在你可以执行测试，看看在这个提交下问题是不是还是存在。如果还存在，说明问题是在这个提交之前引入的；如果问题不存在，说明问题是在这个提交之后引入的。假设测试结果是没有问题的，你可以通过 git bisect good 来告诉 Git，然后继续寻找。

  1. $ git bisect good
  2. Bisecting: 3 revisions left to test after this
  3. [b047b02ea83310a70fd603dc8cd7a6cd13d15c04] secure this thing

现在你在另一个提交上了，这个提交是刚刚那个测试通过的提交和有问题的提交的中点。你再一次执行测试，发现这个提交下是有问题的，因此你可以通过 git bisect bad 告诉 Git：

  1. $ git bisect bad
  2. Bisecting: 1 revisions left to test after this
  3. [f71ce38690acf49c1f3c9bea38e09d82a5ce6014] drop exceptions table

这个提交是正常的，现在 Git 拥有的信息已经可以确定引入问题的位置在哪里。它会告诉你第一个错误提交的 SHA-1 值并显示一些提交说明，以及哪些文件在那次提交里修改过，这样你可以找出引入 bug 的根源：

  1. $ git bisect good
  2. b047b02ea83310a70fd603dc8cd7a6cd13d15c04 is first bad commit
  3. commit b047b02ea83310a70fd603dc8cd7a6cd13d15c04
  4. Author: PJ Hyett <pjhyett@example.com>
  5. Date:   Tue Jan 27 14:48:32 2009 -0800
  7.     secure this thing
  9. :040000 040000 40ee3e7821b895e52c1695092db9bdc4c61d1730
  10. f24d3c6ebcfc639b1a3814550e62d60b8e68a8e4 M  config

当你完成这些操作之后，你应该执行 git bisect reset 重置你的 HEAD 指针到最开始的位置，否则你会停留在一个很奇怪的状态：

  1. $ git bisect reset

这是一个可以帮助你在几分钟内从数百个提交中找到 bug 的强大工具。事实上，如果你有一个脚本在项目是正常的情况下返回 0，在不正常的情况下返回非 0，你可以使 git bisect 自动化这些操作。首先，你设定好项目正常以及不正常所在提交的二分查找范围。你可以通过 bisect start 命令的参数来设定这两个提交，第一个参数是项目不正常的提交，第二个参数是项目正常的提交：

  1. $ git bisect start HEAD v1.0
  2. $ git bisect run test-error.sh

Git 会自动在每个被检出的提交里执行 test-error.sh 直到找到第一个项目不正常的提交。你也可以执行 make 或者 make tests 或者其他东西来进行自动化测试。

prev | next

原文: https://git-scm.com/book/zh/v2/Git-%E5%B7%A5%E5%85%B7-%E4%BD%BF%E7%94%A8-Git-%E8%B0%83%E8%AF%95