讲师中心 微信公众号
AI工具推荐 视频效率加速

Java中 Jackson 自定义注解结合 JsonSerializer 怎么实现自定义 JSON 输出

冬萱酱_8416

冬萱酱_8416

发布时间:2026-07-16 13:20:14

|

594人浏览过

|

来源于php中文网

原创

Jackson可通过@FormattedDate注解+ContextualSerializer实现字段级日期格式化,支持动态读取pattern参数并复用序列化器,避免反射性能损耗。

java中 jackson 自定义注解结合 jsonserializer 怎么实现自定义 json 输出

在 Java 中,Jackson 通过 @JsonSerialize 注解 + 自定义 JsonSerializer 可以灵活控制任意类型(包括自定义类、字段、集合等)的 JSON 输出格式。若想进一步解耦和复用,可结合自定义注解实现“声明式序列化”,让业务代码更简洁、可读性更高。

定义自定义注解

先创建一个用于标记字段或类型的注解,比如 @FormattedDate,它不带逻辑,只起标识作用:

@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface FormattedDate {
    String pattern() default "yyyy-MM-dd HH:mm:ss";
}

这个注解支持加在字段上(如 private Date createTime;),也支持加在类上(配合 @JsonSerialize(using = ...) 全局生效)。

编写对应的 JsonSerializer

实现 JsonSerializer<Date>(或其他目标类型),并在其中读取注解参数:

立即学习“Java免费学习笔记(深入)”;

public class FormattedDateSerializer extends JsonSerializer<Date> {
    @Override
    public void serialize(Date value, JsonGenerator gen, SerializerProvider serializers) 
            throws IOException {
        if (value == null) {
            gen.writeNull();
            return;
        }
        // 尝试从字段/类型上获取 @FormattedDate 的 pattern
        AnnotatedMember member = serializers.getActiveView() != null 
                ? serializers.getAnnotationIntrospector().findAnnotation(
                        serializers.getActiveView(), FormattedDate.class)
                : null;

        // 更实用的做法:由 ContextualSerializer 提前解析注解(推荐)
        // 见下一节
        String pattern = "yyyy-MM-dd HH:mm:ss"; // 默认值
        gen.writeString(new SimpleDateFormat(pattern).format(value));
    }
}

⚠️ 注意:直接在 serialize() 里反射取注解较麻烦且性能差,**推荐使用 ContextualSerializer**。

Browser Js
Browser Js

轻量级CDP浏览器控制,适用于AI代理。相较于内置浏览器工具,token消耗降低3‑10倍,仅在浏览时使用。

下载

用 ContextualSerializer 动态绑定注解参数

让序列化器能感知所在字段的注解配置,关键在于实现 ContextualSerializer 接口:

  • 重写 createContextual() 方法,在序列化器被初始化时提取当前字段上的 @FormattedDate
  • 把 pattern 存入序列化器实例中,后续 serialize() 直接使用

public class FormattedDateSerializer extends JsonSerializer<Date> 
        implements ContextualSerializer {

    private final String pattern;

    public FormattedDateSerializer() {
        this("yyyy-MM-dd HH:mm:ss");
    }

    public FormattedDateSerializer(String pattern) {
        this.pattern = pattern;
    }

    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) {
        if (property != null) {
            FormattedDate ann = property.getAnnotation(FormattedDate.class);
            if (ann != null) {
                return new FormattedDateSerializer(ann.pattern());
            }
        }
        return this;
    }

    @Override
    public void serialize(Date value, JsonGenerator gen, SerializerProvider serializers) 
            throws IOException {
        if (value == null) {
            gen.writeNull();
            return;
        }
        gen.writeString(new SimpleDateFormat(pattern).format(value));
    }
}

在字段或类上使用注解

现在就可以像这样使用了:

public class User {
    private String name;

    @FormattedDate(pattern = "yyyy/MM/dd")
    private Date registerTime;

    @FormattedDate // 用默认格式
    private Date lastLogin;
}

序列化时,Jackson 会自动调用 createContextual() 拿到对应字段的 pattern,再执行格式化输出。

如果想全局对所有 Date 生效,也可在类上加 @JsonSerialize(using = FormattedDateSerializer.class),但此时无法按字段差异化配置——所以字段级注解 + ContextualSerializer 是更灵活的选择。

不复杂但容易忽略的是:必须确保 Jackson 的 ObjectMapper 启用了注解支持(默认已启用),且不要手动注册该 serializer(否则会绕过注解机制)。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

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

WorkBuddy

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

讯飞绘文

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

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

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

10077

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

7222

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6352

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1104

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

908

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1336

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2649

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

19971

2023.08.03

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

0

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

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

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