@DateTimeFormat 和 @JsonFormat 注解详解

目录

  • 一、快速入门
    • 1.1 准备工作
    • 1.2、入参格式化(前端传参到后端)
    • 1.3、出参格式化(后端返回给前端)
    • 1.4、如果是请求体@RequestBody传参
  • 二、详细解释这两个注解
  • 1、@JsonFormat
  • 2、@DateTimeFormat
  • 注意:
    • 1、这两者的注解一般联合使用
    • 2、注意2
  • 参考链接

一、快速入门

先说总结:如果你要在实体类的属性上加注解,那么你这俩注解都加上,啥问题都没有。

1.1 准备工作

定义一个pojo,它有两个 java.util.Date 类型的属性 createDate和uploadDate。
现在属性上什么注解都没加,接着往下走看效果。

public class Student{private Integer id;private String name;private Date createDate;private Date uploadDate;// 省略get和set方法
}

定义一个Controller

@RequestMapping("/student")
@RestController
public class StudentController {@GetMapping("/test")public Student test(Student student) {System.out.println("前端传来的日期:" + student.getCreateDate());// 将前端传来的日期格式化SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");String date = sdf.format(student.getCreateDate());System.out.println("格式化后的日期:"+date);// 传一个当前日期给前端,想看看是什么格式的Student stu = new Student();stu.setCreateDate(new Date());return stu;}
}

在apipost传参测试,访问 /student/test ,并传入参数:2018-08-02 22:05:55,发现并不能访问成功,会抛出400异常,因为传入的参数是 String 类型的,而用来接收参数的 DateVo 的 date 属性是 java.util.Date 类型的,类型无法转换。怎么办呢?请往下看,也就是入参格式化。
在这里插入图片描述

1.2、入参格式化(前端传参到后端)

解决办法就是在接收参数的pojo类上的队友参数属性上加上注解: @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")

加完之后的pojo类:

public class Student{private Integer id;private String name;@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")private Date createDate;private Date uploadDate;// 省略get和set方法
}

再测试,这样就能请求成功,后端就能接收前端传的参数了,结果如下:

控制台输出:

前端传来的日期:Thu Aug 02 22:05:55 CST 2018
格式化后的日期:2018-08-02 22:05:55

响应:

{"id": null,"name": null,"createDate": "2024-08-13T11:37:59.022+00:00","uploadDate": null
}

在这里插入图片描述
请注意:
这样请求成功后,后端就能接收前端传的参数了,但后端接收到的日期时间的格式还是需要自己再手动转换一下。因为 @DateTimeFormat 注解的 pattern 属性值指定的日期时间格式并不是将要转换成的日期格式,这个指定的格式是和传入的参数对应的,假如注解为:

@DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss")

则传入的参数应该是这样的:2018/08/02 22:05:55,如果传入2018/08/02就会抛出400异常。

1.3、出参格式化(后端返回给前端)

在上述示例中,调用接口的返回结果为:

{"id": null,"name": null,"createDate": "2024-08-13T11:37:59.022+00:00","uploadDate": null
}

这个格式并不是我们想要的,那么如何将其进行格式化?这时就需要用到 jackson 的 @JsonFormat 注解。

改造 Student:

public class Student{private Integer id;private String name;@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createDate;private Date uploadDate;// 省略get和set方法
}

这样响应的日期就是正确的。

{"id": null,"name": null,"createDate": "2024-08-13 19:49:28","uploadDate": null
}

1.4、如果是请求体@RequestBody传参

pojo的属性类型是Date,不加@DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss")这个一样能接收到前端传来的日期。那么只能传 "createDate":"2018-08-02 ",因为Date不支持时分秒,没法接收"createDate":"2018-08-02 22:11:05"这种,如果传带时分秒的,用@DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss")也不管用。
在这里插入图片描述
如果你想在请求体中,传带时分秒的,并且返回时分秒的。可以如下操作,也就是平常开发最常用的。
pojo类:

public class Student{private Integer id;private String name;@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")// 这个加不加不影响结果,但是不能只有它,没有下边的JsonForm注解。但是可以只有下边的JsonForm注解。@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createDate;private Date uploadDate;// 省略get和set方法
}

