讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

Seko
Seko

AI短剧一键生成成片

剧云
剧云

中文短剧剧本制作平台

updream

一键生成高质量推广成片

如何使用 Jackson 动态为泛型包装类生成带类型名的 JSON 结构

千萱大大_1299

千萱大大_1299

发布时间:2026-01-27 11:19:06

|

695人浏览过

|

来源于php中文网

原创

如何使用 Jackson 动态为泛型包装类生成带类型名的 JSON 结构

本文介绍如何利用 jackson 的 `@jsontypeinfo` 与 `@jsontypename` 实现泛型 wrapper 类的序列化,使不同子类型(如 payloadfoo、payloadbar)自动映射为对应字段名(如 `"foo"`、`"bar"`),生成符合 soa 规范的嵌套 json 结构。

在构建统一 API 响应格式(如 SOA 风格)时,常需将业务数据封装进标准化容器,例如包含 soaHeader 和 payload 的通用 Wrapper 类。但默认情况下,Jackson 序列化 Wrapper 会生成类似 { "soaHeader": {}, "payload": { "foo": "..." } } 的结构,而无法自动将整个 Wrapper 对象以 payload 类型名(如 "foo")作为顶层字段名。

关键在于:@JsonRootName 仅作用于类本身,不支持动态绑定泛型实际类型;@JsonTypeName 单独使用也无法改变外层包装结构。正确解法是结合 多态序列化机制 —— 将 Wrapper 视为抽象基类,通过 @JsonTypeInfo 启用类型识别,并借助 @JsonSubTypes 显式声明子类型映射关系。

以下为完整实现方案:

import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

// 推荐:关闭空 Bean 报错,避免无属性类序列化失败
private static final ObjectMapper mapper = new ObjectMapper()
    .configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);

首先,为 Wrapper 类添加多态配置:

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载
@JsonTypeInfo(
    use = JsonTypeInfo.Id.NAME,
    include = JsonTypeInfo.As.WRAPPER_OBJECT, // ✅ 关键:以类型名为外层字段名包裹整个对象
    property = "" // 空字符串表示不额外添加类型字段,直接用类型名作 key
)
@JsonSubTypes({
    @JsonSubTypes.Type(value = PayloadFoo.class, name = "foo"),
    @JsonSubTypes.Type(value = PayloadBar.class, name = "bar")
})
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class Wrapper<T> {
    private SoaHeader soaHeader;
    private T payload;
}
⚠️ 注意:include = JsonTypeInfo.As.WRAPPER_OBJECT 是实现 "foo": { ... } 结构的核心——它让 Jackson 将整个对象序列化为 { "foo": { "soaHeader": ..., "payload": ... } },而非 { "type": "foo", "soaHeader": ..., "payload": ... }。

接着,为每个 payload 子类标注 @JsonTypeName:

@JsonTypeName("foo")
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class PayloadFoo {
    private String foo;
}

@JsonTypeName("bar")
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class PayloadBar {
    private String bar;
}

@Data
public static class SoaHeader {
    // 可扩展 header 字段,如 timestamp、traceId 等
}

最后,序列化示例:

public static void main(String[] args) throws JsonProcessingException {
    Wrapper<PayloadFoo> fooWrapper = new Wrapper<>(
        new SoaHeader(), 
        new PayloadFoo("hello")
    );

    Wrapper<PayloadBar> barWrapper = new Wrapper<>(
        new SoaHeader(), 
        new PayloadBar("world")
    );

    System.out.println(mapper.writerWithDefaultPrettyPrinter().writeValueAsString(fooWrapper));
    // 输出:
    // {
    //   "foo" : {
    //     "soaHeader" : { },
    //     "payload" : {
    //       "foo" : "hello"
    //     }
    //   }
    // }

    System.out.println(mapper.writerWithDefaultPrettyPrinter().writeValueAsString(barWrapper));
    // 输出:
    // {
    //   "bar" : {
    //     "soaHeader" : { },
    //     "payload" : {
    //       "bar" : "world"
    //     }
    //   }
    // }
}

✅ 优势总结:

  • 类型安全:编译期绑定 PayloadFoo → "foo",避免字符串硬编码错误;
  • 可扩展:新增 PayloadBaz 仅需添加 @JsonTypeName("baz") 及 @JsonSubTypes.Type 条目;
  • 符合规范:天然生成 SOA 所需的“类型名即资源路径”的 JSON 层级结构。

⚠️ 注意事项:

  • @JsonTypeInfo 必须加在 Wrapper 类上(而非字段),且 include = WRAPPER_OBJECT 不可省略;
  • 若 Wrapper 需反序列化,还需确保 payload 字段能被 Jackson 正确推断泛型类型(建议配合 TypeReference 或 @JsonUnwrapped 进阶处理);
  • Lombok 注解(如 @Data)需与 Jackson 兼容,推荐使用 lombok.config 启用 lombok.anyConstructor.addConstructorProperties=true 避免构造器问题。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

SoundView
SoundView Hot

SoundView是一款面向跨境电商的视频翻译、配音和本地化 AI 创作平台。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2335

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3842

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1276

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

4479

2025.09.10

java多态详细介绍
java多态详细介绍

本专题整合了java多态相关内容,阅读专题下面的文章了解更多详细内容。

375

2025.11.27

java多态详细介绍
java多态详细介绍

本专题整合了java多态相关内容,阅读专题下面的文章了解更多详细内容。

375

2025.11.27

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1938

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

3184

2023.09.04

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

40

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.4万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn