在Json.NET序列化期间向所有类添加自定义类型名称

本文关键字：添加 自定义 类型 NET Json 序列化 | 更新日期: 2023-09-27 18:08:07

我需要为使用Json.Net序列化的每个对象添加一个'type'属性。我懂Json。Net已经开箱即用地支持这一点，但在我的情况下，类型名称需要排除程序集，并且属性的名称必须是可配置的(这两者都不受支持)。

我现在有这个:

public class TypeConverter : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serialiser)
    {
        JObject jObject = JObject.FromObject(value, serializer);
        jObject.AddFirst(new JProperty("myCustomTypePropertyName"), value.GetType().Name);
        jObject.WriteTo(writer);
    }
    public override void ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serialiser)
    {
        throw new NotImplementedException();
    }
    public override bool CanConvert(Type objectType)
    {
        return objectType.IsClass;
    }
}

这适用于正在序列化的外部类型，但不幸的是，不会为嵌套对象调用转换器。如果我将序列化器添加到JObject中。调用FromObject，然后我得到一个自引用循环异常，因为它试图重新进入外部类型的转换器。

我可以解决这个问题的唯一方法是手动反映和迭代每个级别的属性，并使用serializer参数序列化它们，但这是超级丑陋的，甚至在考虑性能之前。

我很感激你在这方面的帮助;我希望我错过了一些明显的东西。

(注意:我运行的是。net 3.5，所以serializationbinder是不可能的。)

在Json.NET序列化期间向所有类添加自定义类型名称

不，你没有错过任何明显的东西。由于您已经看到的原因，尝试使用处理每种类型的类的JsonConverter来执行此操作将会出现问题。json转换器最适合处理特定类型;他们不太擅长概括。幸运的是，有一种方法可以使用自定义IContractResolver来完成您想要的操作。

契约解析器允许我们在属性级别对大范围的类应用某些序列化行为。这个想法是让解析器在每个类上伪造出一个额外的"类型名称"属性(或任何你想要它被调用的)，并安装相应的IValueProvider，以便在序列化每个对象时提供该属性的值。(这样序列化器永远不会知道该属性实际上不存在。)

创建解析器的最简单方法是从Json.Net附带的DefaultContractResolver中派生它。从那里，我们只需要重写CreateProperties()方法，并将我们的伪属性注入基类返回的列表中。 以下是解析器和值提供程序的代码: 
class CustomResolver : DefaultContractResolver
{
    private string customTypePropertyName;
    private IValueProvider valueProvider = new SimpleTypeNameProvider();
    public CustomResolver(string customTypePropertyName)
    {
        this.customTypePropertyName = customTypePropertyName;
    }
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        IList<JsonProperty> props = base.CreateProperties(type, memberSerialization);
        if (type.IsClass && type != typeof(string))
        {
            // Add a phantom string property to every class which will resolve 
            // to the simple type name of the class (via the value provider)
            // during serialization.
            props.Insert(0, new JsonProperty
            {
                DeclaringType = type,
                PropertyType = typeof(string),
                PropertyName = customTypePropertyName,
                ValueProvider = valueProvider,
                Readable = true,
                Writable = false
            });
        }
        return props;
    }
    class SimpleTypeNameProvider : IValueProvider
    {
        public object GetValue(object target)
        {
            return target.GetType().Name;
        }
        public void SetValue(object target, object value)
        {
            return;
        }
    }
}

要使用解析器，创建一个实例并通过JsonSerializerSettings对象将其传递给序列化器。下面是一个简短的演示:

class Program
{
    static void Main(string[] args)
    {
        Person p = new Person
        {
            Id = 2,
            Name = "Peter",
            Employer = new Company
            {
                Id = 5,
                Name = "Initech"
            }
        };
        JsonSerializerSettings settings = new JsonSerializerSettings
        {
            ContractResolver = new CustomResolver("MyTypeName"),
            Formatting = Formatting.Indented
        };
        string json = JsonConvert.SerializeObject(p, settings);
        Console.WriteLine(json);
    }
}
class Person
{
    public int Id { get; set; }
    public string Name { get; set; }
    public Company Employer { get; set; }
}
class Company
{
    public int Id { get; set; }
    public string Name { get; set; }
}
输出:

{
  "MyTypeName": "Person",
  "Id": 2,
  "Name": "Peter",
  "Employer": {
    "MyTypeName": "Company",
    "Id": 5,
    "Name": "Initech"
  }
}
相关文章：