章节 ▾ 第二版

7.10 Git 工具 - 使用 Git 调试

使用 Git 调试

除了主要用于版本控制之外，Git 还提供了一些命令来帮助你调试源代码项目。由于 Git 旨在处理几乎任何类型的内容，这些工具都相当通用，但当出现问题时，它们通常可以帮助你查找错误或问题的根源。

文件标注

如果你在代码中找到了一个 bug，并且想知道它是何时以及为何引入的，文件标注通常是你最好的工具。它会显示哪个提交是最后修改文件中每行内容的。因此，如果你发现代码中的某个方法有 bug，你可以使用 git blame 命令标注该文件，以确定是哪个提交引入了该行。

以下示例使用 git blame 命令来确定 Linux 内核顶层 Makefile 中哪些行是由哪个提交和提交者负责的，并且进一步使用 -L 选项将标注输出限制在该文件的 69 到 82 行。

$ git blame -L 69,82 Makefile
b8b0618cf6fab (Cheng Renquan  2009-05-26 16:03:07 +0800 69) ifeq ("$(origin V)", "command line")
b8b0618cf6fab (Cheng Renquan  2009-05-26 16:03:07 +0800 70)   KBUILD_VERBOSE = $(V)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 71) endif
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 72) ifndef KBUILD_VERBOSE
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 73)   KBUILD_VERBOSE = 0
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 74) endif
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 75)
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 76) ifeq ($(KBUILD_VERBOSE),1)
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 77)   quiet =
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 78)   Q =
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 79) else
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 80)   quiet=quiet_
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 81)   Q = @
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 82) endif

请注意，第一个字段是最后修改该行的提交的部分 SHA-1 值。接下来的两个字段是从该提交中提取的值——作者姓名和该提交的创作日期——这样你就可以轻松地看到是谁以及何时修改了那一行。之后是行号和文件内容。还要注意 ^1da177e4c3f4 提交行，其中 ^ 前缀表示在仓库的初始提交中引入的行，并且此后一直未更改。这有点令人困惑，因为你现在已经看到了 Git 使用 ^ 修改提交 SHA-1 的至少三种不同方式，但在这里它就是这个意思。

Git 的另一个酷炫之处在于它不显式跟踪文件重命名。它记录快照，然后尝试事后隐式地找出哪些文件被重命名了。其中一个有趣的功能是，你还可以要求它找出各种代码移动。如果你向 git blame 命令传入 -C 选项，Git 会分析你正在标注的文件，并尝试找出其中代码片段最初来自何处（如果它们是从其他地方复制过来的）。例如，假设你正在将名为 GITServerHandler.m 的文件重构为多个文件，其中一个是 GITPackUpload.m。通过使用 -C 选项对 GITPackUpload.m 进行 blame 操作，你可以看到代码的这些部分最初来自哪里。

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

这非常有用。通常，你会得到复制代码的那个提交作为原始提交，因为那是你首次在此文件中触及这些行。Git 会告诉你你编写这些行的原始提交，即使它是在另一个文件中。

二分查找

如果你一开始就知道问题在哪里，标注文件会有所帮助。但如果你不知道是什么导致了问题，而且自从代码上次正常工作以来已经有几十甚至数百个提交，你很可能会求助于 git bisect。bisect 命令通过你的提交历史执行二分查找，帮助你尽快识别是哪个提交引入了问题。

假设你刚刚将代码发布到生产环境，收到了关于开发环境中未出现的问题的 bug 报告，并且你无法想象代码为什么会那样运行。你回到代码，发现可以重现该问题，但无法弄清楚哪里出了问题。你可以对代码进行 二分查找 来找出原因。首先运行 git bisect start 开始查找，然后使用 git bisect bad 告诉系统你当前所在的提交是损坏的。接着，你必须使用 git bisect good <good_commit> 告诉 bisect 上一个已知的良好状态是什么时候。

$ git bisect start
$ git bisect bad
$ git bisect good v1.0
Bisecting: 6 revisions left to test after this
[ecb6e1bc347ccecc5f9350d878ce677feb13d3b2] Error handling on repo

Git 发现你标记为最后一个良好提交 (v1.0) 和当前损坏版本之间大约有 12 个提交，它为你检出了中间的那个提交。此时，你可以运行你的测试，看看问题是否存在于这个提交中。如果存在，那么它是在这个中间提交之前某个时候引入的；如果不存在，那么问题是在这个中间提交之后某个时候引入的。结果发现这里没有问题，你通过输入 git bisect good 告诉 Git，然后继续你的查找之旅。

$ git bisect good
Bisecting: 3 revisions left to test after this
[b047b02ea83310a70fd603dc8cd7a6cd13d15c04] Secure this thing

现在你在另一个提交上，它介于你刚刚测试的提交和你的坏提交之间。你再次运行测试，发现这个提交是损坏的，所以你用 git bisect bad 告诉 Git。

$ git bisect bad
Bisecting: 1 revisions left to test after this
[f71ce38690acf49c1f3c9bea38e09d82a5ce6014] Drop exceptions table

这个提交是好的，现在 Git 拥有了确定问题是在哪里引入所需的所有信息。它会告诉你第一个损坏提交的 SHA-1 值，并显示一些提交信息以及在该提交中修改了哪些文件，这样你就可以找出可能引入此 bug 的原因。

$ git bisect good
b047b02ea83310a70fd603dc8cd7a6cd13d15c04 is first bad commit
commit b047b02ea83310a70fd603dc8cd7a6cd13d15c04
Author: PJ Hyett <pjhyett@example.com>
Date:   Tue Jan 27 14:48:32 2009 -0800

    Secure this thing

:040000 040000 40ee3e7821b895e52c1695092db9bdc4c61d1730
f24d3c6ebcfc639b1a3814550e62d60b8e68a8e4 M  config

完成后，你应该运行 git bisect reset 来将你的 HEAD 重置到你开始前的状态，否则你会陷入一个奇怪的状态。

$ git bisect reset

这是一个强大的工具，可以在几分钟内帮助你检查数百个提交以查找引入的 bug。事实上，如果你有一个脚本，当项目良好时退出码为 0，当项目损坏时退出码为非 0，你可以完全自动化 git bisect。首先，你再次通过提供已知的损坏和良好提交来告诉它二分查找的范围。如果你愿意，可以通过 bisect start 命令列出它们，先列出已知的损坏提交，再列出已知的良好提交。

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

这样做会自动在每个检出的提交上运行 test-error.sh，直到 Git 找到第一个损坏的提交。你也可以运行类似 make 或 make tests 或任何能为你运行自动化测试的命令。

scroll-to-top