Rust中如何用serde对含None值的HashMap做序列化与反序列化

TOML规范本身未定义null/None这类空值语义，且serde的默认序列化规则会跳过值为None的字段，要解决这个问题需要手动定义空值的映射规则，常见有两种实现方式：

方案1：自定义包装类型映射空值（无额外依赖） #

通过自定义枚举来显式标记空值，序列化时将None映射为业务场景中不会出现的占位值，反序列化时再转换回标准Option类型，示例代码如下：

use std::collections::HashMap;
use serde::{Deserialize, Serialize};
use toml;

// untagged属性保证序列化后不会额外增加枚举标签
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
enum TomlOption<T> {
    // 有值的情况直接序列化对应原始值
    Value(T),
    // 空值情况序列化为特殊占位符，可替换为业务中不会用到的任意值
    Null,
}

// 实现和标准Option的双向转换，不侵入业务逻辑
impl<T> From<Option<T>> for TomlOption<T> {
    fn from(opt: Option<T>) -> Self {
        match opt {
            Some(v) => TomlOption::Value(v),
            None => TomlOption::Null,
        }
    }
}

impl<T> From<TomlOption<T>> for Option<T> {
    fn from(toml_opt: TomlOption<T>) -> Self {
        match toml_opt {
            TomlOption::Value(v) => Some(v),
            TomlOption::Null => None,
        }
    }
}

#[derive(Debug, Serialize, Deserialize)]
struct Config {
    // 将HashMap的值类型替换为自定义的TomlOption
    values: HashMap<String, TomlOption<u32>>,
}

fn main() {
    let values = [("foo", Some(5)), ("bar", None)]
        .iter()
        .map(|(name, s)| (name.to_string(), s.clone().into()))
        .collect();
    let config = Config { values };

    // 序列化
    let s = toml::ser::to_string(&config).unwrap();
    println!("序列化结果：\n{}", s);

    // 反序列化
    let de_config: Config = toml::from_str(&s).unwrap();
    println!("反序列化结果：\n{:?}", de_config);
}

运行后的序列化输出为：

[values]
foo = 5
bar = "__NULL__"

反序列化可以正确识别bar对应的None值。

方案2：使用serde_with库简化实现（推荐，适合复杂场景） #

如果允许引入第三方依赖，serde_with库提供了现成的空值转换规则，不需要手动实现包装类型：
首先在Cargo.toml中添加依赖：

[dependencies]
serde_with = "3.4"

修改后的代码如下：

use std::collections::HashMap;
use serde::{Deserialize, Serialize};
use serde_with::serde_as;
use toml;

#[serde_as]
#[derive(Debug, Serialize, Deserialize)]
struct Config {
    // 用NoneAs指定空值的序列化占位符，可按需修改为其他值
    #[serde_as(as = "HashMap<_, NoneAs<\"null\">>")]
    values: HashMap<String, Option<u32>>,
}

fn main() {
    let values = [("foo", Some(5)), ("bar", None)]
        .iter()
        .map(|(name, s)| (name.to_string(), s.clone()))
        .collect();
    let config = Config { values };

    let s = toml::ser::to_string(&config).unwrap();
    println!("{}", s);
}

输出结果和自定义实现完全一致，反序列化也可以自动转换回标准Option类型。

注意：需要根据你的业务场景选择合适的空值占位符，避免和正常配置值产生冲突。如果数值类型的可选范围覆盖了所有可能的数值，建议使用字符串类型的占位符。

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