Rust单元测试中如何断言键顺序不稳定的JSON相等？

在单元测试中无需修改库代码，就能稳定比较JSON结果的核心思路是绕过字符串层面的直接对比，转而比较JSON的语义结构，以下是几种实用方案：

1. 解析为serde_json::Value后比较 #

利用serde_json库的Value类型，它的PartialEq实现会忽略对象键的顺序，只校验结构和值的一致性。这是最通用的原生方案，无需额外依赖（只要你的库已经用了serde_json）。

use serde_json::Value;

#[test]
fn test_json_processing() {
    // 调用你的库获取输出的JSON字符串
    let actual_json = your_lib::process_some_json();
    // 定义预期的JSON内容（键顺序可以和实际输出不同）
    let expected_json = r#"{"email":"alice@example.com","id":123,"name":"Alice"}"#;

    // 将两个字符串解析为Value类型
    let actual_value: Value = serde_json::from_str(actual_json).expect("Failed to parse actual JSON");
    let expected_value: Value = serde_json::from_str(expected_json).expect("Failed to parse expected JSON");

    // 直接断言相等，自动忽略键的顺序差异
    assert_eq!(actual_value, expected_value);
}

2. 使用专用断言库简化代码 #

如果觉得手动解析麻烦，可以用assert_json_eq这类专门的断言库，它封装了解析和比较逻辑，直接支持JSON字符串的语义对比。

首先在Cargo.toml的dev-dependencies中添加：

[dev-dependencies]
assert_json_eq = "1.1.0"

然后在测试中使用：

use assert_json_eq::assert_json_eq;

#[test]
fn test_json_processing() {
    let actual_json = your_lib::process_some_json();
    let expected_json = r#"{"name":"Alice","id":123,"email":"alice@example.com"}"#;

    // 一行代码完成语义比较，自动忽略键顺序
    assert_json_eq!(actual_json, expected_json);
}

3. 自定义排序后对比（适合简单场景） #

如果不想引入额外依赖，也可以将JSON对象解析为BTreeMap（会自动按键排序），再序列化为字符串后对比。这种方式适合结构简单的JSON，嵌套结构需要递归处理：

use serde_json::{self, Value, Map};
use std::collections::BTreeMap;

// 递归将Value中的对象转换为BTreeMap（按键排序）
fn sort_json_value(value: Value) -> Value {
    match value {
        Value::Object(obj) => {
            let mut sorted_map = BTreeMap::new();
            for (k, v) in obj {
                sorted_map.insert(k, sort_json_value(v));
            }
            Value::Object(Map::from_iter(sorted_map))
        }
        Value::Array(arr) => {
            let sorted_arr = arr.into_iter().map(sort_json_value).collect();
            Value::Array(sorted_arr)
        }
        other => other,
    }
}

#[test]
fn test_json_processing() {
    let actual_json = your_lib::process_some_json();
    let expected_json = r#"{"name":"Alice","id":123,"email":"alice@example.com"}"#;

    let mut actual_value: Value = serde_json::from_str(actual_json).unwrap();
    let mut expected_value: Value = serde_json::from_str(expected_json).unwrap();

    // 对两个Value排序
    actual_value = sort_json_value(actual_value);
    expected_value = sort_json_value(expected_value);

    // 转为字符串后对比（此时键顺序一致）
    assert_eq!(serde_json::to_string_pretty(&actual_value).unwrap(),
               serde_json::to_string_pretty(&expected_value).unwrap());
}

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