文字差異對比工具 go-diff

簡介

純文字差異對比在許多場景下都有應用，如語音識別技術對識別率的評估，需要將識別後的文字與預期文字之間做差異對比計算；又如我們使用 Git 進行程式碼提交時，通常會使用git diff來檢視這次編輯發生了哪些改動。

這裡我們先簡單定義一下差異 diff：是指目標文字和源文字之間的區別，也就是將源文字變成目標文字所需要的操作。

以上問題的一個通常解決方案是 Eugene W.Myers 在 1986 年發表的一篇論文 An O(ND) Difference Algorithm and Its Variations 中提出的 Myers 差分演算法，該演算法是一個能在大部分情況產生「最短的直觀的 diff」的演算法。

google/diff-match-patch 專案是 Myers 差分演算法的一種實現。但是該專案缺少 Golang 語言的一個實現。

go-diff 就是 google/diff-match-patch 專案的一個 Golang 版本的補充。

go-diff 主要提供三個功能：

• 比較兩段文字並返回它們的差異
• 執行文字的模糊匹配
• 生成和應用補丁

go-diff 不僅能夠簡潔地輸出字串對比結果，還能夠輸出規範化的資料結構方便我們的二次開發。

如何使用

go-diff 使用方式非常簡單，程式碼如下

const (
    text1 = "gocn vip"
    text2 = "goCN cool"
)

func main() {
    dmp := diffmatchpatch.New()

    diffs := dmp.DiffMain(text1, text2, false)
    fmt.Println(diffs)
}

執行以上程式碼，輸出

[{Equal go} {Insert CN } {Equal c} {Delete n vip} {Insert ool}]

以上輸出結果表示從 text1 變成 text2 需要執行的步驟:

• go 不需要變動
• 插入 CN
• c 不需要變動
• 刪除 n vip
• 插入語 ool

DiffMain 方法會查詢兩段文字的不同，並以陣列形式返回 diff 差異。

這裡的 diff 差異就是從左邊 text1 的字串變成右邊 text2 的字串所需要的最少的步驟，每個步驟只能做 “保持不變”、“插入” 或者 “刪除” 操作。如果我們需要的是替換操作，那麼只能是先 “刪除” 後 “插入”

工具提供了DiffPrettyText 和DiffPrettyHtml 等方法，可以將 diff 陣列轉換成更友好的有顏色高亮的文字或 HTML 格式報告。

DiffTimeout引數用以設定 diff 計算的超時時間，如果超過此時間，則該計算將被截斷，並返回目前為止的最佳解決方案。 此時儘管結果是正確的，但可能並不是最佳方案。 該值為 0 時可進行無限時的計算。

總結

go-diff 庫實現了高效、完備的文字差異對比演算法，在類似需求時，如計算編輯距離、模糊匹配時，不需要我們再去手寫複雜的演算法，非常省心和方便。

Reference

git 生成 diff 原理：Myers 差分演算法 | 大藝術家_SN (chenshinan.github.io)

Git 是怎樣生成 diff 的：Myers 演算法 - CJ Ting's Blog