使用 serde 序列化时如何对 HashMap 键进行排序？

Question

我正在用 serde 序列化一个 HashMap，像这样：

#[derive(Serialize, Deserialize)]
struct MyStruct {
    map: HashMap<String, String>
}

HashMap 的键顺序未指定，并且由于散列是随机的（参见 documentation），键实际上最终在相同运行之间以不同的顺序出现。

我希望我的 HashMap 以排序的（例如字母顺序）键顺序进行序列化，以便序列化是确定的。

我可以按排序顺序使用 BTreeMap instead of a HashMap to achieve this, as BTreeMap::keys() returns 它的键，但我不想为了适应序列化逻辑而更改我的数据结构。

如何告诉 serde 在序列化之前对 HashMap 键进行排序？

Answer 1

使用serialize_with field attribute:

use serde::{Deserialize, Serialize, Serializer}; // 1.0.106
use serde_json; // 1.0.52
use std::collections::{BTreeMap, HashMap};

#[derive(Serialize, Deserialize, Default)]
struct MyStruct {
    #[serde(serialize_with = "ordered_map")]
    map: HashMap<String, String>,
}

fn ordered_map<S>(value: &HashMap<String, String>, serializer: S) -> Result<S::Ok, S::Error>
where
    S: Serializer,
{
    let ordered: BTreeMap<_, _> = value.iter().collect();
    ordered.serialize(serializer)
}

fn main() {
    let mut m = MyStruct::default();
    m.map.insert("gamma".into(), "3".into());
    m.map.insert("alpha".into(), "1".into());
    m.map.insert("beta".into(), "2".into());

    println!("{}", serde_json::to_string_pretty(&m).unwrap());
}

在这里，我选择从 HashMap 重建整个 BTreeMap，然后重用现有的序列化实现。

{
  "map": {
    "alpha": "1",
    "beta": "2",
    "gamma": "3"
  }
}

使用 serde 序列化时如何对 HashMap 键进行排序？

How to sort HashMap keys when serializing with serde?

rust

serde