0

0

使用 Jackson 自动派生格式化日期字段的完整实践指南

花韻仙語

花韻仙語

发布时间:2026-03-01 12:22:13

|

830人浏览过

|

来源于php中文网

原创

使用 Jackson 自动派生格式化日期字段的完整实践指南

本文详解如何借助 Jackson 的 @JsonFormat 与自定义 getter 方法,在序列化时动态生成符合客户端要求的格式化日期字符串(如 "dd/MM/yyyy HH:mm:ss"),避免冗余字段和手动格式化,实现简洁、可维护、零侵入的 JSON 序列化逻辑。

本文详解如何借助 jackson 的 `@jsonformat` 与自定义 getter 方法,在序列化时动态生成符合客户端要求的格式化日期字符串(如 `"dd/mm/yyyy hh:mm:ss"`),避免冗余字段和手动格式化,实现简洁、可维护、零侵入的 json 序列化逻辑。

在基于 Jackson 的 REST API 开发中,常遇到下游服务仅提供时间戳(epoch 毫秒值),而前端或第三方系统却要求以特定格式(如 "17/02/2023 13:56:56")展示日期。此时若在 POJO 中额外声明一个 String formattedDate 字段并试图用 @JsonFormat 注解它,不仅无效——因为 @JsonFormat 仅对 Date、LocalDateTime 等可序列化/反序列化的时间类型生效——还会引入数据冗余与同步风险。

✅ 正确做法是:保留单一权威时间字段(如 Date date),通过带 @JsonFormat 的公共 getter 方法动态导出格式化结果。Jackson 默认会将所有无参 public getter 视为可序列化属性(即 getFormattedDate() → JSON 字段 "formattedDate"),且该方法返回的 Date 对象将严格按注解规则格式化为字符串。

以下是推荐的实现方式(兼容 Lombok):

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.Data;
import lombok.Builder;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
import java.util.Date;

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@JsonIgnoreProperties(ignoreUnknown = true)
public class CalendarData {

    // 核心时间字段:接收 epoch long 或 Date,Jackson 反序列化时自动处理
    private Date date;

    private String errorCode;
    private String subErrorCode;

    // ✅ 动态派生字段:不占用存储,仅用于序列化输出
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy HH:mm:ss")
    public Date getFormattedDate() {
        return this.date; // 直接返回原始 Date,由 Jackson 负责格式化
    }
}

? 关键要点说明

  • @JsonFormat 必须作用于 Date/LocalDateTime 等时间类型,不可用于 String 字段——否则注解被忽略,无法触发格式化。
  • getFormattedDate() 是普通 getter,无需对应私有字段;Lombok 的 @Data 不会为其生成 setter 或字段,完全零耦合。
  • 反序列化时,date 字段仍正常接收 long(epoch)或 ISO 字符串(需配置 ObjectMapper 支持),getFormattedDate() 不参与反序列化,避免歧义。
  • 若需兼容 Java 8 时间 API,可将 Date 替换为 Instant 或 LocalDateTime,并配合 @JsonDeserialize/@JsonSerialize(如使用 JavaTimeModule)。

验证示例:

HaloTool
HaloTool

AI工具在线集合网站

下载
public static void main(String[] args) throws JsonProcessingException {
    ObjectMapper mapper = new ObjectMapper();
    // 启用对 Java 8 时间类型的默认支持(如使用 Instant)
    // mapper.registerModule(new JavaTimeModule());

    CalendarData data = CalendarData.builder()
            .date(new Date()) // 当前时间
            .errorCode("23")
            .subErrorCode("42")
            .build();

    String json = mapper.writeValueAsString(data);
    System.out.println(json);
}

输出结果(精确匹配指定格式):

{
  "date": 1676642216673,
  "errorCode": "23",
  "subErrorCode": "42",
  "formattedDate": "17/02/2023 13:56:56"
}

? 进阶提示

  • 如需统一全局日期格式,可在 ObjectMapper 初始化时配置:
    mapper.setDateFormat(new SimpleDateFormat("dd/MM/yyyy HH:mm:ss"));

    但建议优先使用 @JsonFormat 进行字段级精准控制。

  • 若必须保留 long date 原始字段(而非 Date),可通过 @JsonSetter + 自定义 setter 实现转换,但会增加复杂度,不推荐作为首选方案。

综上,利用 Jackson 的 getter 序列化机制 + @JsonFormat,是实现“单源时间、多格式输出”的最轻量、最标准、最可维护的方案——既符合单一职责原则,又充分发挥了框架能力,无需手写工具方法或 AOP 增强。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

450

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

326

2023.10.13

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

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

81

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

910

2023.08.02

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

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

658

2023.08.03

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

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

219

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1560

2023.10.24

Golang 测试体系与代码质量保障:工程级可靠性建设
Golang 测试体系与代码质量保障:工程级可靠性建设

Go语言测试体系与代码质量保障聚焦于构建工程级可靠性系统。本专题深入解析Go的测试工具链(如go test)、单元测试、集成测试及端到端测试实践,结合代码覆盖率分析、静态代码扫描(如go vet)和动态分析工具,建立全链路质量监控机制。通过自动化测试框架、持续集成(CI)流水线配置及代码审查规范,实现测试用例管理、缺陷追踪与质量门禁控制,确保代码健壮性与可维护性,为高可靠性工程系统提供质量保障。

24

2026.02.28

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号