前端实现文本对比并高亮显示差异的方法_Javascript

你有没有想过，常见的代码差异对比是如何都实现的呢？其实这里面涉及到非常复杂的文本对比算法，本文就来看看如何通过现有工具库 jsdiff + diff2html 实现文本对比，并高亮显示差异！

文本对比

文本对比可以借助 jsdiff 来实现，jsdiff 是一个 javascript 库，用于实现文本差异比较。这个库提供了多种方法来计算和展示两个文本之间的差异，可以用于多种文本差异比较的场景，比如版本控制、文档比较、代码编辑器中的变更高亮等。

jsdiff 基于 myers 在 1986 年提出的 "an o(nd) difference algorithm and its variations" 算法实现。

jsdiff 是一个非常热门的工具库，其 npm 周下载量高达 4000 万，很多知名前端工具库都依赖它：

github：https://github.com/kpdecker/jsdiff

以下是 jsdiff 提供的 api：

diffchars - 对两个文本进行字符级别的差异比较。
diffwords - 对两个文本进行单词级别的差异比较，忽略空白字符。
diffwordswithspace - 对两个文本进行单词级别的差异比较，考虑空白字符作为分隔符。
difflines - 对两个文本按行进行差异比较。
diffsentences - 对两个文本按句子进行差异比较。
diffcss - 专门用于比较 css 代码的差异。
diffjson - 比较两个 json 对象的差异，首先将它们序列化为格式化的 json 文本，然后逐行比较。
diffarrays - 比较两个数组，检查数组元素的严格等同性。
createtwofilespatch - 创建一个包含两个文件差异的补丁。
createpatch - 创建一个补丁，通常用于一个文件的前后变化。
applypatch - 应用一个给定的补丁到源文本上。
applypatches - 应用一个或多个补丁到相应的文件内容上。
parsepatch - 解析一个补丁字符串为结构化的数据。
reversepatch - 反转一个补丁，使得应用此补丁会撤销原始的更改。
convertchangestoxml - 将差异对象转换为 xml 格式。
convertchangestodmp - 将差异对象转换为 google 的 diff-match-patch 库的格式。

在使用 jsdiff 时，首先需要通过以下命令来安装：

npm install diff --save

安装完成之后就可以选择合适的 api 直接使用了。对于文章最开始的例子，就可以借助 createtwofilespatch api 来对比两个文件的差异，它的参数如下：

createtwofilespatch(oldfilename, newfilename, oldstr, newstr, oldheader, newheader, options)

oldfilename: 旧文件的文件名。
newfilename: 新文件的文件名。
oldstr: 原始字符串值
newstr: 新的字符串值
oldheader: 可选，允许在旧文件的头部添加额外的信息。
newheader: 可选，用于在新文件的头部添加额外的信息。
options: 一个包含选项的对象，可以用来自定义补丁的生成方式：
- context: 描述应该包含多少行上下文。设置为 number.max_safe_integer 或 infinity 可以包含整个文件内容在一个块（hunk）中。
- ignorewhitespace: 与 difflines 中的用法相同，用于忽略空白字符差异。默认为 false。
- striptrailingcr: 与 difflines 中的用法相同，用于在执行差异比较之前去除所有尾随的回车符（\r）。这有助于在比较 unix 和 windows 文本文件时得到有用的差异结果。默认为 false。

代码如下：

import * as diff from 'diff';

const oldfile = `{
  "projectname": "exampleproject",
  "version": "1.0.0",
  "author": "john doe",
  "dependencies": {
    "librarya": "^1.2.3",
    "libraryb": "^3.4.5"
  },
  "devdependencies": {
    "toolx": "^0.9.8"
  },
  "scripts": {
    "start": "node index.js"
  }
}`; 

const newfile = `{
  "projectname": "exampleproject",
  "version": "1.0.1",
  "author": "jane doe",
  "dependencies": {
    "librarya": "^1.2.3",
    "libraryc": "^7.8.9"
  },
  "devdependencies": {
    "toolx": "^0.9.8",
    "tooly": "^2.3.4"
  },
  "scripts": {
    "start": "node app.js",
    "test": "npm test"
  }
}`;

const diff = diff.createtwofilespatch("旧文件", "新文件", oldfile, newfile);

这里的对比结果 diff 结果如下：

对比结果有点丑，下面会进行优化。

除了 jsdiff，还有一个基于 jsdiff 开发的 react 库：react-diff-viewer。它提供了一种简单易用的方式来展示两个文本或对象之间的差异，不仅可以对文本进行对比，还可以输出漂亮的差异对比结果。

github：https://github.com/praneshr/react-diff-viewer

高亮显示差异

如果使用 jsdiff 进行对比，对比结果可能没那么美观，可以借助 diff2html 来美化。

diff2html 是一个用于将差异（diff）结果转换成 html 格式的工具，它通常用于在网页上展示文件或文本内容之间的差异。这个库提供了一种方便的方式来生成美观的差异比较视图，使得用户可以轻松地查看和理解两个版本之间的变化。

github：https://github.com/rtfpessoa/diff2html

首先需要进行安装：

npm install diff2html --save

然后导入使用即可：

import * as diff2html from "diff2html";

const outputhtml = diff2html.html(diff, {
  inputformat: "diff",
  showfiles: true,
  matching: "lines",
  highlight: true,
  outputformat: "side-by-side",
});

这里的 diff 就是上一步中生成的 diff 结果。

美化后对比如下，更美观了：