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输入的转换

相关推荐
YuanlongWang3 小时前
C# 基础——装箱和拆箱
java·开发语言·c#
QQ12958455048 小时前
C# 如何能够创建一个MVC的WEB项目
c#·mvc
星河队长11 小时前
VS创建C++动态库和C#访问过程
java·c++·c#
专注VB编程开发20年11 小时前
B.NET编写不阻塞UI线程的同步延时
ui·.net·vb.net·doevents
William_cl12 小时前
【C# MVC 前置】异步编程 async/await:从 “卡界面” 到 “秒响应” 的 Action 优化指南(附微软官方避坑清单)
microsoft·c#·mvc
yong999012 小时前
C#驱动斑马打印机实现包装自动打印
java·数据库·c#
Jose_lz13 小时前
C#开发学习杂笔(更新中)
开发语言·学习·c#
mingupup13 小时前
WPF/C#:使用Microsoft Agent Framework框架创建一个带有审批功能的终端Agent
c#·wpf
慧都小妮子15 小时前
基于.NET UA Client SDK构建跨平台OPC UA客户端应用
.net·opc ua·automation·跨平台应用·unified
追逐时光者15 小时前
C#/.NET/.NET Core技术前沿周刊 | 第 58 期(2025年10.13-10.19)
后端·.net