如何使用 Jackson 序列化含动态键名的嵌套 JSON 对象_技术教程

本文介绍在 spring boot 中使用 jackson 将具有运行时动态键名（如订单号、国家代码）的嵌套对象（如 shipments、track、pricing）正确序列化为指定结构的 json，核心方案是用 `map` 替代固定字段类。

在构建聚合响应（如 AggregatedResponse）时，若子对象的键名（key）由外部 API 动态返回（例如运单号 "987654321"、国家码 "NL"），则不可依赖预定义的 Java 字段名——因为字段名在编译期固定，而 JSON 键在运行时才确定。此时，Jackson 的最佳实践是放弃 POJO 嵌套类，改用类型安全的 Map 结构，并配合 Jackson 注解确保序列化行为符合预期。

✅ 推荐实现方式：统一使用 Map 表示动态键对象

public class AggregatedResponse {
    private Map> shipments; // key: 运单号, value: 包装类型列表
    private Map track;            // key: 跟踪号, value: 状态
    private Map pricing;         // key: 国家代码, value: 价格

    // 构造器（可选）
    public AggregatedResponse() {
        this.shipments = new LinkedHashMap<>();
        this.track = new LinkedHashMap<>();
        this.pricing = new LinkedHashMap<>();
    }

    // Getter/Setter（注意命名一致性，避免拼写错误）
    public Map> getShipments() {
        return shipments;
    }

    public void setShipments(Map> shipments) {
        this.shipments = shipments;
    }

    public Map getTrack() {
        return track;
    }

    public void setTrack(Map track) {
        this.track = track;
    }

    public Map getPricing() {
        return pricing;
    }

    public void setPricing(Map pricing) {
        this.pricing = pricing;
    }
}

? 使用示例：动态填充并返回响应

@GetMapping("/aggregate")
public ResponseEntity getAggregatedResponse(
        @RequestParam String shipmentId,
        @RequestParam String trackingNumber,
        @RequestParam String country) {

    AggregatedResponse response = new AggregatedResponse();

    // 模拟调用外部 API 获取数据
    response.getShipments().put(shipmentId, Arrays.asList("BOX", "BOX", "PALLET"));
    response.getTrack().put(trackingNumber, "COLLECTING");
    response.getPricing().put(country, 14.242090605778);

    return ResponseEntity.ok(response);
}

✅ 输出 JSON 完全匹配目标结构：

{
  "shipments": {
    "987654321": ["BOX", "BOX", "PALLET"]
  },
  "track": {
    "123456789": "COLLECTING"
  },
  "pricing": {
    "NL": 14.242090605778
  }
}

⚠️ 注意事项与最佳实践

避免自定义序列化器（除非必要）：Map 是 Jackson 原生支持的“动态键”标准方案，无需 @JsonSerialize 或 @JsonAnyGetter 等复杂配置。
保持 Map 实现类有序性：使用 LinkedHashMap 可保证字段输出顺序（如 shipments 在前、pricing 在后），提升可读性与测试稳定性。
类型安全优于 Map：明确泛型（如 Map>）既利于编译检查，也使 Jackson 自动推导值类型，避免反序列化歧义。
禁止混用 POJO 与 Map：不要为 shipments 单独写一个 ShipmentsResponse 类再试图用 @JsonAnyGetter —— 这会增加复杂度且易出错；统一用 Map 更简洁、可靠。
Spring Boot 默认已启用 Jackson：无需额外配置，但可检查 application.yml 是否意外禁用了 spring.jackson.serialization.write_dates_as_timestamps=false 等影响 JSON 格式的设置。