如何使用 Json.Net 反序列化枚举类的 json 属性？

Question

我试图避免使用枚举，而是使用枚举类，例如此处https://docs.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/enumeration-classes-over-enum-types

现在我有下面的例子

public class Dto
{
public string Name {get;set;}
public StatusType Status {get;set;}
}

public class StatusType : Enumeration
{
public static readonly StatusType Active = new StatusType (1, "Active");
public static readonly StatusType Inactive = new StatusType (2, "Inactive");
}

当我尝试反序列化 Dto 时，例如

var message = JsonConvert.DeserializeObject<Dto>(test);

我收到一个错误“将值“Active”转换为“StatusType”时出错。

是否可以使用或创建一个转换器，将值“Active”实际转换为适当的 StatusType？

Answer 1

您需要编写自定义JsonConverter。比如这样：

public class StatusTypeConverter : JsonConverter<StatusType>
{
    // can be build with reflection 
    private static Dictionary<string, StatusType> _map = new Dictionary<string, StatusType>(StringComparer.InvariantCultureIgnoreCase)
    {
        {StatusType.Active.Name, StatusType.Active},
        {StatusType.Inactive.Name, StatusType.Inactive}
    };
    public override void WriteJson(JsonWriter writer, StatusType value, JsonSerializer serializer)
    {
        writer.WriteValue(value.Name);
    }

    public override StatusType ReadJson(JsonReader reader, Type objectType, StatusType existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        string s = (string)reader.Value;

        return _map[s];
    }
}

public class Dto
{
    public string Name { get; set; }
    [JsonConverter(typeof(StatusTypeConverter))]
    public StatusType Status { get; set; }
}

var js = "{'name': 'Name', 'status': 'active'}";
Console.WriteLine(JsonConvert.DeserializeObject<Dto>(js).Status.Name); // prints "Active"

这段代码显然可以改进（缺少键的有意义的例外，构建可以处理Enumeration 的所有子类型的转换器）。