@JsonFormat 注解的使用

今天药忘吃喽~ 2024-02-20 11:18 86阅读 0赞

#### SpringBoot 中的 @JsonFormat 注解 ####

*   *  1. 引言
     *  2. 简介
     *  3. 使用
     *   *  ①引入依赖
         *  ②添加注解

### 1. 引言 ###

在前后端交互过程当中，往往需要后端返回前端所需要的日期类型数据，所以在将数据返回给前端时，可能会需要对日期类型进行格式化；  
为更便捷的返回需要的数据，可以用 `@JsonFormat` 注解，其作用就是把DATE类型的数据转化成为我们想要的格式。

### 2. 简介 ###

`@JsonFormat` 是Jackson中定义的一个注解，可以在数据返回前端时进行格式化；

例如前端需要的字符串格式的日期：“2023年10月31日 18时22分22秒”，则需要如下配置：

@JsonFormat(pattern = “yyyy年MM月dd日 HH时mm分ss秒”)
    private Date createTime;

解析后存入DB中的依然为：2022-10-31 18:22:22，而在查询时返回的数据就会被格式化为：“2023年10月31日 18时22分22秒”

**注意**：只有在将实体返回JSON格式数据时才会转换格式，其他时候日期格式不会被转换！

### 3. 使用 ###

#### ①引入依赖 ####

@JsonFormat 注解不是SPRING自带的注解，而是Jackson的注解，所以需要在Maven中导入jackson相关的依赖包；

**情况一：非SpringBoot项目：**

<dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.12.6</version>
    </dependency>

**情况二：SpringBoot项目：**  
spring-boot-start-web下已经包了Jackson的相关依赖，不需要再添加依赖！

#### ②添加注解 ####

在实体类中的属性上面使用 `@JsonFormat` 注解；

**情况一：时间类型为 LocalTime 或 LocalDataTime：**  
只需要在属性上方定义时间类型即可；

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalTime createTime;
    
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;

**情况二：时间类型 Data：**  
在使用 Data 类型时，由于Jaskson格式化时是按照国际标准时间GMT的，而国内是CST时区，两者相差8h，所以需要手动指定时区；

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

参考：  
https://blog.csdn.net/goodjava2007/article/details/126028371  
https://www.cnblogs.com/Marydon20170307/p/17750947.html

发表评论取消回复

表情：

评论列表（有 0 条评论，86人围观）

还没有评论，来说两句吧...

相关阅读

相关 @JsonFormat与@DateTimeFormat注解的使用

@JsonFormat与@DateTimeFormat注解的使用 2019年02月14日 21:02:59 [kynobug][] 阅读数 144更多分类专栏： ...

旧城等待，/ 2024年04月18日 18:57/ 0 赞/ 111 阅读

相关 @JsonFormat 注解的使用

SpringBoot 中的 @JsonFormat 注解 1. 引言 2. 简介 3. 使用 ①引入依赖

今天药忘吃喽~/ 2024年02月20日 11:18/ 0 赞/ 87 阅读

相关 @JsonFormat与@DateTimeFormat注解的使用

> 最近做开源项目，持久层使用了Spring Data JPA。前面一篇文章介绍过`@CreatedDate`和`@LastModifiedDate`的使用，有兴趣的可以先去看

梦里梦外;/ 2023年10月07日 07:59/ 0 赞/ 59 阅读

相关 @JsonFormat与@DateTimeFormat注解的使用

一、区别 > 注解@JsonFormat主要是后台到前台的时间格式的转换 > 注解@DataFormAT主要是前台到后台的时间格式的转换二、@JsonFormat

谁践踏了优雅/ 2023年10月02日 10:36/ 0 赞/ 48 阅读

相关 @JsonFormat与@DateTimeFormat注解的使用

背景：从数据库获取时间传到前端进行展示的时候，我们有时候可能无法得到一个满意的时间格式的时间日期，在数据库中显示的是正确的时间格式，获取出来却变成了很丑的时间戳，@JsonFo

冷不防/ 2023年06月25日 14:27/ 0 赞/ 14 阅读

相关【注解使用】@JsonFormat与@DateTimeFormat注解的使用

本文目录一、总结二、实体类三、解释说明 -------------------- 一、总结：注解@JsonFormat：主要解决后端向前端传参时的时间格

刺骨的言语ヽ痛彻心扉/ 2023年05月29日 13:04/ 0 赞/ 48 阅读

相关 @JsonFormat与@DateTimeFormat注解的使用说明

从数据库获取时间传到前端进行展示的时候，我们有时候可能无法得到一个满意的时间格式的时间日期，在数据库中显示的是正确的时间格式，获取出来却变成了很丑的时间戳，@J

淩亂°似流年/ 2023年02月26日 05:23/ 0 赞/ 28 阅读

相关【注解使用】使用@JsonFormat注解踩过的坑

本文目录一、背景描述二、错误原因三、解决方案 -------------------- 一、背景描述项目技术栈：Spring boot（2.1.6.RE

超、凢脫俗/ 2022年12月26日 11:18/ 0 赞/ 296 阅读

相关 Jackson注解 @JsonFormat

@JsonFormat 用来表示json序列化的一种格式或者类型，主要有下面几个常用的属性 @JsonFormat(shape = JsonFormat.Shape.

妖狐艹你老母/ 2022年05月08日 12:52/ 0 赞/ 229 阅读

相关 @JsonFormat、@DateTimeFormat、@JSONField注解的使用

1.注解@JsonFormat 1)使用maven引入@JsonFormat所需要的jar包 <dependency> <groupId>com.fas

墨蓝/ 2022年03月07日 11:54/ 0 赞/ 1124 阅读