Jackson自定义序列化：@JsonSerialize类内控制技巧

本文详细介绍了如何使用Jackson库实现Java对象的自定义JSON序列化。通过将目标类配置为继承`StdSerializer`并重写`serialize`方法，结合`@JsonSerialize`注解，开发者可以精确控制JSON输出格式。教程提供了完整的示例代码，展示了如何让类自身承担序列化职责，并探讨了相关注意事项与最佳实践，帮助读者深入理解Jackson的灵活定制能力。

引言：Jackson自定义序列化的必要性

在Java应用开发中，Jackson是一个广泛使用的JSON处理库。它通常能自动将Java对象序列化为JSON字符串，或将JSON字符串反序列化为Java对象。然而，在某些场景下，Jackson的默认序列化行为可能无法满足特定的业务需求。例如：

• 需要排除某些字段。
• 需要改变字段的名称。
• 需要对字段值进行格式化（如日期格式）。
• 需要完全自定义对象的JSON结构。

此时，我们就需要介入Jackson的序列化流程，实现自定义的序列化逻辑。本文将重点介绍一种让Java类自身承担序列化职责的方法，即通过继承StdSerializer并结合@JsonSerialize注解来实现。

核心概念：@JsonSerialize与StdSerializer

要实现自定义序列化，Jackson提供了JsonSerializer接口。这是一个泛型接口，要求实现者定义如何将特定类型的对象转换为JSON。为了简化开发，Jackson提供了一个抽象基类StdSerializer，它实现了JsonSerializer接口，并提供了许多便利方法。

@JsonSerialize是一个注解，用于将一个Java类与一个特定的JsonSerializer实现关联起来。当Jackson遇到被@JsonSerialize注解的类时，它会使用指定的序列化器来处理该类的实例。

实现类内自定义序列化

Jackson允许我们编写一个单独的类作为序列化器，并通过@JsonSerialize注解将其与目标类关联。但对于某些场景，尤其是当序列化逻辑与业务对象紧密相关且不希望引入过多独立文件时，我们可以采用一种模式：让业务类本身充当其序列化器。

以下是实现这种模式的详细步骤：

步骤一：继承StdSerializer

首先，目标类需要继承com.fasterxml.jackson.databind.ser.std.StdSerializer。这个抽象类要求一个泛型参数，表示它将序列化的对象类型。在本例中，由于类自身将序列化自身，因此泛型参数就是类本身。

public class MyClassWithCustomSerializer extends StdSerializer {
    // ... 字段和方法
}

步骤二：实现构造函数

StdSerializer要求子类提供一个构造函数，调用其父类的super()方法，并传入要序列化的类型。

public class MyClassWithCustomSerializer extends StdSerializer {
    protected int fieldA;
    protected String fieldB;

    public MyClassWithCustomSerializer() {
        super(MyClassWithCustomSerializer.class); // 告知父类它将处理MyClassWithCustomSerializer类型的对象
    }

    // ... 其他方法
}

步骤三：重写serialize方法

这是实现自定义序列化逻辑的核心。serialize方法有三个参数：

• value：需要被序列化的对象实例。
• gen：JsonGenerator实例，用于写入JSON结构。它是Jackson序列化过程中的核心API，提供了丰富的写入方法，如writeStartObject()、writeStringField()、writeNumberField()等。
• serializers：SerializerProvider实例，提供序列化上下文信息，例如可以用于委托Jackson默认处理某些字段或嵌套对象。

在serialize方法中，我们可以完全控制JSON的输出结构。

@Override
public void serialize(MyClassWithCustomSerializer value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
    gen.writeStartObject(); // 开始一个JSON对象
    gen.writeNumberField("fieldA", value.fieldA); // 写入一个名为"fieldA"的数字字段
    gen.writeStringField("fieldB", value.fieldB); // 写入一个名为"fieldB"的字符串字段
    gen.writeEndObject();   // 结束JSON对象
}

步骤四：通过@JsonSerialize注解关联

最后一步是在目标类上使用@JsonSerialize注解，并将其using属性指向该类自身。这样，Jackson在序列化MyClassWithCustomSerializer实例时，就会调用其自身的serialize方法。

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
import java.io.IOException;

@JsonSerialize(using = MyClassWithCustomSerializer.class) // 指定该类自身作为序列化器
public class MyClassWithCustomSerializer extends StdSerializer {
    protected int fieldA;
    protected String fieldB;

    public MyClassWithCustomSerializer() {
        super(MyClassWithCustomSerializer.class);
    }

    public void setFieldA(int fieldA) {
        this.fieldA = fieldA;
    }

    public void setFieldB(String fieldB) {
        this.fieldB = fieldB;
    }

    @Override
    public void serialize(MyClassWithCustomSerializer value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeStartObject();
        gen.writeNumberField("fieldA", value.fieldA);
        gen.writeStringField("fieldB", value.fieldB);
        gen.writeEndObject();
    }
}

完整示例代码

为了演示上述自定义序列化的效果，我们创建一个测试类。

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class TestCustomSerializer {

    public void testSerialization() {
        MyClassWithCustomSerializer myObject = new MyClassWithCustomSerializer();
        myObject.setFieldA(100);
        myObject.setFieldB("StackOverflow");

        String serialized;
        try {
            ObjectMapper objectMapper = new ObjectMapper();
            serialized = objectMapper.writeValueAsString(myObject);
            System.out.println("Serialized JSON: " + serialized);
        } catch (JsonProcessingException e) {
            System.out.println("Serialization failed.");
            e