稍微改了下刚才的Controller

 @GetMapping("/test")public Student test(@RequestBody Student student) {System.out.println("前端传来的日期:" + student.getCreateDate());// 将前端传来的日期格式化后返回SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");String date = sdf.format(student.getCreateDate());System.out.println("格式化后的日期:"+date);// 返回前端的日期Student stu = new Student();stu.setCreateDate(student.getCreateDate());return stu;}

在这里插入图片描述
注意:如果是请求体接收参数,只加@JsonForm注解,而不写@DateTimeFormat注解可以正常接收。

public class Student{private Integer id;private String name;@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createDate;private Date uploadDate;// 省略get和set方法
}

在这里插入图片描述

但如果是刚才的请求参数问题,不能只写@JsonForm注解,而不写@DateTimeFormat注解。这样会报400,也就是pojo如下,响应结果如下图。

public class Student{private Integer id;private String name;@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createDate;private Date uploadDate;// 省略get和set方法
}

记得在Controller里吧@requestBody去掉
在这里插入图片描述

二、详细解释这两个注解

文末的参考链接1讲的比较详细。

1、@JsonFormat

@JsonFormat 是 Jackson 库中的注解,用于在序列化和反序列化过程中控制日期和时间的格式。主要用于控制如何将 Java 对象中的日期时间格式化为 JSON 输出(即从后端到前端的格式化),适用于序列化和反序列化 JSON 数据,通常用在实体类中的日期字段上

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date time;

2、@DateTimeFormat

@DateTimeFormat 是 Spring 框架中用于处理日期和时间格式的注解,主要用于将前端传来的日期时间字符串转换为 Java 对象(即从前端到后端的解析),适用于处理 Web 请求中的日期时间参数,通常与 @RequestParam、@PathVariable 等注解结合使用。

1、用途:

@DateTimeFormat 用于格式化日期和时间,确保请求参数能够按照指定的格式被解析。
只对 @RequestParam@PathVariable 类型的参数有效,而对 @RequestBody 无效。对 @RequestBody 的日期格式化需要用到 @JsonFormat
支持的格式:

可以指定日期和时间的格式,例如 "yyyy-MM-dd""yyyy-MM-dd HH:mm:ss" 等。

2、示例代码

后端代码(Spring Boot Controller)

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;import java.time.LocalDate;
import java.time.LocalDateTime;@RestController
public class DateController {@GetMapping("/date")public String getDate(@RequestParam("date") @DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate date,@RequestParam("dateTime") @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime dateTime) {return "Date: " + date + ", DateTime: " + dateTime;}
}

API 测试代码(使用 Apipost)
假设你启动了上述 Spring Boot 应用,下面是如何在 Apipost 中测试这个接口:

GET 请求 URL:

http://localhost:8080/date?date=2024-08-13&dateTime=2024-08-13%2015:45:30

响应:

Date: 2024-08-13, DateTime: 2024-08-13T15:45:30

注意:

1、这两者的注解一般联合使用

@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone="GMT+8")
private Date time;

一般系统都是前后交互

对此总结如下:

@JsonFormat: 用于序列化和反序列化 JSON 数据中的日期时间字段,确保数据从后端到前端的一致性

@DateTimeFormat: 用于解析和格式化 Web 请求中的日期时间参数,确保数据从前端到后端的正确处理

2、注意2

  • 对 URL 参数有效: @DateTimeFormat 常用于 URL 参数的解析例如,@RequestParam 中的日期参数会受到 @DateTimeFormat 的影响

  • 对请求体中的参数: 在请求体中,@DateTimeFormat 的直接作用有限,如果请求体中的日期时间字段是 JSON格式的,@DateTimeFormat 不会直接影响解析,在这种情况下,通常使用 @JsonFormat 来指定 JSON 中的日期时间格式

如果需要在请求体中解析日期时间,应该确保 JSON 转换器(如 Jackson)能够正确处理日期格式。

参考链接

参考链接1: https://blog.csdn.net/weixin_43888891/article/details/126846791
参考链接2:https://blog.csdn.net/weixin_47872288/article/details/135538776

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/402083.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

大型、复杂、逼真的安全服和安全帽检测:SFCHD数据集和SCALE方法

智能守护工地安全:SFCHD数据集与SCALE模块介绍 在人工智能(AI)技术飞速发展的今天,其在建筑工地安全领域的应用正逐渐展现出巨大潜力。尤其是高风险行业如化工厂的施工现场,对工人的保护措施要求极为严格。个人防护装…

Vue 生命周期详解含demo、面试常问问题案例

Vue 生命周期详解、面试常问问题案例 含 demo 文章目录 Vue 生命周期详解、面试常问问题案例 含 demo一、Vue 生命周期是什么二、Vue 中如何使用生命周期钩子1. **beforeCreate**2. **created**3. **beforeMount**4. **mounted**5. **beforeUpdate**6. **updated**7. **beforeD…

使用Arduino IDE生成带有bootloader的烧录文件

使用Arduino IDE生成bin(烧录)文件 1、在“项目”中,选择“导出已编译的二进制文件” 2、在工程目录中,会出现“build”文件夹 3、在build文件夹中,有hex文件,以及包含bootloader的bin和hex文件 bin和h…

小程序营销实战:利用小程序实现精准营销与增长

小程序营销实战:利用小程序实现精准营销与增长 在数字化营销日益重要的今天,小程序以其轻量、便捷的特点,成为了企业实现精准营销与增长的重要工具。本文将从策略规划、用户洞察、内容创新、技术应用以及数据分析等多个维度,特别…

Element-01.快速入门

1.什么是Element 2.快速入门 第二步引入ElementUI组件库,在当前的工程目录下的main.js文件中引入。 import Vue from vue; import ElementUI from element-ui; import element-ui/lib/theme-chalk/index.css; import App from ./App.vue;Vue.use(ElementUI); 第一…

Python深度学习框架库之caffe使用详解

