本文介绍如何使用 jackson 的 @jsonanygetter 和 @jsonanysetter 实现 json 顶层键（如 "name1"）到 java 对象属性的动态绑定，避免硬编码字段名，支持任意键名的序列化与反序列化。
本文介绍如何使用 jackson 的 @jsonanygetter 和 @jsonanysetter 实现 json 顶层键（如 "name1"）到 java 对象属性的动态绑定，避免硬编码字段名，支持任意键名的序列化与反序列化。
在标准 Java 对象与 JSON 互转场景中，若 JSON 结构采用“动态键名 + 嵌套对象”的形式（例如 {"name1": {"key1":"value1"}}），而该键名（"name1"）在编译期未知、运行时才确定，直接使用固定字段（如 private String name1;）或常规注解（如 @JsonProperty）将无法满足需求。此时，Jackson 提供的 动态属性处理机制 是最佳解决方案。
核心在于组合使用以下三个注解：
- @JsonIgnore：屏蔽原始字段，防止其参与默认序列化/反序列化；
- @JsonAnyGetter：定义一个返回 Map
的 getter 方法，用于序列化时将 Map 的 key 作为 JSON 字段名输出； - @JsonAnySetter：定义一个接受 (String key, Object value) 参数的 setter 方法，用于反序列化时将任意 JSON 字段名及其值注入内部逻辑。
以下是完整可运行的示例实现（已适配 Lombok 习惯，但移除了 @Data 避免与自定义 getter/setter 冲突）：
import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.JsonProcessingException;
import java.util.HashMap;
import java.util.Map;
public class Example {
@JsonIgnore
private String name;
@JsonIgnore
private Map<string map string>> properties;
public Example() {
this.properties = new HashMap();
}
public Example(String name) {
this();
this.name = name;
this.properties.put(name, new HashMap());
}
public void add(String attr, String val) {
properties.computeIfAbsent(name, k -> new HashMap()).put(attr, val);
}
// 序列化时：将 properties 的每个 entry 的 key 作为 JSON 字段名
@JsonAnyGetter
public Map<string map string>> getProperties() {
return properties;
}
// 反序列化时：捕获任意字段名，并将其设为 name，值存入 properties
@JsonAnySetter
public void setProperties(String key, Map<string string> value) {
this.name = key;
this.properties.put(key, value);
}
// 便于调试输出（非必需）
@Override
public String toString() {
return "Example{name='" + name + "', properties=" + properties + '}';
}
public static void main(String[] args) throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
// 构造并序列化
Example bean = new Example("name1");
bean.add("key1", "value1");
bean.add("key2", "value2");
String json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(bean);
System.out.println("✅ Serialized JSON:");
System.out.println(json);
// 反序列化验证
Example parsed = mapper.readValue(json, Example.class);
System.out.println("\n✅ Deserialized object:");
System.out.println(parsed);
System.out.println("→ Parsed name: " + parsed.name); // 输出: name1
}
}</string></string></string>
预期输出：
✅ Serialized JSON:
{
"name1" : {
"key1" : "value1",
"key2" : "value2"
}
}
✅ Deserialized object:
Example{name='name1', properties={name1={key1=value1, key2=value2}}}
→ Parsed name: name1
✅ 关键注意事项：
- @JsonAnyGetter 方法必须返回 Map 类型，且 key 类型为 String；value 类型可灵活适配（本例为 Map
，也可为 Object 或自定义 POJO）； - @JsonAnySetter 方法参数顺序必须为 (String key, T value)，且不能有多个 @JsonAnySetter；
- 若存在其他显式字段（如 @JsonProperty("id")），它们会优先于 @JsonAnySetter 被处理，仅未匹配的字段才会进入 @JsonAnySetter；
- @JsonIgnore 在字段和方法上均有效，此处用于确保 name 和 properties 不被默认序列化逻辑干扰；
- 此方案天然支持多键场景（如 {"name1":{...}, "name2":{...}}），只需在构造时多次调用 add() 并确保 properties 中包含对应 key 即可。
综上，通过 @JsonAnyGetter + @JsonAnySetter 组合，你可在不牺牲类型安全的前提下，优雅地桥接“动态 JSON 键”与“静态 Java 结构”，是构建配置驱动、插件化或 Schema-less 接口的理想实践。
Java免费学习笔记：立即使用
解锁 Java 大师之旅：从入门到精通的终极指南
