本文详细介绍了如何利用Jackson库的@JsonAnySetter和@JsonAnyGetter注解，结合Map类型，构建能够动态适应JSON中不确定或可变键名的POJO。通过这种方式，开发者可以轻松处理JSON结构中键名不固定、数量可变的场景，实现数据的灵活解析与序列化，避免为每种可能的JSON结构手动创建静态Java Bean。
在处理外部API响应时，我们经常会遇到JSON结构中的键名并非固定不变的情况。例如，一个API可能根据请求参数的不同，返回包含不同日历ID（如”EU”, “AU”, “US”等）作为顶级键的JSON数据，且这些键的数量也可能动态变化。传统的POJO（Plain Old Java Object）映射方式，即为每个已知键定义一个对应的字段，在这种场景下将变得难以维护和扩展。
挑战：静态POJO的局限性
考虑以下JSON响应示例，其中”EU”和”AU”是动态的键名：
{ "EU": [ { "calId": "EU", "calDate": "2022-11-01", "prevBusinessDay": "2022-11-01", "nextBusinessDay": "2022-11-01", "businessDay": true, "monthEndBusinessDay": false } ], "AU": [ { "calId": "AU", "calDate": "2022-11-01", "prevBusinessDay": "2022-11-01", "nextBusinessDay": "2022-11-01", "businessDay": true, "monthEndBusinessDay": false } ]}
如果采用静态POJO设计，我们可能会定义如下结构：
// IndexCalendarDateResponseWrapper 包含 calId, calDate 等字段public class IndexCalendarDateResponseWrapper { private String calId; private String calDate; // ... 其他字段 // 构造函数, getter/setter}// 静态POJO，仅适用于已知键public class StaticIndexCalendarDateResponseBean { @JsonProperty("EU") private List EU; @JsonProperty("AU") private List AU; // ... 如果有更多键，需要继续添加字段}
显然，当JSON的顶级键名（如”EU”, “AU”）不确定或数量可变时，这种静态设计将无法满足需求。每次键名变化，都需要修改POJO并重新编译，这在实际开发中是不可接受的。
解决方案：利用Jackson的@JsonAnySetter和@JsonAnyGetter
Jackson库提供了@JsonAnySetter和@JsonAnyGetter注解，专门用于处理JSON中未知或动态的属性。结合Map类型，我们可以构建一个高度灵活的POJO。
1. 定义内部数据结构
首先，我们需要定义JSON数组内部元素的POJO，这部分通常是固定的：
腾讯混元文生视频
腾讯发布的AI视频生成大模型技术
266 查看详情
import lombok.Data;import lombok.NoArgsConstructor;import lombok.AllArgsConstructor;import com.fasterxml.jackson.annotation.JsonInclude;@Data@NoArgsConstructor@AllArgsConstructor@JsonInclude(JsonInclude.Include.NON_NULL) // 可选：序列化时忽略null字段public class IndexCalendarDateResponseWrapper { private String calId; private String calDate; private String prevBusinessDay; private String nextBusinessDay; private boolean businessDay; private boolean monthEndBusinessDay; // ... 其他字段}
注意： @JsonInclude(JsonInclude.Include.NON_NULL)是一个非常有用的注解。当我们将Java对象序列化回JSON时，如果某个字段的值为null，默认情况下Jackson会将其包含在JSON输出中。使用此注解可以配置Jackson在序列化时忽略null值的字段，从而生成更简洁的JSON。JsonInclude.Include.NON_EMPTY则会忽略null和空集合/字符串。
2. 构建动态POJO (@JsonAnySetter用于反序列化)
为了处理动态的顶级键，我们将主POJO中的List字段替换为一个Map<String, List>。然后，使用@JsonAnySetter注解一个方法，该方法将捕获JSON中所有未映射到其他字段的键值对，并将其存入Map中。
import java.util.HashMap;import java.util.List;import java.util.Map;import com.fasterxml.jackson.annotation.JsonAnySetter;import com.fasterxml.jackson.annotation.JsonAnyGetter;public class DynamicIndexCalendarDateResponseBean { // 使用Map来存储所有动态的键值对 private Map<String, List> responseWrappers = new HashMap(); /** * 当Jackson反序列化JSON时，如果遇到任何没有显式映射到POJO字段的属性， * 就会调用这个被@JsonAnySetter注解的方法。 * key参数接收JSON属性名，value参数接收对应的属性值。 */ @JsonAnySetter public void readResponseWrappers(String key, List value) { responseWrappers.put(key, value); } // 可以添加一个getter方法来访问这些动态数据 public Map<String, List> getResponseWrappers() { return responseWrappers; }}
@JsonAnySetter工作原理：当Jackson尝试将JSON字符串反序列化为DynamicIndexCalendarDateResponseBean实例时，它会首先尝试将JSON属性映射到POJO中显式定义的字段。如果遇到一个JSON属性名在POJO中没有对应的字段，Jackson就会查找被@JsonAnySetter注解的方法。该方法必须有两个参数：第一个是String类型，用于接收未映射的JSON属性名（键）；第二个参数的类型应与该JSON属性的值类型匹配。Jackson会将未映射的键和值传递给此方法，允许我们将其存储到Map中。
3. 实现动态序列化 (@JsonAnyGetter用于序列化)
如果除了反序列化，你还需要将这个动态POJO序列化回相同结构的JSON，那么就需要使用@JsonAnyGetter。
import java.util.HashMap;import java.util.List;import java.util.Map;import com.fasterxml.jackson.annotation.JsonAnySetter;import com.fasterxml.jackson.annotation.JsonAnyGetter;public class DynamicIndexCalendarDateResponseBean { private Map<String, List> responseWrappers = new HashMap(); @JsonAnySetter public void readResponseWrappers(String key, List value) { responseWrappers.put(key, value); } /** * 当Jackson序列化POJO时，如果遇到被@JsonAnyGetter注解的方法， * 它会调用该方法，并将其返回的Map中的所有键值对作为顶级属性添加到JSON输出中。 * 这样就实现了动态属性的序列化。 */ @JsonAnyGetter public Map<String, List> writeResponseWrappers() { return responseWrappers; } // 可以添加一个常规的getter方法来访问内部Map，但@JsonAnyGetter会处理序列化 // public Map<String, List> getResponseWrappers() { // return responseWrappers; // }}
@JsonAnyGetter工作原理：当Jackson将DynamicIndexCalendarDateResponseBean实例序列化为JSON字符串时，它会查找被@JsonAnyGetter注解的方法。该方法必须返回一个Map类型。Jackson会遍历这个Map，将其中的每个键值对作为独立的JSON属性添加到最终的JSON输出中。这样，Map中存储的动态数据就能被正确地序列化。
4. 使用示例
一旦定义了动态POJO，就可以使用Jackson的ObjectMapper进行反序列化：
import com.fasterxml.jackson.databind.ObjectMapper;import com.fasterxml.jackson.core.type.TypeReference;import java.io.IOException;public class Main { public static void main(String[] args) throws IOException { String jsonResponse = "{ "EU": [ { "calId": "EU", "calDate": "2022-11-01", "prevBusinessDay": "2022-11-01", "nextBusinessDay": "2022-11-01", "businessDay": true, "monthEndBusinessDay": false } ], "AU": [ { "calId": "AU", "calDate": "2022-11-01", "prevBusinessDay": "2022-11-01", "nextBusinessDay": "2022-11-01", "businessDay": true, "monthEndBusinessDay": false } ], "US": [ { "calId": "US", "calDate": "2022-11-01", "prevBusinessDay": "2022-11-01", "nextBusinessDay": "2022-11-01", "businessDay": true, "monthEndBusinessDay": false } ] }"; ObjectMapper objectMapper = new ObjectMapper(); // 反序列化 DynamicIndexCalendarDateResponseBean dynamicBean = objectMapper.readValue(jsonResponse, DynamicIndexCalendarDateResponseBean.class); System.out.println("反序列化成功！"); System.out.println("所有日历ID: " + dynamicBean.getResponseWrappers().keySet()); List euData = dynamicBean.getResponseWrappers().get("EU"); if (euData != null && !euData.isEmpty()) { System.out.println("EU 日历数据第一个: " + euData.get(0).getCalDate()); } // 序列化回JSON（如果需要） String serializedJson = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(dynamicBean); System.out.println("n序列化回JSON:n" + serializedJson); }}
在这个例子中，即使JSON响应中包含了”US”这个新的日历ID，DynamicIndexCalendarDateResponseBean也能正确地将其解析并存储到responseWrappers Map中，而无需修改POJO代码。
总结与注意事项
灵活性： 使用@JsonAnySetter和@JsonAnyGetter结合Map是处理JSON中动态或未知属性的最佳实践。它极大地提高了POJO的灵活性和可维护性。数据类型匹配： @JsonAnySetter方法的第二个参数类型必须与JSON中对应属性的值类型匹配。在本例中，JSON属性的值是一个List。序列化控制： 如果需要控制序列化时空值或空集合是否包含在JSON中，可以在IndexCalendarDateResponseWrapper或DynamicIndexCalendarDateResponseBean类上使用@JsonInclude(JsonInclude.Include.NON_NULL)或@JsonInclude(JsonInclude.Include.NON_EMPTY)注解。性能考量： 对于非常大的JSON结构和频繁的反序列化操作，使用Map可能会带来轻微的性能开销，因为Jackson需要动态地处理属性。但在大多数场景下，这种开销是可接受的，并且其带来的代码简洁性和灵活性远超其不足。与其他注解结合： JsonAnySetter和JsonAnyGetter可以与其他Jackson注解（如@JsonProperty、@JsonIgnore等）结合使用，以满足更复杂的映射需求。例如，如果JSON中存在少量固定且重要的字段，可以为它们定义常规字段和@JsonProperty，而其余的动态字段则由@JsonAnySetter处理。
通过上述方法，您可以构建出强大且适应性强的Java Bean，有效应对JSON数据结构中的动态变化，从而提升代码的健壮性和开发效率。
以上就是动态JSON键值映射：使用Jackson构建灵活的POJO的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/865095.html
微信扫一扫 
支付宝扫一扫 