概要 Caffe 是一个由伯克利视觉与学习中心(BVLC)开发的深度学习框架,以其速度快、模块化设计和社区支持而闻名。Caffe 适用于视觉识别任务,广泛应用于学术研究和产业实践中。Caffe 提供了一个强大的 Python 接口,使开发者能够方便地使用 Python 进行深度学习模型的开发和…

前端实现签字效果+合同展示

要做一个这样的功能,后端返回一个合同的整体html,前端进行签字,以下是一些重要思路! 获取一个高度会变的元素的高度 script 代码 let bigBoxHeight ref(0); // 获取到元素 let bigBox document.querySelector(".bigBox&…

催收业务怎么提高接通率

提高催收呼叫业务的接通率是一个综合性的任务,需要从多个方面进行优化。以下是一些具体的策略和建议: 一、优化呼叫时间与频次 1. 选择合适的呼叫时间:通过分析目标客户的活跃时段,选择他们最可能接听电话的时间进行呼叫…

用python的Manim 创建大括号

Brace 是 Manim 中用于创建大括号(curly braces)的一个对象类。它有几个子类,自定义了不同的功能。下面是每个类的简要解释: 1. ArcBrace 功能: 创建一个环绕弧线的括号。适用于需要围绕弧形线条的场景。用法: 通常用于图形中有…

【安卓】Service生命周期与前台活动

文章目录 Service生命周期使用前台Service 前些天发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家。 点击跳转到网站。 Service生命周期 在项目的任何位置调用了Context的startService()方法,相应的Se…

8/16 机器学习之逻辑回归

逻辑回归看起来是分类问题,但实际上还是建立数学函数模型计算最小化损失函数。 这里的模型就是根据数学知识建立其对应的概率函数

go注册到eureka微服务

// 注册到 Eureka,goeureka会自动30秒发送一次心跳 package mainimport ("fmt""github.com/SimonWang00/goeureka""github.com/gin-gonic/gin""github.com/robfig/cron/v3""time""wbGo/configs" )typ…

TCP机械臂测试

通过w(红色臂角度增大)s(红色臂角度减小)d(蓝色臂角度增大)a(蓝色臂角度减小)按键控制机械臂 注意:关闭计算机的杀毒软件,电脑管家,防火墙 1)基于TCP服务器的机械臂,端口号是8888,ip是Windows的ip; 查看Windows的IP:按住Windowsr按键,输入cmd,输入ipconfig 2)点击软件中的开启监…

KubernetesMonitoring

监控集群中应用 监控集群本身 Control-Plane Components(api-server,coredns,kube-scheduler)Kubelet(cAdvisor)-暴露容器metricsKube-state-metrics-集群层面metrics(deployments,pods metrics)Node-exporter-Host相关metrics(cpu,mem,netw…

安防监控/视频汇聚平台EasyCVR如何配置,实现默认获取设备的子码流?

安防视频监控/视频集中存储/云存储/磁盘阵列EasyCVR平台基于云边端一体化架构,兼容性强、支持多协议接入,包括国标GB/T 28181协议、部标JT808、GA/T 1400协议、RTMP、RTSP/Onvif协议、海康Ehome、海康SDK、大华SDK、华为SDK、宇视SDK、乐橙SDK、萤石云SD…

离线安装prometheus与Grafana实现可视化监控

简介 prometheus 是一个专为云环境设计的开源系统监控和警报工具,它收集并存储多维度的时间序列数据,通过PromQL查询语言提供强大的数据检索能力,并支持可视化及警报功能。而 Grafana 则是一个开源的数据可视化平台,能够与包括Pr…

基于Vue2使用x2js将JSON转换成XML、将XML转换成JSON

x2js源码地址GitHub - abdolence/x2js: x2js - XML to JSON and back for JavaScriptx2js - XML to JSON and back for JavaScript. Contribute to abdolence/x2js development by creating an account on GitHub.https://github.com/abdolence/x2js import x2js from x2js;//…

【RabbitMQ】SpringBoot整合RabbitMQ

对于RabbitMQ的开发,Spring方法提供了更为方便的操作. Spring官网介绍: Spring AMQP RabbitMQ官网介绍: RabbitMQ tutorial - "Hello World!" | RabbitMQ 引入依赖 为了方便测试也引入SpringWeb依赖. <dependencies><dependency><groupId>org.s…

三级_网络技术_18_路由器的配置及使用

1.在Cisco路由器上用于永久保存路由器的开机诊断程序、引导程序和操作系统软件的存储器是()。 Flash NVRAM RAM ROM 2.在Cisco路由器中主要用来永久保存路由器的开机诊断程序、引导程序和操作系统&#xff0c;以完成路由器初始化进程的存储器是()。 RAM Disk Flash RO…

[Spring] Spring事务与事务的传播

&#x1f338;个人主页:https://blog.csdn.net/2301_80050796?spm1000.2115.3001.5343 &#x1f3f5;️热门专栏: &#x1f9ca; Java基本语法(97平均质量分)https://blog.csdn.net/2301_80050796/category_12615970.html?spm1001.2014.3001.5482 &#x1f355; Collection与…