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

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

梦墨同学_5719

梦墨同学_5719

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

|

870人浏览过

|

来源于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)。

验证示例:

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工具

更多
Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

创客贴AI

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

DeepSeek

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

WorkBuddy

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

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

相关专题

更多
java
java

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

12077

2023.06.15

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

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

9162

2023.07.05

java自学难吗
java自学难吗

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

7832

2023.07.31

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

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

1284

2023.08.01

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

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

1028

2023.08.02

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

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

1516

2023.08.02

java有什么用
java有什么用

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

3149

2023.08.02

java在线网站
java在线网站

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

20411

2023.08.03

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

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

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