JsonConvert反序列化枚举转换

适用场景:反序列化对象里面存在枚举类型

说明

在使用JsonConvert.DeserializeObject 转换对象的时候,想要更直观的看到值对应的含义,一般会设定一个枚举值,但是在转换的时候,由于传入值的不确定,会无法识别枚举具体类型而报错,需要我们手动拓展

实现

实现方式主要是通过继承JsonConverter,在转换的过程中添加对输入值,以及输出对象的格式进行校验,确保能安全准确的处理枚举类型

核心代码:

复制代码
    public class SafeEnumConverter<T> : JsonConverter where T : struct
    {
        public override bool CanConvert(Type objectType)
        {
            return objectType == typeof(T);
        }

        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
        {
            if (reader.TokenType == JsonToken.String)
            {
                var enumText = reader.Value.ToString();
                if (string.IsNullOrEmpty(enumText))
                    return default(T);

                // 先尝试数字
                int intValue;
                if (int.TryParse(enumText, out intValue))
                    return (T)Enum.ToObject(typeof(T), intValue);

                // 再尝试枚举名
                T value;
                if (Enum.TryParse<T>(enumText, true, out value))
                    return value;
            }
            else if (reader.TokenType == JsonToken.Integer)
            {
                return (T)Enum.ToObject(typeof(T), Convert.ToInt32(reader.Value));
            }
            return default(T);
        }

        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
        {
            writer.WriteValue(Convert.ToInt32(value));
        }
    }
  1. 通过重写CanConvert,判断当前转换器是否能处理类型 T,只针对类型T进行转换
  2. ReadJson是转换的核心,实现将 JSON 字符串或数字安全地转换为枚举类型 T。
    • 如果 JSON 是字符串(如 "1" 或 "EnumName"):
      先尝试转成数字(如 "1" → 1 → 枚举值)。
      再尝试转成枚举名(如 "EnumName" → 枚举值)。
    • 如果 JSON 是数字(如 1):
      直接转成枚举值。
    • 如果都不行,返回默认值(通常是0)。
  3. WriteJson:结果输出,将枚举值序列化为数字(int),而不是字符串。

使用方法

在需要的枚举属性上加特性,或全局注册:

复制代码
[JsonConverter(typeof(SafeEnumConverter<MyEnum>))]
public MyEnum Status { get; set; }

或者

复制代码
JsonConvert.DeserializeObject<T>(json, new SafeEnumConverter<MyEnum>());

能兼容数字、字符串等多种Json输入的转换

相关推荐
ajassi20001 小时前
开源 C# 快速开发(十一)线程
http·开源·c#
周杰伦fans9 小时前
C# 23种设计模式详解与示例
开发语言·设计模式·c#
xb113211 小时前
C#——方法的定义、调用与调试
开发语言·c#
code bean11 小时前
【C#】以 BlockingCollection 为核心的多相机 YOLO 检测任务处理框架
c#
时光追逐者12 小时前
一款专门为 WPF 打造的开源 Office 风格用户界面控件库
ui·开源·c#·.net·wpf
刚子编程13 小时前
.NET开发中3秒判断该用 IEnumerable 还是 IQueryable
.net
聊聊MES那点事15 小时前
面向.NET开发者:Prosys OPC UA .NET SDK 全面解析
.net·数据采集·prosys opc
喵叔哟15 小时前
3. 从0到上线:.NET 8 + ML.NET LTR 智能类目匹配实战--从业务到方案:消费类目智能匹配的整体设计
.net
-可乐加冰吗15 小时前
SuperMap iObjects .NET 11i 二次开发(十五)—— 类型转换之面转点
visualstudio·c#·.net
百锦再15 小时前
从 .NET 到 Java 的转型指南:详细学习路线与实践建议
android·java·前端·数据库·学习·.net·数据库架构