使用JsonDiffPatch与C#比较Json数组时忽略元素顺序的方法

嘿，我懂你这个问题——JsonDiffPatch默认是按数组的索引位置来比较元素的，所以哪怕两个数组里的元素内容完全一样，只要顺序换了，它就会判定成差异。要解决这个问题，我们得给它换个「数组比较逻辑」，让它只关心元素内容，不管顺序。

核心思路 #

JsonDiffPatch允许我们自定义IArrayComparer接口的实现，替换掉默认的索引比较逻辑。我们可以实现一个比较器，让它遍历数组元素，找到内容完全匹配的项（不管位置），只要所有元素都能一一匹配上，就判定数组无差异。

具体实现步骤 #

1. 自定义数组比较器

先写一个实现IArrayComparer的类，逻辑是：先检查数组长度是否一致，然后逐个匹配内容相同的元素，只要所有元素都能找到对应匹配，就认为数组无差异。

using Newtonsoft.Json.Linq;
using JsonDiffPatchDotNet;
using System.Collections.Generic;
using System.Threading.Tasks;

public class IgnoreOrderArrayComparer : IArrayComparer
{
    private readonly JsonDiffPatch _diffPatch;
    private readonly object _lockObj = new object();

    public IgnoreOrderArrayComparer(JsonDiffPatch diffPatch)
    {
        _diffPatch = diffPatch;
    }

    public Task<ComparisonResult> Compare(JToken left, JToken right, JsonDiffPatchContext context)
    {
        var leftArray = left as JArray;
        var rightArray = right as JArray;

        // 如果不是数组，直接返回不可比较
        if (leftArray == null || rightArray == null)
            return Task.FromResult(ComparisonResult.NotComparable);

        // 数组长度不一样，直接判定有差异
        if (leftArray.Count != rightArray.Count)
            return Task.FromResult(ComparisonResult.Changed);

        // 把右数组元素转成可修改的列表，用来移除已匹配的项
        var remainingRightElements = rightArray.ToList();

        foreach (var leftElement in leftArray)
        {
            var isMatched = false;
            lock (_lockObj)
            {
                // 遍历剩余的右元素，找到内容完全匹配的项
                for (int i = 0; i < remainingRightElements.Count; i++)
                {
                    var elementDiff = _diffPatch.Diff(leftElement, remainingRightElements[i]);
                    // 如果diff结果为null，说明两个元素完全一致
                    if (elementDiff == null)
                    {
                        remainingRightElements.RemoveAt(i);
                        isMatched = true;
                        break;
                    }
                }
            }

            // 找不到匹配元素，直接判定数组有差异
            if (!isMatched)
                return Task.FromResult(ComparisonResult.Changed);
        }

        // 所有元素都匹配成功，数组无差异
        return Task.FromResult(ComparisonResult.Unchanged);
    }
}

2. 配置并使用自定义比较器

接下来，把这个自定义比较器注册到JsonDiffPatch的配置里，然后用这个实例去比较你的JSON：

// 创建JsonDiffPatch实例，替换默认数组比较器
var jsonDiffPatch = new JsonDiffPatch(new JsonDiffPatchOptions
{
    ArrayComparer = new IgnoreOrderArrayComparer(jsonDiffPatch)
});

// 加载你的两个JSON文件
var json1 = File.ReadAllText("你的第一个JSON文件路径");
var json2 = File.ReadAllText("你的第二个JSON文件路径");

// 解析为JToken
var token1 = JToken.Parse(json1);
var token2 = JToken.Parse(json2);

// 生成差异结果
var diffResult = jsonDiffPatch.Diff(token1, token2);

// 输出结果：如果diffResult为null，说明忽略顺序后完全一致
if (diffResult == null)
{
    Console.WriteLine("两个JSON忽略数组元素顺序后完全一致！");
}
else
{
    Console.WriteLine("差异内容：");
    Console.WriteLine(diffResult.ToString());
}

优化小技巧 #

如果你的数组元素有唯一标识（比如每个传输地址有Type字段区分邮箱/电话），可以优化匹配逻辑，不用全量比较元素内容，直接按标识匹配，效率会更高。比如修改比较器里的匹配部分：

// 假设每个TransmissionAddress有Type字段（比如"Email"/"Phone"）
var leftElementType = leftElement.SelectToken("TransmissionAddresses.$values[0].Type")?.ToString();
if (!string.IsNullOrEmpty(leftElementType))
{
    var matchIndex = remainingRightElements.FindIndex(e => 
        e.SelectToken("TransmissionAddresses.$values[0].Type")?.ToString() == leftElementType);
    if (matchIndex != -1)
    {
        remainingRightElements.RemoveAt(matchIndex);
        isMatched = true;
    }
}

这样就不用每次都对元素做全量diff，直接通过标识快速匹配，性能更好。

内容的提问来源于stack exchange，提问作者JaiK