有一次我因為配置檔而損失了一個下午的時間: "更改並引用;兩次部署之間。我終端機中的差異是一堵紅色的牆,有數百行,我花了一個小時尋找真正的更改,然後才意識到部署管道已經重新格式化了文件:重新縮排它,重新排序了一些屬性,重新包裝了一些長行。解析器關心的沒有一個位元組實際上發生了變化,除了雜訊中埋藏的一個值。基於行的差異無法告訴我這一點,因為基於行的差異不理解 XML。本指南是關於使用 XML 進行比較,以值得比較的方式進行比較 XML 差異檢查器 在 toolz。dev 上,以及為什麼結構比較會發現一個重要的變化,而不是在格式中淹沒它。
TL;DR: XML 差異將兩個文件比較為節點樹,而不是文字行,因此重新縮排、重新排序屬性或重新包裝行不會註冊為變更。它報告新增、刪除或變更了哪些元素、屬性和文字值,每個元素、屬性和文字值都固定到節點路徑上。這 XML 差異檢查器 完全在您的瀏覽器中執行此操作,不上傳任何內容。
什麼是 XML 差異檢查器?
XML 差異檢查器比較兩個 XML 文檔,並報告變更為一組結構差異:哪些元素出現或消失、哪些屬性變更值以及文字內容在哪裡不同。它不是逐行比較文件,而是將文件解析為節點樹並將它們作為資料進行比較。您將原始版本貼在左側,新版本貼在右側,然後返回差異列表,每個差異都標有發生該事件的樹中的確切路徑。
結構比較的要點是 XML 在許多不同的位元組佈局中具有相同的含義。這 W3C XML 規格 明確指出某些表面細節不會影響解析的文件:元素上的屬性順序並不重要,元素之間的空格通常只是格式化。兩個檔案在結構上可以相同,但在縮排、屬性順序、行結尾或空元素是否寫為 <tag></tag> 或者 <tag/>. 純文字差異標記所有這些;結構差異忽略它並僅顯示解析器實際上會以不同的方式讀取什麼。
在 toolz。dev 上,工作流程很短。貼上兩個文檔,選擇是否忽略空格、屬性或大小寫,然後按比較。該工具解析兩棵樹並按路徑列出每個差異,分為新增、刪除和更改,新舊值並排。
XML diff 與文字 diff 有何不同?
文字差異是 Git 和大多數編輯器中內建的類型,它將檔案作為行序列進行比較,並找到將一個檔案轉換為另一個檔案的最短插入和刪除集。這完全適合原始程式碼,其中行是有意義的單位。這是 XML 的錯誤模型,其中意義存在於樹中,換行符是裝飾。
故障模式是可以預測的。重新縮排文件,文字差異幾乎標記了每行更改的內容。對一個元素上的兩個屬性重新排序,即使該元素與解析器相同,它也會標記該行。在頂部附近添加一個子項,其下方的每一行都會移動,因此差異會顯示一系列未真正更改的移動。您最終會掃描數百條標記的行以找到重要的行,這就是我上面描述的下午。
結構差異透過先解析來迴避所有這些。它從每個文件建立一個樹,然後將兩棵樹一起走比較節點。格式化差異在樹層級根本不存在,因此它們不能出現在輸出中。剩下的是將改變使用 XML 的軟體的行為方式的一組更改,這幾乎總是您實際關心的集合。如果您的資料是 JSON 而不是 XML,則適用相同的原則 JSON 差異 工具在那裡進行等效的結構比較。
它如何決定發生了什麼變化?
比較在每個元素處分三層進行,將它們分開才能使輸出可讀。
屬性按名稱進行比較,與它們在標籤中出現的順序無關,因為屬性順序在 XML 中並不重要。對於每個元素,工具檢查兩側存在哪些屬性,並報告屬性在其值不同時發生更改,僅出現在右側時添加,或僅出現在左側時刪除。重新排序 <a x="1" y="2"/> 到 <a y="2" x="1"/> 根本沒有任何區別。
將文字內容與每個元素的直接文字進行比較。隨著空格處理,空格和換行符的運行被折疊,前導和後導空格被修剪,因此漂亮地列印文件不會產生虛線文字變更。僅報告標籤之間單字的真正更改。
兒童元素是有趣的部分。共享標籤名稱的元素按其出現順序配對:第一個 <item> 左邊與第一個進行比較 <item> 在右邊,第二個到第二個,依此類推。當一側比另一側出現更多情況時,額外內容將被報告為已新增或刪除,而不是強制錯位。這種排序規則可以防止一個重複元素的微小變化級聯到每個兄弟姊妹的差異。
以下是兩個比較模型如何堆疊:
| 方面 | 文字差異 | XML diff(結構) |
|---|---|---|
| 單位比較 | 文字行 | 樹中的節點 |
| 重新縮排 | 顯示為更改 | 被忽略了 |
| 屬性重新排序 | 顯示為變化 | 被忽略了 |
| 報告更改位置 | 行號 | 節點路徑,例如/目錄/書[2]/@id |
| 區分元素、屬性、文字 | 不 | 是的 |
| 最好 | 原始碼,散文 | XML 配置、API 有效負載、SVG、網站地圖 |
一個具體的例子使分層變得清晰。取一個小書目錄,其中兩個版本之間,一本書和#39;類別屬性從小說變為懸疑,同一本書'價格文字從 12.99 變更為 14.99,第二本書獲得了新的 isbn 元素。行差異會標記所有三個以及它們周圍的任何重新縮排,雜亂在一起。結構差異恰好報告了三個差異:類別路徑上更改的屬性、價格路徑上更改的文字節點以及 isbn 路徑上添加的元素。每個都帶有其類型標記,因此您可以一目了然地看出其中兩個是對現有資料的編輯,一個是真正的添加。這種分離是閱讀報告和解碼報告之間的差異。
該工具還將結果分組為添加、刪除和更改的選項卡,並帶有運行計數,因此您可以首先回答粗略的問題,例如 "是否有任何內容被刪除,"在深入了解細節之前。在大型文件中,這種排序很重要:刪除通常是最危險的變化,因為刪除的元素可以默默地剝離所需的字段,並且能夠在不涉過不相關的編輯的情況下隔離它們可以即時節省。
差異中的節點路徑意味著什麼?
每個差異都標有一條路徑,可以準確地告訴您它在樹中的位置,因此您可以跳到它而不是掃描文件。該路徑是根據元素名稱構建的,並通過從根向下切線連接。當一個元素有同名的兄弟姊妹時,括號中的基於一個的索引會消除哪個索引的歧義,因此 /catalog/book[2] 是第二本書。屬性是用 an 寫的 @ 前綴,如 /catalog/book[1]/@category,並且文字變更標記為 text(),如 /catalog/book[2]/price/text().
這個符號故意接近 X路徑,用於尋址 XML 文件中的節點的 W3C 語言,因此如果您已經閱讀了 XPath,路徑會感覺很熟悉,並且您通常可以將類似的表達式貼上到自己的工具中以選擇相同的節點。即使不知道 XPath,路徑也會自然地讀取:名稱沿著樹向下,括號選擇兄弟姊妹 @ 是一個屬性,並且 text() 是內容。
因為路徑也命名了更改的類型,所以報告同時回答了三個問題:更改了什麼、它生活在哪裡以及它是一個元素、屬性還是文字。這通常足以打開正確的文件並修復正確的行,而無需任何進一步的狩獵。
我什麼時候才能真正使用它?
配置漂移是我遇到最多的情況。當服務在兩個環境之間的行為不同且唯一可疑的是 XML 配置時,比較兩個檔案在結構上會在幾秒鐘內告訴您某個值是否真正更改或有人剛剛重新格式化了檔案。這同樣適用於建立和部署重寫 XML 的管道,其中您需要確認轉換僅更改了應有的內容。
API 和整合工作是下一個。 SOAP 回應、RSS 和 Atom 提要以及較舊的 REST API 仍然使用 XML,當有效負載停止正確解析結構差異時,已知良好樣本會快速找出違規元素。 SVG 也是 XML,因此比較兩個匯出的圖示可以準確地顯示編輯器更改了哪個路徑或屬性。網站地圖、Android 佈局檔案、Maven POM 等 .docx 內部結構都是 XML,並且都受益於相同的處理。我跨堆疊構建,XML 出現在比人們預期更多的角落,這就是為什麼它住在旁邊 XML 格式化程式 和 XML 到 JSON 在我的書籤中。我概述了這些如何適合更廣泛的套件 JSON 到 XML 指南.
還有一個程式碼審查角度。當拉取請求觸及 XML 固定裝置或產生的檔案時,審查 UI 中的原始差異通常無法讀取,因為格式化程式重寫了整個內容。透過結構比較運行前後,然後將簡短的報告貼到審查中,一眼告訴審查者實際發生了什麼變化,而不是要求他們相信一堵紅牆。工具'可複製文字報告的存在正是針對以下目的:每個新增、刪除和變更的節點及其前後值的緊湊摘要,準備放入票證、提交訊息或聊天線程中。
相鄰的比較工具涵蓋了 XML diff 不涵蓋的情況。當您的資料為表格時, CSV 差異 比較行和單元格,對於兩個普通列表 列出比較 工具確實設定了差異。他們有著相同的理念:先將資料解析為其自然形狀,然後進行比較,這樣差異就反映了意義而不是佈局。
有哪些限制?我的 XML 是私有的嗎?
該工具比較結構,這意味著它故意不報告結構未捕獲的差異類型。根據設計,重新排序兩個屬性、更改縮排或交換自閉合語法都被視為沒有更改。如果您的用例確實需要位元組精確比較,則文字差異是正確的工具,但事實並非如此。結構差異還按位置對重複的元素進行配對,因此如果將相同的記錄改組為不同的順序,工具會將移動的元素視為更改而不是重新定位;當有意義時,首先用穩定的金鑰對兩個文件進行排序,得到最乾淨的結果。
錯誤的 XML 是被報告而不是猜測的。如果文件具有不匹配或未關閉的標籤,或多個根元素,該工具會命名問題並告訴您它來自哪一邊,因此您永遠不會因輸入損壞而產生誤導性差異。它處理解析器必須的常見現實世界構造:單引號或雙引號中的屬性、自閉標籤、CDATA 部分、註解、處理指令和標準實體引用,例如 < 和 &.
在隱私方面,一切都在您的瀏覽器中運行。這兩個文件都在本地進行解析和比較,並且沒有任何內容被上傳、記錄或儲存。正是這種屬性使得可以安全地定義生產配置、內部 API 有效負載或客戶特定文件,而這些文件都不屬於陌生人'伺服器。這 線上工具中的資料隱私 guide 解釋瞭如何驗證工具是否真正屬於客戶端,在將任何敏感內容貼上到任何 Web 工具之前,這是值得做的。
常見問題
如何比較兩個 XML 檔案?
將原始 XML 貼到第一個欄位中,將變更後的 XML 貼到第二個欄位中,然後按比較。該工具將兩者解析為節點樹,並列出每個新增、刪除和變更的元素、屬性和文字值,每個都固定到其節點路徑上。沒有任何內容被上傳。
XML diff 與純文字 diff 有何不同?
文字差異逐行比較文件,因此重新縮排、重新排序屬性或重新包裝行幾乎會使所有內容看起來都發生了變化。 XML diff 首先將兩個文件解析為樹並在結構上比較它們,因此它僅報告會改變解析器讀取文件方式的差異。
重新排序屬性算是改變嗎?
不。屬性會透過名稱進行比較,無論它們在標籤中出現的順序如何,因為屬性順序在 XML 中並不重要。僅報告更改的值、新增的屬性或刪除的屬性。
兩個文件之間的重複元素如何匹配?
共享標籤名稱的子元素按其出現順序配對,因此將第一個項目與第一個項目進行比較,將第二個項目與第二個項目進行比較,依此類推。如果一個文件的出現次數多於另一個文件,則會報告新增或刪除的額外內容。
每個差異中的節點路徑意味著什麼?
此路徑使用元素名稱顯示樹中變更的位置,當存在同名的兄弟姊妹時,括號中的基於一個索引、屬性的@name 以及文字內容的文字()。例如,/catalog/book[2]/@id 指向第二本書的 id 屬性。
空格或格式會影響比較嗎?
預設情況下,僅空白文字將被忽略,並且文字內的空白運行將被折疊,因此重新格式化文件不會產生錯誤的差異。您可以依賴結構比較而不是精確匹配縮排。
如果 XML 格式錯誤會發生什麼事?
該工具報告命名問題的明顯錯誤,例如不匹配或未關閉的標籤,並告訴您它來自哪個文件。它不會猜測修復,因此您永遠不會因輸入損壞而產生誤導性差異。
我的 XML 文件上傳到任何地方嗎?
不。所有解析和比較都以 JavaScript 的形式在瀏覽器中進行。沒有任何內容被傳輸、記錄或儲存。您可以透過查看網路標籤或與網路斷開連接來確認這一點,該工具可以保持離線工作。
將您自己的文件與免費文件進行比較 XML 差異檢查器. 它完全在瀏覽器中按節點路徑報告結構差異,不上傳任何內容。
