Java 中怎么通过 @JsonFormat 与 @DateTimeFormat 规范 REST 接口时间日期传输

落墨同学_7486

落墨同学_7486

2026-10-21

440人浏览

原创

@jsonformat用于jackson处理json的序列化与反序列化,@datetimeformat用于spring mvc解析请求参数;二者职责不同,需按场景正确选用并常配合使用。

java 中怎么通过 @jsonformat 与 @datetimeformat 规范 rest 接口时间日期传输

在 Java 的 Spring Boot REST 接口中,时间日期字段的序列化与反序列化容易出错——前端传过来的字符串解析失败,或后端返回的时间格式不符合预期。关键在于区分两个注解的职责:@JsonFormat 作用于 JSON 序列化/反序列化(即 Jackson),@DateTimeFormat 作用于 HTTP 请求参数解析(如 @RequestParam、@ModelAttribute)。二者常配合使用,但不可互相替代。

@JsonFormat:控制 JSON 时间格式(响应 + 请求体)

该注解由 Jackson 处理,适用于 @RequestBody 接收的 JSON 对象中的时间字段,以及 返回给前端的 JSON 响应体 中的时间字段。

  • 必须搭配 @JsonProperty 或直接写在 LocalDateTime/Date/Instant 字段上
  • 常用属性:pattern(指定格式,如 "yyyy-MM-dd HH:mm:ss")、timezone(如 "GMT+8",避免时区偏差)、locale(影响月份/星期名称)
  • 对 Instant 类型,建议同时设 timezone = "GMT+8",否则可能因默认 UTC 导致显示早 8 小时

示例:

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
public class OrderDTO {
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private LocalDateTime createTime;

    @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
    private LocalDate orderDate;
}

@DateTimeFormat:处理 URL 查询参数与表单提交

该注解由 Spring MVC 的数据绑定机制处理,仅适用于 @RequestParam、@ModelAttribute 绑定的字符串参数(如 /api/orders?startTime=2024-05-01 09:00:00)。

  • 不适用于 @RequestBody 中的 JSON 字段(那是 Jackson 的事)
  • 支持 pattern(推荐)、iso(如 ISO_DATE_TIME)、style(短/中/长格式)
  • 若未标注且参数是时间类型,Spring 默认只接受 ISO 格式(如 2024-05-01T09:00:00),否则报 400 错误

示例:

@GetMapping("/orders")
public List<order> listOrders(
    @RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime startTime,
    @RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate endDate) {
    // ...
}</order>

全局配置建议(减少重复标注)

为避免每个字段都加注解,可统一配置 Jackson 和 Spring MVC 的默认行为:

  • Jackson 全局格式:在 application.yml 中配置
spring:
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8
    serialization:
      write-dates-as-timestamps: false

⚠️ 注意:该配置对 LocalDateTime 无效(它不是 JDK 传统日期类),仍需 @JsonFormat;但对 Date 和 Instant 生效。

  • Spring MVC 全局日期格式:自定义 WebMvcConfigurer
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
        registrar.setDateFormatter(DateTimeFormatter.ofPattern("yyyy-MM-dd"));
        registrar.setDateTimeFormatter(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
        registrar.setTimeFormatter(DateTimeFormatter.ofPattern("HH:mm:ss"));
        registrar.registerFormatters(registry);
    }
}

常见坑与验证要点

实际开发中高频出错点:

  • 前端传 "2024-05-01 10:30:00" 到 @RequestBody 的 LocalDateTime 字段 → 必须用 @JsonFormat,@DateTimeFormat 完全无效
  • 用 @RequestParam 接收 LocalDateTime 但没加 @DateTimeFormat → 默认只认 2024-05-01T10:30:00,空格格式直接 400
  • 返回 Instant 未设 timezone → 前端看到的是 UTC 时间(比北京时间晚 8 小时)
  • MySQL 存储 datetime 字段,Java 用 LocalDateTime 映射 → 确保数据库连接 URL 含 serverTimezone=GMT%2B8,否则可能时区错乱

接口调试时,用 Postman 检查请求头 Content-Type: application/json 是否正确,并确认时间字符串是否符合所设 pattern。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java js json

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

相关专题

更多
java
java

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

2023.06.15

10857

6

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

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

2023.07.05

7982

9

java自学难吗
java自学难吗

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

2023.07.31

6912

8

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

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

2023.08.01

1164

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1416

5

java有什么用
java有什么用

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

2023.08.02

2869

5

java在线网站
java在线网站

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

2023.08.03

20151

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1255

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习