.Net 自定义转换器JsonConverter的使用详解

1. 什么是JsonConverter

JsonConverter是.Net框架中提供的一种用于序列化和反序列化Json格式数据的类库，它可以通过自定义转换器来灵活地完成对象和Json之间的转换。

1. 如何使用JsonConverter

2.1 引用命名空间

为了使用JsonConverter类库，我们需要在代码中引入Newtonsoft.Json命名空间。

using Newtonsoft.Json;

2.2 定义JsonConverter

自定义一个JsonConverter，需要继承JsonConverter类，并实现其中的抽象方法，包括CanConvert、ReadJson、WriteJson等方法。其中，CanConvert方法用于确定一个类型是否可以被转换，ReadJson方法用于反序列化对象，WriteJson方法用于序列化对象。

public class CustomConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(Person);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var person = (Person)value;
        writer.WriteStartObject();
        writer.WritePropertyName("Name");
        writer.WriteValue(person.Name);
        writer.WritePropertyName("Age");
        writer.WriteValue(person.Age);
        writer.WriteEndObject();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var person = new Person();
        while (reader.Read())
        {
            if (reader.TokenType == JsonToken.EndObject)
            {
                return person;
            }

            var propertyName = reader.Value.ToString();
            reader.Read();
            switch (propertyName)
            {
                case "Name":
                    person.Name = reader.Value.ToString();
                    break;
                case "Age":
                    person.Age = (int)reader.Value;
                    break;
            }
        }

        throw new JsonSerializationException("Unexpected end of object.");
    }
}

2.3 使用JsonConverter

使用JsonConverter需要通过JsonConverter属性进行设置，也可以通过JsonConvert.SerializeObject和JsonConvert.DeserializeObject方法的重载来指定。

// JsonConverter属性
var person = new Person { Name = "Tom", Age = 18 };
var settings = new JsonSerializerSettings
{
    Converters = new List<JsonConverter> { new CustomConverter() }
};
var json = JsonConvert.SerializeObject(person, settings);
var result = JsonConvert.DeserializeObject<Person>(json, settings);

// JsonConvert.SerializeObject和JsonConvert.DeserializeObject重载
var person = new Person { Name = "Tom", Age = 18 };
var json = JsonConvert.SerializeObject(person, typeof(Person), new CustomConverter());
var result = (Person)JsonConvert.DeserializeObject(json, typeof(Person), new CustomConverter());

1. 示例说明

以下是两个示例，其中，第一个示例演示了使用自定义JsonConverter将一个对象转换为Json格式数据，第二个示例演示了将Json格式数据反序列化为对象。

using Newtonsoft.Json;
using System;

public class Person
{
    public string Name { get; set; }

    public int Age { get; set; }
}

public class CustomConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(Person);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var person = (Person)value;
        writer.WriteStartObject();
        writer.WritePropertyName("Name");
        writer.WriteValue(person.Name);
        writer.WritePropertyName("Age");
        writer.WriteValue(person.Age);
        writer.WriteEndObject();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var person = new Person();
        while (reader.Read())
        {
            if (reader.TokenType == JsonToken.EndObject)
            {
                return person;
            }

            var propertyName = reader.Value.ToString();
            reader.Read();
            switch (propertyName)
            {
                case "Name":
                    person.Name = reader.Value.ToString();
                    break;
                case "Age":
                    person.Age = (int)reader.Value;
                    break;
            }
        }

        throw new JsonSerializationException("Unexpected end of object.");
    }
}

class Program
{
    static void Main(string[] args)
    {
        // 序列化为Json格式数据
        var person = new Person { Name = "Tom", Age = 18 };
        var settings = new JsonSerializerSettings
        {
            Converters = new List<JsonConverter> { new CustomConverter() }
        };
        var json = JsonConvert.SerializeObject(person, settings);
        Console.WriteLine(json);

        // 反序列化为对象
        var jsonStr = "{\"Name\":\"Mary\",\"Age\":20}";
        var result = JsonConvert.DeserializeObject<Person>(jsonStr, settings);
        Console.WriteLine(result.Name);
        Console.WriteLine(result.Age);

        Console.ReadLine();
    }
}