为JSON数据编写具有多种可能类型的JSON数据的类

Question

走出Python世界并进入C＃，我在定义可以用于解码我的JSON有效载荷的课程时遇到了一些麻烦。

在Python中，我通常将Pydantic用于此类问题，因此我将说明：

from typing import Literal, Union
from pydantic import BaseModel

class Foo(BaseModel):
    kind: Literal["foo"]
    fizz: int

class Bar(BaseModel):
    kind: Literal["bar"]
    buzz: str

Payload = Union[Foo, Bar]

class Message(BaseModel):
    payload: Payload

类消息遵循以下JSON Schema：

type: object
required: [payload]
properties:
  payload:
    anyOf:
    - $ref: '#/definitions/Foo'
    - $ref: '#/definitions/Bar'
definitions:
  Foo:
    type: object
    required: [kind, fizz]
    properties:
      kind: {enum: [foo], type: string}
      fizz: {type: integer}
  Bar:
    type: object
    required: [kind, buzz]
    properties:
      kind: {enum: [bar], type: string}
      buzz: {type: string}

研究后，我无法找到将这些概念映射到C＃的最佳方法。据我了解，C＃没有字符串类型，因此我无法使用这些字符串类型。我还不确定定义Union类型的正确方法。

在C＃中为此有效载荷建模类的最务实的方法是什么，以便我可以解码并将此数据编码为JSON？到目前为止，我一直在使用newtonsoft.json，但是如果这使它更容易，我对其他工具开放。

我在C＃版本中想象我会有这样的东西

interface Payload
{
    public string kind { get; set; }
}

class Foo : Payload
{
    public string kind { get; set; }
    public int fizz { get; set; }
}
class Buzz : Payload
{
    public string kind { get; set; }
    public string buzz { get; set; }
}

class Message
{
    public Payload Payload { get; set; }
}

：

Answer 1

好的，所以我最终得到了这一点，但是感觉超级尴尬...

也许有人可以提出改进：

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
...

public interface Payload { }

public class Foo : Payload
{
    [JsonProperty("kind")]
    public string Kind { get; set; } = "foo";

    [JsonProperty("fizz")]
    public int Fizz { get; set; };
}

public class Bar : Payload
{
    [JsonProperty("kind")]
    public string Kind { get; set; } = "bar";

    [JsonProperty("buzz")]
    public string Buzz { get; set; };
}

public class Message
{
    [JsonProperty("payload")]
    [JsonConverter(typeof(PayloadConverter))]
    public Payload Payload { get; set; }
}

然后定义一个自定义的jsonConverter以获取消息：

public class PayloadConverter : JsonConverter
{
    public override bool CanConvert(Type objectType) =>
        typeof(Payload).IsAssignableFrom(objectType);

    public override object ReadJson(
        JsonReader reader, 
        Type objectType,
        object existingValue,
        JsonSerializer serializer)
    {
        JObject obj = JObject.Load(reader);

        Payload item = obj["kind"].ToString() switch
        {
            "foo" => new Foo(),
            "bar" => new Bar(),
            _ => null
        };
        if (item == null) return null;
        serializer.Populate(obj.CreateReader(), item);
        return item;
    }

    public override void WriteJson(
        JsonWriter writer, 
        object value, 
        JsonSerializer serializer)
    {
        serializer.Serialize(writer, value);
    }
}