rust - 通过数值作为类型标识符的 serde 反序列化 json

Question

我对 rust 很陌生，并且来自 OOP 背景。所以，也许我误解了一些 rust 基础知识。

我想用 serde 解析一个固定的 json 结构。此结构代表不同的消息类型之一。每条消息都有一个数字 type 属性来区分它。各个消息类型的确切结构差异很大，但也可以相同。

{"type": 1, "sender_id": 4, "name": "sender", ...}
{"type": 2, "sender_id": 5, "measurement": 3.1415, ...}
{"type": 3, "sender_id": 6, "measurement": 13.37, ...}
...

首先，我定义了一个 enum 来区分消息类型，还为每种类型的消息定义了一个 struct，而没有存储类型的字段。

#[derive(Debug, Serialize, Deserialize)]
#[serde(tag = "type")]
enum Message {
    T1(Type1),
    T2(Type2),
    T3(Type3),
    // ...
}

#[derive(Debug, Serialize, Deserialize)]
struct Type1 {
    sender_id: u32,
    name: String,
    // ...
}
#[derive(Debug, Serialize, Deserialize)]
struct Type2 {
    sender_id: u32,
    measurement: f64,
    // ...
}
#[derive(Debug, Serialize, Deserialize)]
struct Type3 {
    sender_id: u32,
    measurement: f64,
    // ...
}
// ...

当我尝试将字符串转换为 Message 对象时，出现错误。

let message = r#"{"type":1,"sender_id":123456789,"name":"sender"}"#;
let message: Message = serde_json::from_str(message)?; // error here
// Error: Custom { kind: InvalidData, error: Error("invalid type: integer `1`, expected variant identifier", line: 1, column: 9) }

所以，据我了解，serde 试图找出当前消息的类型，但它需要一个字符串为了那个原因。我还尝试编写自己的 deserialize() 函数。我试图得到数值对应的 type-key 并希望通过 type 值创建特定的对象。

我必须如何实现 deserialize() 来提取消息的类型并创建特定的消息对象？是否可以在不为每个 Type1/2/3/... 结构编写 deserialize()-function 的情况下编写它？

impl<'de> Deserialize<'de> for Message {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
                  where D: Deserializer<'de>,
{
    // which functions I have to call?
}

或者有没有更好的解决方案来实现我的反序列化？

我为这个问题准备了一个 Playground :Playground

Answer 1

Serde 还不支持整数标签(参见 issue #745)。

---

如果您能够更改生成数据的内容，那么如果您能够将 type 更改为字符串，即 "1" 而不是 1。然后你可以简单地使用 #[serde(rename)] 让它工作。 .

#[derive(Debug, Serialize, Deserialize)]
#[serde(tag = "type")]
enum Message {
    #[serde(rename = "1")]
    T1(Type1),
    #[serde(rename = "2")]
    T2(Type2),
    #[serde(rename = "3")]
    T3(Type3),
    // ...
}

---

如果这不是一个选项，那么您确实需要创建一个自定义反序列化程序。代码最短，很可能反序列化为 serde_json::Value ，然后在type上进行匹配，并deserialize将serde_json::Value变成正确的Type{1,2,3} .

use serde_json::Value;

impl<'de> serde::Deserialize<'de> for Message {
    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
        let value = Value::deserialize(d)?;

        Ok(match value.get("type").and_then(Value::as_u64).unwrap() {
            1 => Message::T1(Type1::deserialize(value).unwrap()),
            2 => Message::T2(Type2::deserialize(value).unwrap()),
            3 => Message::T3(Type3::deserialize(value).unwrap()),
            type_ => panic!("unsupported type {:?}", type_),
        })
    }
}

您可能想要执行一些正确的error handling ，而不是展开和 panic 。

---

如果您还需要序列化，那么您同样需要自定义序列化程序。为此，您可以创建一个新类型来序列化，因为您不能使用 Message。

use serde::Serializer;

impl Serialize for Message {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        #[derive(Serialize)]
        #[serde(untagged)]
        enum Message_<'a> {
            T1(&'a Type1),
            T2(&'a Type2),
            T3(&'a Type3),
        }

        #[derive(Serialize)]
        struct TypedMessage<'a> {
            #[serde(rename = "type")]
            t: u64,
            #[serde(flatten)]
            msg: Message_<'a>,
        }

        let msg = match self {
            Message::T1(t) => TypedMessage { t: 1, msg: Message_::T1(t) },
            Message::T2(t) => TypedMessage { t: 2, msg: Message_::T2(t) },
            Message::T3(t) => TypedMessage { t: 3, msg: Message_::T3(t) },
        };
        msg.serialize(serializer)
    }
}

---

使用 #[serde(flatten)] 时, 然后它使用 serde::private::ser::FlatMapSerializer ，这是隐藏在文档中的。代替创建新类型，您可以使用 SerializeMap和 FlatMapSerializer.

但是，请注意，鉴于它没有文档记录，如果您直接使用 FlatMapSerializer，那么任何 future 版本的 serde都可能破坏您的代码。

use serde::{private::ser::FlatMapSerializer, ser::SerializeMap, Serializer};

impl Serialize for Message {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut s = serializer.serialize_map(None)?;

        let type_ = &match self {
            Message::T1(_) => 1,
            Message::T2(_) => 2,
            Message::T3(_) => 3,
        };
        s.serialize_entry("type", &type_)?;

        match self {
            Message::T1(t) => t.serialize(FlatMapSerializer(&mut s))?,
            Message::T2(t) => t.serialize(FlatMapSerializer(&mut s))?,
            Message::T3(t) => t.serialize(FlatMapSerializer(&mut s))?,
        }

        s.end()
    }
}