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

时间:2017-03-10 16:20:30

标签: rust serde

我用serde序列化HashMap,如下:

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

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

我希望我的HashMap按照排序(例如按字母顺序)的顺序序列化,以便序列化具有确定性。

我可以使用BTreeMap而不是HashMap来实现此目的,因为BTreeMap::keys()按排序顺序返回其键,但我不想改变我的数据结构以适应序列化逻辑。

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

1 个答案:

答案 0 :(得分:10)

使用serialize_with field attribute

extern crate serde;
#[macro_use]
extern crate serde_derive;
extern crate serde_json;

use serde::{Serialize, Serializer};
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());
}

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

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