在json反序列化期间确定类型

Question

我正在开发一种协议，在该协议中，接收方将接收特定自定义类型的json消息(当前为5个，但也可以是10-20个)。我正在努力想出一个最优/快速的解决方案，它将自动反序列化json并返回正确类型的对象。

示例：

public class MessageA
{
    public string Message;
} 

public class MessageB
{
    public int value;
}

public class MessageC
{
    public string ValueA;
    public string ValueB;
}

理想情况下，该方法应该类似于

 Object Deserialize(string json);

它将返回三种消息类型中的一种或null -以防出现解析错误/ json与任何预定义类型都不匹配。

更新:我可以控制发送者/接收者以及协议设计。

Answer 1

如果消息可以指定它的类型，这将是很有帮助的。否则，您必须从某些属性或其他属性中推断它。

您可以在序列化时使用消息包装类，如下所示：

public class MessageWrapper<T>
{
    public string MessageType { get { return typeof(T).FullName; } }
    public T Message { get; set; }
}

因此，如果你有一个带有First和Last属性的Name类，你可以像这样序列化它：

var nameMessage = new MessageWrapper<Name>();
nameMessage.Message = new Name {First="Bob", Last = "Smith"};
var serialized = JsonConvert.SerializeObject(nameMessage);

序列化的JSON是

{"MessageType":"YourAssembly.Name","Message":{"First":"Bob","Last":"Smith"}}

反序列化时，首先将JSON反序列化为此类型：

public class MessageWrapper
{
    public string MessageType { get; set; }
    public object Message { get; set; }
}

var deserialized = JsonConvert.DeserializeObject<MessageWrapper>(serialized);

从MessageType属性中提取消息类型。

var messageType = Type.GetType(deserialized.MessageType);

既然知道了类型，就可以反序列化Message属性了。

var message = JsonConvert.DeserializeObject(
    Convert.ToString(deserialized.Message), messageType);

message是一个object，但您可以将其转换为Name或任何实际的类。

Answer 2

var log = JsonConvert.DeserializeObject<Log>(File.ReadAllText("log.example.json");

public class Log
{
    [JsonConverter(typeof(MessageConverter))]
    public object[] Messages { get; set; }
}


public class MessageA
{
    public string Message;
}
public class MessageB
{
    public int value;
}
public class MessageC
{
    public string ValueA;
    public string ValueB;
}

public class MessageConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return true;
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        object ReadMessage(JObject jobject)
        {
            if (jobject.Property("Message") != null)
                return jobject.ToObject<MessageA>(serializer);
            if (jobject.Property("value") != null)
                return jobject.ToObject<MessageB>(serializer);
            if (jobject.Property("ValueA") != null)
                return jobject.ToObject<MessageC>(serializer);
            throw new Exception("Type is not recognized");
        }

        var jarray = JArray.Load(reader);
        return jarray.Select(jitem => ReadMessage((JObject)jitem)).ToArray();
    }


    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

Json示例：

{
  "Messages":
  [
    {"Message": "System halted"},
    {"value": 42},
    {"ValueA": "Bob", "ValueB": "Smith"}
  ]
}

Answer 3

希望您熟悉工厂模式，您可以使用工厂并将“类型”属性作为json的一部分，让我们称其为_t。

您可以自己解析json字符串并找到_t属性的值，将其反序列化为dynamic并获取jsonObj._t，或者使用仅包含_t字段的简单class将json反序列化为初始json。

然后，您可以将表示C#类型的string传递给工厂，并为该Type获取一个json反序列化器。

然后，您可以使所有传出和传入调用分别添加和处理_t参数，以便将来可以轻松添加新类型，只需向工厂添加和注册该Type所需的序列化程序/反序列化程序即可。