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

【问题标题】：How to sort HashMap keys when serializing with serde?使用serde序列化时如何对HashMap键进行排序？
【发布时间】：2017-03-10 16:20:30
【问题描述】：

我正在使用 serde 序列化 HashMap，如下所示：

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

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

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

我可以使用BTreeMap 而不是HashMap 来实现这一点，因为BTreeMap::keys() 按排序顺序返回它的键，但我不想仅仅为了适应序列化逻辑而更改我的数据结构。

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

【问题讨论】：

注意：您可能对 bluss 的OrderMap 感兴趣，这是一个 HashMap，其迭代顺序仅取决于元素插入和删除的顺序。

标签： rust serde

【解决方案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"
  }
}

【讨论】：