.NET 5 System.Text.Json 反序列化带连字符枚举值抛JsonException的解决
.NET 5 System.Text.Json 反序列化带短横线枚举字符串异常解决方案
异常根因
当前碰到的解析失败,本质是.NET 5版本内置JsonStringEnumConverter的实现限制导致的:
- 该版本的转换器仅支持将JSON字符串值与C#枚举成员的原生名称做大小写不敏感匹配,完全不会识别枚举成员上标注的
EnumMemberAttribute自定义值 - 你标注的
"link-local"值和枚举成员名LinkLocal本身无法匹配,转换器读不到你设置的自定义映射关系,自然无法完成转换,直接抛出JsonException
可落地的解决办法
- 方案1:升级框架版本到.NET 6及以上
从.NET 6开始,内置的JsonStringEnumConverter已经原生支持读取EnumMemberAttribute里定义的自定义值,你现在写的枚举定义不需要做任何业务改动,升级框架后就能直接正常解析带短横线的枚举值,是长期维护成本最低的方案。 - 方案2:在.NET 5环境下自定义转换器适配现有逻辑
如果暂时无法升级框架,可以通过自定义枚举转换器绕过内置实现的限制,核心逻辑是在序列化/反序列化过程中主动读取枚举成员上的EnumMember特性值完成映射,不需要改动现有业务的枚举定义。
自定义转换器参考实现(直接替换内置JsonStringEnumConverter即可):
只需要把枚举上标注的转换器类型替换为自定义实现即可:public class EnumMemberSupportedConverter : JsonStringEnumConverter { public override void Write(Utf8JsonWriter writer, object value, Type type, JsonSerializerOptions options) { var enumType = Nullable.GetUnderlyingType(type) ?? type; var memberInfo = enumType.GetMember(value.ToString()).FirstOrDefault(); var customValue = memberInfo?.GetCustomAttribute<EnumMemberAttribute>()?.Value; if (!string.IsNullOrEmpty(customValue)) { writer.WriteStringValue(customValue); } else { base.Write(writer, value, type, options); } } public override object Read(ref Utf8JsonReader reader, Type type, JsonSerializerOptions options) { var enumType = Nullable.GetUnderlyingType(type) ?? type; var inputValue = reader.GetString(); foreach (var memberInfo in enumType.GetMembers()) { var customValue = memberInfo.GetCustomAttribute<EnumMemberAttribute>()?.Value; if (customValue == inputValue) { return Enum.Parse(enumType, memberInfo.Name); } } // 没有匹配到自定义值时,走内置的默认解析逻辑兜底 return base.Read(ref reader, type, options); } }[JsonConverter(typeof(EnumMemberSupportedConverter))] public enum TypeEnum { [EnumMember(Value = "loopback")] Loopback = 1, [EnumMember(Value = "link-local")] LinkLocal = 2, } - 排查提示
你贴出的核心JSON片段中,"address": "fe80::3617:ebff:fec0:b54c/64"这行末尾缺少逗号,如果不是复制时遗漏的语法问题,这类JSON格式错误也会触发解析异常,可以在排查时优先校验原始JSON的语法正确性。
内容的提问来源于stack exchange,提问作者DaveR
相关产品推荐
相关产品推荐

