Newtonsoft.Json反序列化带IConvertible的自定义FriendlyUrl类型时抛转换异常
问题根因解析
这个异常的核心触发逻辑和Newtonsoft.Json的内置契约优先级规则直接相关:
- 当Newtonsoft.Json检测到目标类型实现了
IConvertible接口时,会自动为其生成PrimitiveContract(基础值类型契约),优先级高于TypeConverter、自定义隐式转换运算符的适配逻辑 - 反序列化过程中,Newtonsoft读到JSON里的字符串值后,会调用系统内置的
Convert.ChangeType方法尝试将字符串转换为目标FriendlyUrl类型;这个方法处理转换时,会优先调用源值(也就是读到的字符串)自带的IConvertible.ToType逻辑,而.NET内置的string类型不认识自定义的FriendlyUrl类型,直接抛出InvalidCastException——整个过程完全不会触发你写的FriendlyUrl类上的任何转换逻辑 - 之前移除
IConvertible实现时运行正常,本质是去掉了触发PrimitiveContract的条件,Newtonsoft会退回使用你配置的TypeConverter完成字符串到自定义类型的转换;你之前尝试加[JsonObject]特性无效,也是因为PrimitiveContract的优先级远高于对象类契约的配置。
修复方案
以下方案完全保留你必须实现IConvertible的业务要求,原有类的核心逻辑、转换运算符、TypeConverter配置都不需要做任何改动,仅需补充适配逻辑即可:
最稳定、维护成本最低的方式是为FriendlyUrl类型编写专属的JsonConverter——自定义Converter的优先级高于Newtonsoft的内置契约生成逻辑,会直接绕开触发报错的内置转换流程。
- 第一步:编写Converter实现
public class FriendlyUrlJsonConverter : Newtonsoft.Json.JsonConverter { public override bool CanConvert(Type objectType) { // 仅处理FriendlyUrl类型的序列化/反序列化 return objectType == typeof(FriendlyUrl); } public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { // 处理null值场景 if (reader.TokenType == JsonToken.Null) return null; // 读取JSON中的字符串值,直接复用你已有的隐式转换逻辑生成实例 var stringValue = reader.Value as string; return (FriendlyUrl)stringValue; } public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { // 序列化时直接输出FriendlyUrl对应的字符串值,和原有序列化预期保持一致 var friendlyUrl = (FriendlyUrl)value; writer.WriteValue(friendlyUrl.ToString()); } }
- 第二步:让Converter生效,二选一即可
- 直接在
FriendlyUrl类定义上挂Converter特性,和已有的TypeConverter特性并列放置:
- 直接在
[JsonConverter(typeof(FriendlyUrlJsonConverter))] [TypeConverter(typeof(FriendlyUrlTypeConverter))] public class FriendlyUrl : IEquatable<FriendlyUrl>, IConvertible { // 原有代码全部保留即可 }
- 如果不想修改类上的特性标注,可以在全局序列化配置中注册Converter,在所有调用序列化/反序列化的地方统一传入配置:
var globalSettings = new JsonSerializerSettings(); globalSettings.Converters.Add(new FriendlyUrlJsonConverter()); // 后续使用时传入settings即可 string json = JsonConvert.SerializeObject(friendlyUrl, globalSettings); FriendlyUrl deserialized = JsonConvert.DeserializeObject<FriendlyUrl>(json, globalSettings);
效果验证
按照上述方案调整后,原有的测试用例可直接通过:
- 序列化输出的JSON依然是纯字符串格式
"some-friendly-url-1",和之前的预期完全一致 - 反序列化时会直接走Converter的自定义逻辑,不会触发内置的错误转换流程
- 类上的
IConvertible实现可以完全保留,不影响其他业务模块依赖IConvertible的功能逻辑
内容的提问来源于stack exchange,提问作者AlexB
相关产品推荐
相关产品推荐

