章节 ▾ 第二版

7.10 Git 工具 - 使用 Git 调试

使用 Git 调试

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

文件注解

如果您在代码中发现了一个错误，并且想知道它是何时以及为何引入的，文件注解通常是您最好的工具。它会显示哪个提交是最后修改任何文件中的每一行的。因此，如果您发现代码中的某个方法有 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 的另一个很酷的特性是它不会明确跟踪文件重命名。它记录快照，然后尝试在事后隐式地找出重命名了什么。其中一个有趣的特性是您也可以要求它找出各种代码移动。如果您将 -C 传递给 git blame，Git 会分析您正在注解的文件，并尝试找出其中的代码片段（如果它们是从其他地方复制过来的）最初来自何处。例如，假设您正在将一个名为 GITServerHandler.m 的文件重构为多个文件，其中一个是 GITPackUpload.m。通过使用 -C 选项 blame GITPackUpload.m，您可以看到代码的各个部分最初来自何处

$ 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 命令通过您的提交历史进行二分查找，以帮助您尽快识别哪个提交引入了问题。

假设您刚刚将代码发布到生产环境，您正在收到关于开发环境中没有发生的事情的错误报告，并且您无法想象代码为什么会那样做。您回到代码中，结果发现您可以重现问题，但您无法弄清楚哪里出了问题。您可以 bisect 代码来找出问题。首先运行 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，并显示一些提交信息以及在该提交中修改了哪些文件，以便您可以找出可能引入此错误的原因

$ 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 的范围。如果您愿意，可以通过 bisect start 命令列出它们，先列出已知的坏提交，然后列出已知的好提交

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

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