19

我想使用Serde来解析一些 JSON 作为 HTTP PATCH 请求的一部分。由于 PATCH 请求不传递整个对象，仅传递要更新的相关数据，因此我需要能够区分未传递的值、显式设置为null的值和存在的值。

我有一个具有多个可为空字段的值对象：

struct Resource {
    a: Option<i32>,
    b: Option<i32>,
    c: Option<i32>,
}

如果客户端这样提交 JSON：

{"a": 42, "b": null}

我想更改a为Some(42)、btoNone并c保持不变。

我尝试将每个字段包装在一个以上级别Option：

#[derive(Debug, Deserialize)]
struct ResourcePatch {
    a: Option<Option<i32>>,
    b: Option<Option<i32>>,
    c: Option<Option<i32>>,
}

操场

这并没有区分b和c; 两者都是，None但我本来想b成为Some(None)。

我不依赖于嵌套Options 的这种表示；任何可以区分这 3 种情况的解决方案都可以，例如使用自定义枚举的解决方案。

4

3 回答 3

13

基于E_net4 的 answer，您还可以为三种可能性创建一个枚举：

#[derive(Debug)]
enum Patch<T> {
    Missing,
    Null,
    Value(T),
}

impl<T> Default for Patch<T> {
    fn default() -> Self {
        Patch::Missing
    }
}

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

impl<'de, T> Deserialize<'de> for Patch<T>
where
    T: Deserialize<'de>,
{
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        Option::deserialize(deserializer).map(Into::into)
    }
}

这可以用作： 

#[derive(Debug, Deserialize)]
struct ResourcePatch {
    #[serde(default)]
    a: Patch<i32>,
}

不幸的是，您仍然必须使用#[serde(default)]（或将其应用于整个结构）来注释每个字段。理想情况下， for 的实现Deserialize将Patch完全处理这个问题，但我还没有弄清楚如何做到这一点。

于 2017-06-02T15:46:32.873 回答
12

很可能，现在实现这一目标的唯一方法是使用自定义反序列化函数。幸运的是，它并不难实现，甚至可以让它适用于任何类型的领域：

fn deserialize_optional_field<'de, T, D>(deserializer: D) -> Result<Option<Option<T>>, D::Error>
where
    D: Deserializer<'de>,
    T: Deserialize<'de>,
{
    Ok(Some(Option::deserialize(deserializer)?))
}

然后每个字段将被注释为：

#[serde(deserialize_with = "deserialize_optional_field")]
a: Option<Option<i32>>,

您还需要用 注释结构#[serde(default)]，以便将空字段反序列化为“未包装” None。诀窍是将当前值包装在Some.

序列化依赖于另一个技巧：当字段为 时跳过序列化None：

#[serde(deserialize_with = "deserialize_optional_field")]
#[serde(skip_serializing_if = "Option::is_none")]
a: Option<Option<i32>>,

带有完整示例的游乐场。输出：

Original JSON: {"a": 42, "b": null}
> Resource { a: Some(Some(42)), b: Some(None), c: None }
< {"a":42,"b":null}
于 2017-06-02T14:44:29.687 回答
1

建立在Shepmaster 的答案并添加序列化。

use serde::ser::Error;
use serde::{Deserialize, Deserializer};
use serde::{Serialize, Serializer};

// #region ------ JSON Absent support
// build up on top of https://stackoverflow.com/a/44332837

/// serde Valueue that can be Absent, Null, or Valueue(T)
#[derive(Debug)]
pub enum Maybe<T> {
    Absent,
    Null,
    Value(T),
}

#[allow(dead_code)]
impl<T> Maybe<T> {
    pub fn is_absent(&self) -> bool {
        match &self {
            Maybe::Absent => true,
            _ => false,
        }
    }
}

impl<T> Default for Maybe<T> {
    fn default() -> Self {
        Maybe::Absent
    }
}

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

impl<'de, T> Deserialize<'de> for Maybe<T>
where
    T: Deserialize<'de>,
{
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let d = Option::deserialize(deserializer).map(Into::into);
        d
    }
}

impl<T: Serialize> Serialize for Maybe<T> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            // this will be serialized as null
            Maybe::Null => serializer.serialize_none(),
            Maybe::Value(v) => v.serialize(serializer),
            // should have been skipped
            Maybe::Absent => Err(Error::custom(
                r#"Maybe fields need to be annotated with: 
  #[serde(default, skip_serializing_if = "Maybe::is_Absent")]"#,
            )),
        }
    }
}
// #endregion --- JSON Absent support

然后你可以这样使用它：

#[derive(Serialize, Deserialize, Debug)]
struct Rect {
    #[serde(default, skip_serializing_if = "Maybe::is_absent")]
    stroke: Maybe<i32>,

    w: i32,

    #[serde(default, skip_serializing_if = "Maybe::is_absent")]
    h: Maybe<i32>,
}


// .... 


let json = r#"
{
  "stroke": null,
  "w": 1
}"#;
    
let deserialized: Rect = serde_json::from_str(json).unwrap();
println!("deserialized = {:?}", deserialized);
// will output: Rect { stroke: Null, w: 1, h: Absent }

let serialized = serde_json::to_string(&deserialized).unwrap();
println!("serialized back = {}", serialized);
// will output: {"stroke":null,"w":1}

我希望 Serde 有一种内置的方式来处理 JSONnull和absent状态。

2021-03-12 更新- 更新Maybe::Absent为更符合 JSON 和 SQL DSL 的习惯。

这种方法的问题在于我们可以表达：

  • type | null使用默认值Option<type>
  • type | null | absent和Maybe<type>

但我们无法表达

  • type | absent

解决方案是重构Maybe为仅拥有::Present(value)和::Absent支持Maybe<Option<type>>. type | null | absent因此，这将为我们提供全面的覆盖。

  • type | null使用默认值Option<type>
  • type | absent和Maybe<type>
  • type | absent | null和Maybe<Option<type>>

我正在尝试在不添加#[serde(deserialize_with = "deserialize_maybe_field")]但不确定是否可能的情况下实现这一点。我可能遗漏了一些明显的东西。

于 2021-03-02T06:07:41.680 回答