1. 理解问题：动态JSON根属性键的挑战
在使用jackson进行json与java对象（pojo）的序列化和反序列化过程中，一个常见的问题是当json的根级别包含动态或随机生成的属性键时，直接将其映射到一个固定结构的pojo会引发unrecognizedpropertyexception。考虑以下json结构：
{
"random1" : {
"name" : "john",
"lastName" : "johnson"
},
"nextRandom500" : {
"name" : "jack",
"lastName" : "jackson"
},
"random100500" : {
"name" : "jack",
"lastName" : "johnson"
}
}如果尝试将上述JSON直接反序列化到一个期望拥有固定字段（例如，UserResponse类中包含private Map
2. 定义数据模型：User POJO
为了正确处理JSON中每个动态键所对应的嵌套对象，我们需要定义一个Java POJO来表示这些对象的结构。在这个例子中，每个动态键的值都是一个包含name和lastName的User对象。
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.SuperBuilder;
@Data // Lombok注解，自动生成getter/setter/equals/hashCode/toString
@SuperBuilder(toBuilder=true) // Lombok注解，支持建造者模式，toBuilder允许基于现有对象创建新建造者
@NoArgsConstructor // Lombok注解，生成无参构造函数
@JsonInclude(JsonInclude.Include.NON_NULL) // Jackson注解，序列化时忽略null值字段
public class User {
private String name;
private String lastName;
}说明：
- @Data、@SuperBuilder、@NoArgsConstructor是Lombok库提供的注解，它们在编译时自动生成Java Bean的常用方法，大大简化了POJO的编写。
- @JsonInclude(JsonInclude.Include.NON_NULL)是Jackson的注解，它指示在将User对象序列化为JSON时，如果某个字段的值为null，则该字段不会被包含在生成的JSON中。
3. 反序列化动态根属性键的JSON
对于上述具有动态根属性键的JSON结构，最直接且推荐的反序列化方式是将其视为一个Map，其中键是动态的字符串，值是我们的User POJO。Jackson的TypeReference机制在此类场景中非常有用，它允许我们指定泛型类型，从而正确地反序列化复杂的泛型结构。
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
public class JsonDeserializationExample {
public static void main(String[] args) throws JsonProcessingException {
String jsonString = "{\n" +
" \"random1\" : {\n" +
" \"name\" : \"john\",\n" +
" \"lastName\" : \"johnson\"\n" +
" },\n" +
" \"nextRandom500\" : {\n" +
" \"name\" : \"jack\",\n" +
" \"lastName\" : \"jackson\"\n" +
" },\n" +
" \"random100500\" : {\n" +
" \"name\" : \"jack\",\n" +
" \"lastName\" : \"johnson\"\n" +
" } \n" +
"}";
ObjectMapper objectMapper = new ObjectMapper();
// 使用TypeReference反序列化到 Map
Map usersMap = objectMapper.readValue(jsonString,
new TypeReference>(){});
// 打印反序列化结果进行验证
System.out.println("反序列化结果:");
usersMap.forEach((key, user) ->
System.out.println(" Key: " + key + ", User: " + user.getName() + " " + user.getLastName()));
/* 预期输出示例:
反序列化结果:
Key: random1, User: john johnson
Key: nextRandom500, User: jack jackson
Key: random100500, User: jack johnson
*/
}
} 代码解析：
4. 序列化Java Map到动态根属性键的JSON
将Map
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.HashMap;
import java.util.Map;
public class JsonSerializationExample {
public static void main(String[] args) throws JsonProcessingException {
// 创建一个 Map 对象
Map usersToSerialize = new HashMap<>();
usersToSerialize.put("dynamicKeyA", User.builder().name("Alice").lastName("Smith").build());
usersToSerialize.put("dynamicKeyB", User.builder().name("Bob").lastName("Johnson").build());
ObjectMapper objectMapper = new ObjectMapper();
// 序列化 Map 到 JSON 字符串
String serializedJson = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(usersToSerialize);
System.out.println("序列化结果:");
System.out.println(serializedJson);
/* 预期输出 (键顺序可能因Map实现而异，但Jackson通常会保持一致或按字母排序):
序列化结果:
{
"dynamicKeyA" : {
"name" : "Alice",
"lastName" : "Smith"
},
"dynamicKeyB" : {
"name" : "Bob",
"lastName" : "Johnson"
}
}
*/
}
} 代码解析：
- User.builder()...build()：使用Lombok的建造者模式创建User对象，提高代码可读性。
- objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(usersToSerialize)：Jackson会遍历Map中的每个条目，将键作为JSON对象的属性名，将User对象序列化为对应的JSON值。writerWithDefaultPrettyPrinter()用于生成格式化的（美观的）JSON字符串。
5. 注意事项与总结
-
POJO与JSON结构匹配的重要性： 避免UnrecognizedPropertyException的关键在于确保Java对象结构能够准确反映JSON数据结构。当JSON的根是一个动态键值对集合时，最合适的Java类型是Map
。 -
TypeReference的应用场景： TypeReference是处理泛型类型反序列化的利器，尤其适用于集合类型（如List
）或映射类型（如Map ）。它解决了Java泛型在运行时类型擦除的问题。 - 灵活性： 这种方法提供了极大的灵活性，无需修改POJO即可适应JSON根属性键的随机变化，只需将整个根JSON视为一个Map。
- 错误处理： 在实际应用中，应考虑添加try-catch块来处理JsonProcessingException，以增强程序的健壮性，例如当JSON字符串格式不正确时。
- Jackson配置： ObjectMapper提供了丰富的配置选项，例如DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES可以控制是否在遇到未知属性时抛出异常。默认情况下，此特性为true，因此会抛出UnrecognizedPropertyException。如果希望忽略未知属性，可以设置为false。
通过上述方法，您可以高效且灵活地使用Jackson库处理具有动态或随机生成根属性键的JSON数据，无论是进行反序列化还是序列化操作。
