使用 serde 序列化时如何按字母顺序对字段进行排序？

Question

我有一个 API，它要求对象的字段按字母顺序排序，因为必须对结构进行哈希处理。

在 Java/Jackson 中，您可以在序列化程序中设置一个标志：MapperFeature.SORT_PROPERTIES_ALPHABETICALLY。我在 Serde 中找不到类似的东西。

我正在使用rmp-serde (MessagePack)。它遵循用于JSON的注释和序列化过程，所以我认为它会完全兼容，但是the sorting provided by @jonasbb不适合它。

该结构有（很多）嵌套的枚举和结构，它们必须被展平以获得最终表示。我为此使用Serialize::serialize，但在正确的位置调用state.serialize_field（这样所有内容都按字母顺序排列）很痛苦，因为枚举需要match 子句，因此必须多次调用它字段在不同的地方，代码很难理解。

作为可能的解决方案，两个想法：

1. 使用平面表示创建一个新结构并手动按字母顺序对字段进行排序。

   这有点容易出错，所以这个扁平结构的编程排序解决方案会很棒。

2. 缓存Serialize::serialize中的键值（例如在一个BTreeMap中，已排序），最后在循环中调用state.serialize_field。

   问题是这些值似乎必须是 Serialize 类型，这不是对象安全的，所以我无法弄清楚如何将它们存储在地图中。

How to sort HashMap keys when serializing with serde? 相似但不相关，因为我的问题是关于结构的字段/属性的排序。

Answer 1

您没有编写您所针对的数据格式。这使得很难找到解决方案，因为有些解决方案可能并非在所有情况下都有效。

如果您使用 JSON，则此代码有效（除非使用 preserve_order 功能标志）。通过序列化到toml::Value 作为中间步骤，TOML 也是如此。 该解决方案也适用于其他数据格式，但可能会导致不同的序列化，例如，将数据作为映射而不是类似结构的形式发出。

fn sort_alphabetically<T: Serialize, S: serde::Serializer>(value: &T, serializer: S) -> Result<S::Ok, S::Error> {
    let value = serde_json::to_value(value).map_err(serde::ser::Error::custom)?;
    value.serialize(serializer)
}

#[derive(Serialize)]
struct SortAlphabetically<T: Serialize>(
    #[serde(serialize_with = "sort_alphabetically")]
    T
);

#[derive(Serialize, Deserialize, Default, Debug)]
struct Foo {
    z: (),
    bar: (),
    ZZZ: (),
    aAa: (),
    AaA: (),
}

println!("{}", serde_json::to_string_pretty(&SortAlphabetically(&Foo::default()))?);

因为结构必须被散列

虽然字段顺序是不确定性的来源之一，但还有其他因素。许多格式允许不同数量的空格或不同的表示形式，例如 Unicode 转义 \u0066。