Jackson中必填字段为空如何阻止序列化

本文将深入探讨如何利用Jackson库，在Java环境中，确保只有所有必填字段都包含有效值时，才能成功地将一个POJO（Plain Old Java Object）序列化为JSON字符串。我们将通过自定义序列化器来实现这一目标，并在序列化过程中对必填字段进行验证，从而避免生成包含无效数据的JSON。

自定义JsonSerializer

实现此功能的关键在于创建一个自定义的JsonSerializer。通过继承JsonSerializer类并重写serialize()方法，我们可以定义自己的序列化逻辑，并在其中加入对必填字段的校验。

以下是一个示例：

import com.fasterxml.jackson.core.JsonGenerationException;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

import java.io.IOException;
import java.util.Objects;
import java.util.function.Predicate;
import java.util.stream.Stream;

public class BigJsonDtoSerializer extends JsonSerializer {

    public static final Predicate IS_NOT_VALID =
            dto -> Stream.of(dto.getField1(), // 添加所有需要校验的字段
                             dto.getField2())
                    .anyMatch(Objects::isNull);

    @Override
    public void serialize(BigJsonDto value, JsonGenerator gen,
                          SerializerProvider serializers) throws IOException {

        // 序列化失败
        if (IS_NOT_VALID.test(value)) throw new JsonGenerationException("BigJsonDto instance is not valid", gen);

        // 序列化成功 (需要将每个字段的值写入JsonGenerator)
        gen.writeStartObject(); // 添加开始对象标记
        gen.writeStringField("field1", value.getField1());
        gen.writeStringField("field2", value.getField2());
        gen.writeStringField("field3", value.getField3());
        // ... 添加所有其他字段
        gen.writeStringField("fieldN", value.getFieldN());
        gen.writeEndObject(); // 添加结束对象标记
    }

    @Override
    public Class handledType() { // 仅当作为模块的一部分注册时需要
        return BigJsonDto.class;
    }
}

在这个例子中，IS_NOT_VALID Predicate 用于检查BigJsonDto实例中的field1和field2是否为null。如果任何一个字段为null，serialize()方法会抛出一个JsonGenerationException，从而阻止序列化过程。

注意: 在 serialize 方法中，必须使用 gen.writeStartObject() 和 gen.writeEndObject() 包裹所有字段的写入操作，以确保生成的 JSON 格式正确。同时，需要使用 gen.writeStringField(fieldName, fieldValue) 来写入每个字段，其中 fieldName 是 JSON 中的字段名，fieldValue 是对应的值。

注册自定义序列化器

有以下两种方法可以注册自定义序列化器：

1. 使用 @JsonSerialize 注解

可以在BigJsonDto类的顶部使用@JsonSerialize注解，指定使用自定义的序列化器。

import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import lombok.Builder;
import lombok.Data;

@Data
@Builder
@JsonSerialize(using = BigJsonDtoSerializer.class)
public static class BigJsonDto {
    private String field1;
    private String field2;
    private String field3;
    private String fieldN;
}

2. 使用自定义模块

也可以通过创建一个自定义模块，并将序列化器注册到该模块中，然后在ObjectMapper中注册该模块。

import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;

import java.util.List;
import java.util.Map;

ObjectMapper mapper = new ObjectMapper();
SimpleModule mySerializationModule = new SimpleModule(
        "MySerializationModule",
        new Version(1, 0, 0,
            "module-description",
            "groupId",
            "artifactId"
        ),
        Map.of(),                           // deserializers
        List.of(new BigJsonDtoSerializer()) // serializers
    );

mapper.registerModule(mySerializationModule);

如果使用Spring Boot，可以将该模块作为一个Bean放入Spring容器中。

使用示例

以下是一个使用示例，展示了当field1为null时，序列化会失败。

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

public class Example {
    public static void main(String[] args) {
        String sourceJson = """
            {
                "field1" : null,
                "field2" : "Bob",
                "field3" : "Carol",
                "fieldN" : "N"
            }
            """;

        ObjectMapper mapper = new ObjectMapper(); // 假设已注册自定义序列化器

        try {
            BigJsonDto dto = mapper.readValue(sourceJson, BigJsonDto.class);
            String resultingJson = mapper.writeValueAsString(dto); // 这行代码会因为 field1 为 null 而抛出异常
            System.out.println(resultingJson);
        } catch (JsonProcessingException e) {
            System.err.println("Serialization failed: " + e.getMessage());
        }
    }
}

注意事项

• 确保在IS_NOT_VALID Predicate中包含了所有需要校验的必填字段。
• 如果使用自定义模块注册序列化器，需要重写handledType()方法。
• 在生产环境中，应该更优雅地处理JsonGenerationException，例如记录日志或返回一个错误响应。
• 自定义序列化器提供了极大的灵活性，可以根据具体需求定制序列化逻辑。

总结

通过自定义JsonSerializer，我们可以有效地控制Jackson的序列化行为，确保只有符合特定条件的POJO才能被序列化为JSON字符串。这种方法对于保证数据的完整性和有效性至关重要，尤其是在处理大型JSON数据时。通过本文提供的示例和指导，开发者可以轻松地实现对必填字段的校验，并避免生成无效的JSON数据。