我有一个包含接口类型属性的类，例如：
public class Foo
{
public IBar Bar { get; set; }
}
我还有多个实现了IBar接口的具体实现，可以在运行时设置。其中一些具体类需要自定义JsonConverter进行序列化和反序列化。
使用TypeNameHandling.Auto选项，不需要转换器的IBar类可以完美地进行序列化和反序列化。然而，那些需要自定义序列化的类却没有$type名称输出，虽然它们按预期进行了序列化，但无法反序列化为它们的具体类型。
我尝试在自定义的JsonConverter中手动编写$type名称元数据；但是，在反序列化过程中，转换器被完全绕过。
是否有解决这种情况的方法或正确的处理方式？
IBar接口的类型都有一个JsonConverter，并且还有一个针对IBar本身的转换器。public interface IBar { }
public class BarA : IBar { }
public class Foo
{
public IBar Bar { get; set; }
}
IBar创建转换器。它仅在反序列化JSON时使用。它将尝试读取$type变量并调用实现类型的转换器：public class BarConverter : JsonConverter
{
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
throw new NotSupportedException();
}
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
var jObj = JObject.Load(reader);
var type = jObj.Value<string>("$type");
if (type == GetTypeString<BarA>())
{
return new BarAJsonConverter().ReadJson(reader, objectType, jObj, serializer);
}
// Other implementations if IBar
throw new NotSupportedException();
}
public override bool CanConvert(Type objectType)
{
return objectType == typeof (IBar);
}
public override bool CanWrite
{
get { return false; }
}
private string GetTypeString<T>()
{
var typeOfT = typeof (T);
return string.Format("{0}, {1}", typeOfT.FullName, typeOfT.Assembly.GetName().Name);
}
}
这是BarA类的转换器：
public class BarAJsonConverter : BarBaseJsonConverter
{
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
// '$type' property will be added because used serializer has TypeNameHandling = TypeNameHandling.Objects
GetSerializer().Serialize(writer, value);
}
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
var existingJObj = existingValue as JObject;
if (existingJObj != null)
{
return existingJObj.ToObject<BarA>(GetSerializer());
}
throw new NotImplementedException();
}
public override bool CanConvert(Type objectType)
{
return objectType == typeof(BarA);
}
}
BarBaseJsonConverter 类，而不是 JsonConverter。另外，我们在 WriteJson 和 ReadJson 方法中不使用 serializer 参数。在自定义转换器中使用 serializer 参数存在问题。您可以在这里了解更多信息。我们需要创建 JsonSerializer 的新实例，而基类是一个很好的选择：public abstract class BarBaseJsonConverter : JsonConverter
{
public JsonSerializer GetSerializer()
{
var serializerSettings = JsonHelper.DefaultSerializerSettings;
serializerSettings.TypeNameHandling = TypeNameHandling.Objects;
var converters = serializerSettings.Converters != null
? serializerSettings.Converters.ToList()
: new List<JsonConverter>();
var thisConverter = converters.FirstOrDefault(x => x.GetType() == GetType());
if (thisConverter != null)
{
converters.Remove(thisConverter);
}
serializerSettings.Converters = converters;
return JsonSerializer.Create(serializerSettings);
}
}
JsonHelper是一个用于创建JsonSerializerSettings的类：
public static class JsonHelper
{
public static JsonSerializerSettings DefaultSerializerSettings
{
get
{
return new JsonSerializerSettings
{
Converters = new JsonConverter[] { new BarConverter(), new BarAJsonConverter() }
};
}
}
}
var obj = new Foo { Bar = new BarA() };
var json = JsonConvert.SerializeObject(obj, JsonHelper.DefaultSerializerSettings);
var dObj = JsonConvert.DeserializeObject<Foo>(json, JsonHelper.DefaultSerializerSettings);
利用Alesandr Ivanov上面的信息，我创建了一个通用的WrappedJsonConverter<T>类，它使用一个$wrappedType元数据属性来包装（和解包）需要转换器的具体类，该属性遵循与标准$type相同的类型名称序列化。
WrappedJsonConverter<T>作为转换器添加到接口（即IBar）中，但对于不需要转换器的类，此包装器完全透明，并且不需要对包装转换器进行任何更改。
我使用了稍微不同的方法来解决转换器/序列化器循环（静态字段），但它不需要任何有关所使用的序列化器设置的知识，并允许IBar对象图具有子IBar属性。
对于包装对象，Json如下：
"IBarProperty" : {
"$wrappedType" : "Namespace.ConcreteBar, Namespace",
"$wrappedValue" : {
"ConvertedID" : 90,
"ConvertedPropID" : 70
...
}
}
public class WrappedJsonConverter<T> : JsonConverter<T> where T : class
{
[ThreadStatic]
private static bool _canWrite = true;
[ThreadStatic]
private static bool _canRead = true;
public override bool CanWrite
{
get
{
if (_canWrite)
return true;
_canWrite = true;
return false;
}
}
public override bool CanRead
{
get
{
if (_canRead)
return true;
_canRead = true;
return false;
}
}
public override T ReadJson(JsonReader reader, T existingValue, JsonSerializer serializer)
{
var jsonObject = JObject.Load(reader);
JToken token;
T value;
if (!jsonObject.TryGetValue("$wrappedType", out token))
{
//The static _canRead is a terrible hack to get around the serialization loop...
_canRead = false;
value = jsonObject.ToObject<T>(serializer);
_canRead = true;
return value;
}
var typeName = jsonObject.GetValue("$wrappedType").Value<string>();
var type = JsonExtensions.GetTypeFromJsonTypeName(typeName, serializer.Binder);
var converter = serializer.Converters.FirstOrDefault(c => c.CanConvert(type) && c.CanRead);
var wrappedObjectReader = jsonObject.GetValue("$wrappedValue").CreateReader();
wrappedObjectReader.Read();
if (converter == null)
{
_canRead = false;
value = (T)serializer.Deserialize(wrappedObjectReader, type);
_canRead = true;
}
else
{
value = (T)converter.ReadJson(wrappedObjectReader, type, existingValue, serializer);
}
return value;
}
public override void WriteJson(JsonWriter writer, T value, JsonSerializer serializer)
{
var type = value.GetType();
var converter = serializer.Converters.FirstOrDefault(c => c.CanConvert(type) && c.CanWrite);
if (converter == null)
{
//This is a terrible hack to get around the serialization loop...
_canWrite = false;
serializer.Serialize(writer, value, type);
_canWrite = true;
return;
}
writer.WriteStartObject();
{
writer.WritePropertyName("$wrappedType");
writer.WriteValue(type.GetJsonSimpleTypeName());
writer.WritePropertyName("$wrappedValue");
converter.WriteJson(writer, value, serializer);
}
writer.WriteEndObject();
}
}
static bool _canWrite 和 static bool _canRead 不是线程安全的。由于多个框架，包括 [tag:asp.net-web-api] 在不同线程之间共享转换器，这可能会导致问题。建议使用 [ThreadStatic] 或 ThreadLocal<bool>，如此答案所建议。 - dbcToObject 方法。本质上，对于其他类型来说，它是透明的，无论它们是否有转换器。 - Andrew HanlonTypeNameHandling，为什么需要 $wrappedType？只需在 WrappedJsonConverter 中使用 $type 即可。这也仅适用于已声明为接口的属性。例如，如果您使用 object - 它会再次出现问题... - torvinTypeNameHandling.Auto时，它不会在具有自定义转换器的具体类型上放置类型信息。我不知道现在是否仍然存在这种情况，因为我已经停止使用Json.Net。这个问题可能已经在新版本中得到解决，我将尝试运行测试，并在不再需要时将此QA标记为过时。干杯。 - Andrew Hanlon