差异 (diff)

检测并显示 2 个文本之间差异的处理。是版本控制和代码审查的基础技术。

差异 (diff) 是指比较 2 个文本文件或数据,检测并显示其中被添加、删除、修改的部分的处理。其起点是 1974 年收录于第 5 版 Unix 的 diff 命令。以行为单位求出最长公共子序列 (在两个文件中以相同顺序出现的行序列),再把偏离该序列的行标示为删除或添加,这一思路仍被现在的实现所继承。如今它是 Git、SVN、Mercurial 等版本控制系统的核心,也被广泛用于代码审查和部署自动化。

diff 算法有几种。Git 默认使用的是 Myers 系的贪心算法,官方文档中也将其说明为“基本的贪心算法”。这里常见的误解是,默认算法并不保证得到最小的差异。Git 另外提供了花更多时间进行最小化的 minimal,如果需要最小的差异,就要明确指定 --diff-algorithm=minimal。patience diff 以在一方中只出现 1 次的行为线索进行匹配,从而以易读的方式显示代码的结构性修改。histogram diff 是对 patience 的扩展,使其也能处理出现次数较少的公共元素。实务上的判断标准是“即使是同一处修改,变化的只是差异的呈现方式,修改后文件的内容无论用哪种算法当然都相同”,因此用法是在遇到难以阅读的差异时切换算法进行对比。如果要永久切换,就使用 diff.algorithm 设置。

diff 的输出格式也有多种。unified diff 格式用 + 表示添加的行,用 - 表示删除的行,并在修改处的前后包含上下文行。上下文默认为前后各 3 行,可以用 -U<n> 增减。hunk 开头的 @@ -2,7 +2,7 @@ 这一行表示“修改前从第 2 行起共 7 行,修改后从第 2 行起共 7 行”,是防止读错行号而改错地方的线索。在 GitHub 和 GitLab 的拉取请求页面上看到的差异显示就是以这种格式为基础的。side-by-side diff 是把修改前后左右并排显示的格式,优点是便于直观地把握修改。

在实务中,diff 不仅用于代码审查,还用于多种场景。跟踪配置文件的变更、管理文档的版本、检测数据库架构的变更等都是典型例子。在 CI/CD 流水线中,也有根据 diff 的结果缩小测试对象和部署对象范围的用法。

由于按行比较的特性,存在几个常见的陷阱。第一,仅仅把换行符从 LF 转换为 CRLF,所有行都会成为差异。如果是 3 行的文件,输出就是删除 3 行、添加 3 行,内容明明一个字符都没有变,看起来却像是全面修改。第二,只是调整缩进的修改同样会作为行的差异出现。加上 -w (忽略空白的差异) 后这些差异就会消失,因此当有意义的修改被埋没在空白的修改中时,可以用它来区分。第三,如果文件末尾的换行丢失,最后一行就会带着 \ No newline at end of file 的注记成为差异。第四,只是把代码移到别处的修改,也会显示为删除和添加 2 处。Git 有用颜色区分移动的 --color-moved,但默认是关闭的。这些都是“差异的行数”并不代表修改大小的例子,这也是审查时不要只看行数来判断的原因。

容易与 diff 混淆的概念是补丁 (patch)。diff 是“检测出差异的结果”,而补丁则是“用于应用该差异的指示书”。用 diff 命令生成差异、再用 patch 命令应用的 Unix 传统工作流程,现在仍在开源项目的邮件列表等场合中使用。

从字符计数的角度来看,diff 的输出除了原文之外还包含元信息 (行号、修改标记、文件路径、hunk 头等),因此 diff 输出的字符数会比原文多。另外,如果想以词或字符而不是行为单位查看修改,就使用 word diff。不过 word diff 顾名思义是以单词为单位,单词的分隔依赖于空格。在英语中,the quick brown fox → the quick brawn fox 的修改会显示为 brown 被替换为 brawn,但日语不用空格分隔,因此在默认设置下整句话会被当作 1 个词处理,输出与按行的差异相差无几。在日语润色的差异中,把分隔用的正则表达式指定为按字符 (Git 中为 --word-diff-regex=.),就只有实际修改的几个字符会凸显出来。即使比较同一句话,也会出现这样的区别:默认情况下是整句被替换,而指定按字符时只有插入的 3 个字符被显示为差异。

分享这篇文章