本文介绍了如何使用Jackson库，通过自定义序列化器，在POJO对象包含空的必填字段时，阻止整个对象的序列化过程。通过创建自定义的JsonSerializer并重写serialize()方法，可以实现对对象字段的校验，并在校验失败时抛出异常，从而避免生成不符合预期的JSON数据。同时，提供了两种注册自定义序列化器的方法：使用@JsonSerialize注解和注册自定义模块，并附带了使用示例。
在使用Jackson进行JSON序列化时，有时我们需要确保某些字段必须有值，如果这些必填字段为空，则不应该进行序列化，而是抛出异常。 Jackson 默认的行为是忽略空值字段，或者通过@JsonInclude注解控制空值的包含策略，但无法直接阻止整个对象的序列化。本文将介绍如何通过自定义序列化器来实现这一需求。
自定义序列化器
我们可以通过继承 JsonSerializer 类并重写 serialize() 方法来实现自定义的序列化逻辑。在这个方法中，我们可以对POJO对象的字段进行校验，如果发现有必填字段为空，则抛出一个 JsonGenerationException 异常，从而阻止序列化。
以下是一个 BigJsonDto 类的自定义序列化器示例：
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.writeStringField("field1", value.getField1()); gen.writeStringField("field2", value.getField2()); gen.writeStringField("field3", value.getField3()); // ... 其他字段 gen.writeStringField("fieldN", value.getFieldN()); } @Override public Class handledType() { // 仅当注册为模块的一部分时需要 return BigJsonDto.class; } }
在这个示例中，IS_NOT_VALID Predicate 用于检查 field1 和 field2 是否为空。如果其中任何一个为空，serialize() 方法会抛出一个 JsonGenerationException 异常，从而阻止序列化。如果所有字段都有效，则将每个字段写入 JsonGenerator。
注册自定义序列化器
有两种方法可以注册自定义序列化器：
1. 使用 @JsonSerialize 注解
可以在 POJO 类上使用 @JsonSerialize 注解，并指定 using 属性为自定义序列化器的类名。
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. 注册自定义模块
可以通过创建一个自定义模块，并将序列化器注册到该模块中。这种方法允许全局注册序列化器，而无需在每个 POJO 类上添加 @JsonSerialize 注解。
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，可以使用 ObjectMapper.registerModule() 方法手动注册。
使用示例
以下是一个使用示例，展示了当必填字段为空时，序列化会抛出异常：
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 为空
System.out.println(resultingJson);
} catch (JsonProcessingException e) {
System.err.println("序列化失败: " + e.getMessage());
}
}
}在这个示例中，由于 field1 为空，mapper.writeValueAsString(dto) 方法会抛出一个 JsonProcessingException 异常。
注意事项
- 在自定义序列化器中，需要手动将每个字段写入 JsonGenerator。
- 如果使用自定义模块注册序列化器，需要在序列化器中重写 handledType() 方法。
- 确保在序列化之前，已经注册了自定义序列化器。
总结
通过自定义 Jackson 序列化器，我们可以实现对 POJO 对象字段的校验，并在必填字段为空时阻止序列化过程。这种方法可以有效地避免生成不符合预期的 JSON 数据，并提高数据的可靠性。 可以根据实际需求调整校验逻辑和异常处理方式，以满足不同的业务场景。
