如何序列化派生类

前言

假设有一个 Person 抽象基类，其中包含 Student 和 Teacher 派生类：

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

public class Student : Person
{
    public int Score { get; set; }
}

public class Teacher : Person
{
    public string Title { get; set; }
}

如果 API 返回类型是单个 Person 抽象基类，System.Text.Json内置功能已经可以直接支持序列化派生类：

[HttpGet]
[Route("get")]
public Person Get()
{
    Person person = new Student { Name = "zhangsan", Score = 100 };

    return person;
}

但是，当 API 需要返回 Person 抽象基类的集合时，System.Text.Json就不知道如何处理了，即使集合内部只有一种派生类型:

[HttpGet]
[Route("list")]
public IEnumerable<Person> List()
{
    return new Person[] {
        new Student { Name = "zhangsan", Score = 100 }
    };
}

可以看到，只处理了基类的属性。

我们必须主动告诉System.Text.Json如何处理序列化派生类，因此需要自定义转换器。

解决方案

为基类创建自定义转换器：

public class PersonConverter : JsonConverter<Person>
{
    public override Person Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        throw new NotImplementedException();
    }

    public override void Write(
            Utf8JsonWriter writer, Person person, JsonSerializerOptions options)
    {
        writer.WriteStartObject();

        if (person is Student student)
        {
            writer.WriteNumber("score", student.Score);
        }
        else if (person is Teacher teacher)
        { 
            writer.WriteString("title", teacher.Title);
        }

        writer.WriteString("name", person.Name);

        writer.WriteEndObject();
    }
}

然后修改 Startup.cs 文件，注册自定义转换器：

services.AddControllers()
    .AddJsonOptions(options =>
        options.JsonSerializerOptions.Converters.Add(new PersonConverter()));

运行，序列化成功：

上面的转换器代码通过手动写入每个属性实现序列化，那属性一多还不要累死！

一种替代方法是调用System.Text.Json内置功能实现序列化单个派生类：

public override void Write(
        Utf8JsonWriter writer, Person person, JsonSerializerOptions options)
{
    JsonSerializer.Serialize(writer, (object)person, options);
}

注意，必须将要序列化的对象转换为 object

结论

通过自定义转换器，我们实现了使用System.Text.Json序列化派生类。

-

技术群：添加小编微信并备注进群

小编微信：mm1552923   

公众号：dotNet编程大全