
本教程旨在解决jackson反序列化中,当json数据包含多个别名字段且需优先选择其中非空值的问题。文章详细介绍了两种有效的策略:一是通过定义多个智能setter方法,利用`@jsonsetter`注解实现按需更新;二是通过自定义converter结合辅助pojo,将数据转换逻辑与领域模型分离。这两种方法都能实现灵活且健壮的数据映射,有效处理冗余数据,确保数据解析的准确性。
在处理来自第三方系统或存在历史遗留问题的JSON数据时,我们经常会遇到同一个逻辑字段在JSON中以多种名称(别名)出现的情况。更复杂的是,这些别名字段中可能只有一个包含有效的非空值,而其他字段则为null或空字符串。Jackson的@JsonAlias注解虽然能识别多个别名,但它通常无法智能地优先选择非空值,导致反序列化结果不符合预期。本文将深入探讨两种解决方案,帮助开发者在Jackson中实现这种智能的非空值优先选择机制。
此方案的核心思想是为每个可能的别名定义一个独立的setter方法,并通过@JsonSetter注解将其映射到相应的JSON字段。所有这些setter方法最终都将调用一个核心的setter逻辑,该逻辑负责判断当前字段是否已经存在有效值(非空且非空字符串),并仅在当前字段为空时才接受新的值。
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Arrays;
import java.util.Objects;
import java.util.function.Predicate;
public class MyPojo {
// 定义一个谓词,用于检查字符串是否为null或空
public static final Predicate<String> NULL_OR_EMPTY = s -> s == null || s.isEmpty();
private String name;
// 核心setter,负责判断并更新字段
@JsonSetter("name") // 映射到JSON字段"name"
public void setName(String name) {
// 只有当当前name字段为null或空时,才更新
if (NULL_OR_EMPTY.test(this.name)) {
this.name = name;
}
}
// 别名setter 1,映射到JSON字段"full_name"
@JsonSetter("full_name")
public void setName1(String name) {
setName(name); // 委托给核心setter
}
// 别名setter 2,映射到JSON字段"fullName"
@JsonSetter("fullName")
public void setName2(String name) {
setName(name); // 委托给核心setter
}
// Getter方法
public String getName() {
return name;
}
@Override
public String toString() {
return "MyPojo{name='" + name + "'}";
}
public static void main(String[] args) throws Exception {
// 示例JSON数据,其中"name"为null,"full_name"为空字符串,"fullName"为有效值
String json = "{ \"name\" : null, \"full_name\" : \"\", \"fullName\" : \"name\"}";
ObjectMapper mapper = new ObjectMapper();
MyPojo myPojo = mapper.readValue(json, MyPojo.class);
System.out.println(myPojo);
// 示例2:第一个有效值
json = "{ \"name\" : \"first\", \"full_name\" : \"\", \"fullName\" : \"name\"}";
myPojo = mapper.readValue(json, MyPojo.class);
System.out.println(myPojo);
// 示例3:所有都为空或null
json = "{ \"name\" : null, \"full_name\" : \"\", \"fullName\" : null}";
myPojo = mapper.readValue(json, MyPojo.class);
System.out.println(myPojo);
}
}输出:
MyPojo{name='name'}
MyPojo{name='first'}
MyPojo{name='null'}为了保持领域模型的简洁和职责分离,我们可以采用自定义Converter的方式。这种方法将JSON解析为一个辅助POJO,该辅助POJO能够捕获所有别名字段的值。然后,通过一个Converter将这个辅助POJO转换为最终的领域POJO,并在转换过程中实现非空值的选择逻辑。
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.util.StdConverter;
import lombok.Builder;
import lombok.Getter;
import lombok.ToString;
import java.util.Arrays;
import java.util.function.Predicate;
// 辅助POJO,用于接收所有可能的别名值
// 使用record可以简化代码
record AuxiliaryPojo(
@JsonProperty("name") String name,
@JsonProperty("full_name") String name1,
@JsonProperty("fullName") String name2
) {}
// 自定义Converter,负责将AuxiliaryPojo转换为MyPojo
class AuxiliaryPojoToMyPojo extends StdConverter<AuxiliaryPojo, MyPojo> {
// 定义一个谓词,用于检查字符串是否非null且非空
public static final Predicate<String> NOT_NULL_OR_EMPTY = s -> s != null && !s.isEmpty();
@Override
public MyPojo convert(AuxiliaryPojo v) {
// 从辅助POJO中找到第一个非null且非空的name值
String selectedName = findMatching(v.name(), v.name1(), v.name2());
// 构建最终的MyPojo实例
return MyPojo.builder()
.name(selectedName)
.build();
}
// 辅助方法,用于从多个字符串中找到第一个非null且非空的字符串
private String findMatching(String... args) {
return Arrays.stream(args)
.filter(NOT_NULL_OR_EMPTY)
.findFirst() // 找到第一个匹配的
.orElse(null); // 如果都没有匹配,则返回null
}
}
// 最终的领域POJO,使用Lombok简化代码
@Getter
@Builder
@ToString
@JsonDeserialize(converter = AuxiliaryPojoToMyPojo.class) // 指定自定义Converter
public class MyPojo {
private String name;
public static void main(String[] args) throws Exception {
// 示例JSON数据
String json = "{ \"name\" : null, \"full_name\" : \"\", \"fullName\" : \"name\"}";
ObjectMapper mapper = new ObjectMapper();
MyPojo myPojo = mapper.readValue(json, MyPojo.class);
System.out.println(myPojo);
// 示例2:第一个有效值
json = "{ \"name\" : \"first\", \"full_name\" : \"\", \"fullName\" : \"name\"}";
myPojo = mapper.readValue(json, MyPojo.class);
System.out.println(myPojo);
// 示例3:所有都为空或null
json = "{ \"name\" : null, \"full_name\" : \"\", \"fullName\" : null}";
myPojo = mapper.readValue(json, MyPojo.class);
System.out.println(myPojo);
}
}输出:
MyPojo(name=name) MyPojo(name=first) MyPojo(name=null)
在Jackson处理多别名JSON字段并优先选择非空值的问题上,两种方案各有优势:
开发者应根据项目的具体需求、团队编码规范以及对代码整洁度的要求,选择最适合的解决方案。对于大型或复杂的系统,自定义Converter通常是更推荐的做法。
以上就是Jackson处理多别名JSON字段时优先选择非空值的策略与实践的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号