c# - Newtonsoft Json.NET JsonConverter 属性在反序列化时保留引用问题
问题描述
在一个项目的模型中,我使用一个JsonConverter
属性来帮助这些模型的(反)序列化。
转换器目前看起来像这样:
public class CustomJsonConverter : Newtonsoft.Json.JsonConverter
{
bool _canWrite = true;
public override bool CanWrite
{
get { return _canWrite; }
}
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
serializer.PreserveReferencesHandling = PreserveReferencesHandling.Objects;
serializer.DefaultValueHandling = DefaultValueHandling.Ignore;
serializer.NullValueHandling = NullValueHandling.Ignore;
_canWrite = false;
var jObject = JObject.FromObject(value, serializer);
_canWrite = true;
jObject.WriteTo(writer);
}
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
serializer.PreserveReferencesHandling = PreserveReferencesHandling.Objects;
if (reader.TokenType == JsonToken.StartObject)
{
existingValue = existingValue ?? serializer.ContractResolver.ResolveContract(objectType).DefaultCreator();
serializer.Populate(reader, existingValue);
return existingValue;
}
else if (reader.TokenType == JsonToken.Null)
{
return null;
}
else
{
throw new JsonSerializationException();
}
}
public override bool CanConvert(Type objectType)
{
return typeof(IModelBase).IsAssignableFrom(objectType);
}
}
这些模型有一个如下所示的基类:
[JsonConverter(typeof(CustomJsonConverter))]
public abstract class ModelBase : IModelBase
{
public string ID { get; set; }
public DateTime CreatedAt { get; set; }
public DateTime ModifiedAt { get; set; }
}
类的派生类ModelBase
具有类型也派生自的属性ModelBase
。例如:
public class CustomerModel : ModelBase
{
public string Name { get; set; }
public UserModel CreatedBy { get; set; }
public UserModel ModifiedBy { get; set; }
}
public class UserModel : ModelBase
{
public string Name { get; set; }
public UserModel CreatedBy { get; set; }
public UserModel ModifiedBy { get; set; }
}
我在 ASP.NET Web API 2 应用程序(服务器端)和 C# 应用程序(客户端)中使用这些模型。对于大多数 API 调用,会返回一个模型数组。序列化模型时,事情按预期工作。但是,在反序列化时,只有每个引用的第一次出现才会填充信息。
例如:
[
{
"$id": "1",
"Name": "Customer1",
"CreatedBy": {
"$id": "2",
"ID": "1",
"Name": "User1"
},
"ModifiedBy": {
"$id": "3",
"ID": "3",
"Name": "User3"
},
"ID": "1",
"CreatedAt": "2019-02-06T00:00:04",
"ModifiedAt": "2019-02-06T00:20:12"
},
{
"$id": "4",
"Name": "Customer2",
"CreatedBy": {
"$ref": "2"
},
"ModifiedBy": {
"$ref": "2"
},
"ID": "2",
"CreatedAt": "2019-02-06T00:10:00",
"ModifiedAt": "2019-02-06T00:10:00"
}
]
当尝试反序列化 Web API 返回的这个 JSON 对象时,第一个对象的CreatedBy
和ModifiedBy
属性将是正确的CustomerModel
。然而,对于第二个CustomerModel
对象,这些属性将是UserModel
没有设置任何属性的新实例。
为了反序列化 JSON 字符串,我使用以下代码:
using (var sr = new StreamReader(streamFromWebAPICall))
{
using (var jtr = new JsonTextReader(sr))
{
var js = new JsonSerializer();
return js.Deserialize(jtr, objectType);
}
}
如何正确设置所有反序列化对象的属性?
编辑:
问题似乎出在serializer.Populate(reader, existingValue)
不记得引用的地方。
解决方案
您的基本问题是您正在为您还想要启用的类型提供自定义JsonConverter
PreserveReferencesHandling
。但是无论何时应用自定义转换器,它都必须手动处理所有事情,包括解析和生成"$ref"
和"$id"
属性。您的转换器不这样做,因此您的反序列化代码无法正确反序列化您的对象图。
Custom object serialization vs PreserveReferencesHandling的公认答案包括一个模板转换器,它显示了如何处理这些属性。但是,由于您的转换器似乎只是在(反)序列化之前切换一些序列化程序设置,您可以简单地调用递归(反)序列化对象,在持续时间内禁用转换器,如下所示:
public class CustomJsonConverter : Newtonsoft.Json.JsonConverter
{
[ThreadStatic]
static bool disabled;
// Disables the converter in a thread-safe manner.
bool Disabled { get { return disabled; } set { disabled = value; } }
public override bool CanWrite { get { return !Disabled; } }
public override bool CanRead { get { return !Disabled; } }
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
using (new PushValue<bool>(true, () => Disabled, val => Disabled = val))
using (new PushValue<PreserveReferencesHandling>(PreserveReferencesHandling.Objects, () => serializer.PreserveReferencesHandling, val => serializer.PreserveReferencesHandling = val))
using (new PushValue<DefaultValueHandling>(DefaultValueHandling.Ignore, () => serializer.DefaultValueHandling, val => serializer.DefaultValueHandling = val))
using (new PushValue<NullValueHandling>(NullValueHandling.Ignore, () => serializer.NullValueHandling, val => serializer.NullValueHandling = val))
{
serializer.Serialize(writer, value);
}
}
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
if (reader.TokenType == JsonToken.Null)
{
return null;
}
using (new PushValue<bool>(true, () => Disabled, val => Disabled = val))
using (new PushValue<PreserveReferencesHandling>(PreserveReferencesHandling.Objects, () => serializer.PreserveReferencesHandling, val => serializer.PreserveReferencesHandling = val))
using (new PushValue<DefaultValueHandling>(DefaultValueHandling.Ignore, () => serializer.DefaultValueHandling, val => serializer.DefaultValueHandling = val))
using (new PushValue<NullValueHandling>(NullValueHandling.Ignore, () => serializer.NullValueHandling, val => serializer.NullValueHandling = val))
{
return serializer.Deserialize(reader, objectType);
}
}
public override bool CanConvert(Type objectType)
{
throw new NotImplementedException();
}
}
public struct PushValue<T> : IDisposable
{
Action<T> setValue;
T oldValue;
public PushValue(T value, Func<T> getValue, Action<T> setValue)
{
if (getValue == null || setValue == null)
throw new ArgumentNullException();
this.setValue = setValue;
this.oldValue = getValue();
setValue(value);
}
// By using a disposable struct we avoid the overhead of allocating and freeing an instance of a finalizable class.
public void Dispose()
{
if (setValue != null)
setValue(oldValue);
}
}
请注意,禁用转换器的逻辑需要线程安全,因为 Json.NET 将跨线程共享合约和转换器。
演示小提琴#1在这里。
作为替代方案,您可以完全消除转换器并[JsonObject(IsReference = true)]
直接应用于ModelBase
:
[JsonObject(IsReference = true)]
public abstract class ModelBase : IModelBase
{
public string ID { get; set; }
public DateTime CreatedAt { get; set; }
public DateTime ModifiedAt { get; set; }
}
然后序列化和反序列化,DefaultValueHandling.Ignore
并NullValueHandling.Ignore
在设置中指定,如下所示:
static object Deserialize(Stream streamFromWebAPICall, Type objectType)
{
using (var sr = new StreamReader(streamFromWebAPICall))
{
using (var jtr = new JsonTextReader(sr))
{
var settings = new JsonSerializerSettings
{
DefaultValueHandling = DefaultValueHandling.Ignore,
NullValueHandling = NullValueHandling.Ignore,
};
var js = JsonSerializer.CreateDefault(settings);
return js.Deserialize(jtr, objectType);
}
}
}
演示小提琴#2在这里。
请注意,您也可以[JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)]
从Json.NET 11.0.1开始设置,但似乎没有ItemDefaultValueHandling
设置 on JsonObjectAttribute
,因此需要将其添加到序列化程序设置(或对可选值类型值使用可空值,例如CreatedAt
)。
推荐阅读
- api - Loyverse.com API - object.payments 值必须是 UUID
- firebase - 我们可以将 Firebase 数据库与 Webflow 连接起来吗?
- javascript - MongoDB 删除()
- php - Laravel Guzzler API 请求 SENDGRID
- python-3.x - numpy中一般填充添加的最快解决方案
- spring-boot - 使用 Sping Boot 在 Cloud Foundry 上加密属性
- javascript - javascript如何在反应应用程序中执行
- microsoft-speech-platform - 微软语音转文本批量转录状态在一个多小时后保持未启动
- xml - 如何从xslt中的表中删除最后一行
- html - 背景过滤器在 Chrome IOS 上不起作用吗?