Java中@DateTimeFormat和@JsonFormat注解介绍

目录

1.@DateTimeFormat注解

1.1@DateTimeFormat注解简介1.2@DateTimeFormat注解的功能1.3@DateTimeFormat注解的注意点1.4@DateTimeFormat功能演示

1.4.1类型转换异常情况测试1.4.2接收url路径传参格式测试1.4.3接收Form-Data数据格式测试1.4.4接收JSON数据格式测试



2.@JsonFormat注解

2.1@JsonFormat注解简介2.2@JsonFormat注解的功能2.3@JsonFormat注解的注意点2.4@JsonFormat功能演示

3.总结

1.@DateTimeFormat注解


1.1@DateTimeFormat注解简介

@DateTimeFormat注解是由Spring提供的一个注解，位于Spring和核心组件之一的context组件。对应的所需依赖如下：

1. # SpringBoot对应的依赖
2.         <dependency>
3.             <groupId>org.springframework.boot</groupId>
4.             <artifactId>spring-boot-starter-web</artifactId>
5.         </dependency>
7. # Spring对应的依赖
8.         <dependency>
9.             <groupId>org.springframework</groupId>
10.             <artifactId>spring-webmvc</artifactId>
11.         </dependency>

复制代码

双击shift快捷键，全局搜索DateTimeFormat，查看外部库，DateTimeFormat本质上是一个接口

1. @Documented
2. @Retention(RetentionPolicy.RUNTIME)
3. @Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
4. public @interface DateTimeFormat {
5.    String style() default "SS";
7.    ISO iso() default ISO.NONE;
9.    String pattern() default "";
11.    String[] fallbackPatterns() default {};
13.    enum ISO {
14.       DATE,
15.       TIME,
16.       DATE_TIME,
17.       NONE
18.    }
19. }

复制代码

1.2@DateTimeFormat注解的功能

@DateTimeFormat注解的功能是将一个日期字符串转化为对应的Date类型，主要处理前端时间类型与后端pojo对象中的成员变量进行数据绑定，在注解属性patttern中所约束的时间格式并不会影响后端返回前端的时间类型数据格式。。
DateTimeFormat接口的pattern属性：

pattern属性类型为String类型，用于格式化字段或方法参数的自定义模式。默认为空字符串，表示没有指定自定义模式字符串。
当然也可以使用自定义日期模式字符串，如yyyy-MM-dd HH:mm:ss

1.3@DateTimeFormat注解的注意点

@DateTimeFormat注解既可以作用于pojo类型的属性上，也可以作用于方法参数上。前端传入的时间类型的字符串要和pattern属性所规定的规则相同。@DateTimeFormat注解只能处理非JSON数据格式的字符串（如url-String格式、Form-Data格式），如果要处理JSON数据格式，就需要采用@RequestBody注解，@RequestBody就是获取请求体中的内容（即JSON字符串），再通过JSON解析库（如Jackson、FatJosn）将JSON字符串转换为pojo对象。

两种JSON解析库所需依赖：

1.         <!--       fastjson所需依赖 -->
2.                 <dependency>
3.             <groupId>com.alibaba</groupId>
4.             <artifactId>fastjson</artifactId>
5.             <version>1.2.54</version>
6.         </dependency>

复制代码

Jackson由于是Spring提供的，所以它所需的依赖就在Spring依赖中。

@DateTimeFormat注解只是解析日期字符串转为Date类型，转换后的日期格式并不会受到@DateTimeFormat注解中pattern属性的约束。

1.4@DateTimeFormat功能演示


1.4.1类型转换异常情况测试

pojo层

1. @Data
2. @NoArgsConstructor
3. @AllArgsConstructor
4. @ToString
5. public class User {
6.     private String username;
7.     private Date birthday;
8. }

复制代码

controller层

1. @Slf4j
2. @RestController
3. @RequestMapping("/datetimeFormatTest")
4. public class DatetimeFormatTest {
6.     @GetMapping("/exception")
7.     public User dft1(User user){
8.       log.info( "用户信息是：" + user);
9.       return user;
10.     }
11. }

复制代码

用ApiFox进行接口测试，传输的数据格式为url路径传参

请求400，查看控制台日志信息

报错信息：即String类型转换为Date类型失败

Failed to convert property value of type ‘java.lang.String’ to required type ‘java.util.Date’ for property ‘birthday’; nested exception is org.springframework.core.convert

1.4.2接收url路径传参格式测试

pojo层

1. @Data
2. @NoArgsConstructor
3. @AllArgsConstructor
4. @ToString
5. public class User {
6.     private String username;
7.     @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
8.     private Date birthday;
9. }

复制代码

用ApiFox进行接口测试，传输的数据格式为url路径传参
查看响应情况和控制台输出情况：可以发现@DateTimeFormat注解对日期字符串进行了解析，转换为对应的Date类型
但是要注意：@DateTimeFormat注解只是解析日期字符串转为Date类型，转换后的日期格式并不会受到@DateTimeFormat注解中pattern属性的约束。

响应的JSON字符串数据如下：

1.4.3接收Form-Data数据格式测试

pojo和controller都不变
用ApiFox进行接口测试，传输的数据格式为Form-Data类型

测试结果：

响应的JSON字符串数据如下：

1.4.4接收JSON数据格式测试

接受JSON数据格式时，在接收参数时，通过@RequestBody获取请求体中的内容（即JSON字符串），再通过JSON解析库（如Jackson、FatJosn）将JSON字符串转换为pojo对象

pojo层不变controller层

通过FastJson处理JSON数据，fastjson默认使用的序列化格式就是：

DEFFAULT_DATE_FORMAT = “yyyy-MM-dd HH:mm:ss”;

1. @Slf4j
2. @RestController
3. @RequestMapping("/datetimeFormatTest")
4. public class DatetimeFormatTest {
5.     @GetMapping("/exception")
6.     public User dft1(@RequestBody String userMsg) {
7.         JSONObject jsonObject = new JSONObject();
8.         User user = JSONObject.parseObject(userMsg, User.class);
9.         log.info("用户信息是：" + user);
10.         return user;
11.     }
12. }

复制代码

用ApiFox进行接口测试，传输的数据格式为JSON类型

测试结果：

响应的JSON字符串数据如下：

使用JSON解析库Jackson进行解析JSON数据
controller层

1. @GetMapping("/exception")
2. public User dft1(@RequestBody String userMsg) {
3.     ObjectMapper objectMapper = new ObjectMapper();
4.     User user = null;
5.     try {
6.         user = objectMapper.readValue(userMsg, User.class);
7.     } catch (JsonProcessingException e) {
8.         e.printStackTrace();
9.     }
10.     log.info("用户信息是：" + user);
11.     return user;
12. }

复制代码

用ApiFox进行接口测试，传输的数据格式为JSON类型

测试结果
控制台报错，错误信息提示反序列化失败，因为jackson默认的日期反序列不支持yyyy-MM-dd HH:mm:ss 这种格式，而是默认"yyyy-MM-dd’T’HH:mm:ss.SSSX"，所以反序列化失败。

这就引出了今天要介绍的另一个注解@JsonForat

2.@JsonFormat注解


2.1@JsonFormat注解简介

@JsonFormat注解是由Jackson提供的一个注解，位于Jackson的annotation包中，本身也是一个接口

所对应的依赖如下：

1. <!--Jackson包-->
2. <dependency>
3.     <groupId>com.fasterxml.jackson.core</groupId>
4.     <artifactId>jackson-databind</artifactId>
5. </dependency>

复制代码

SpringBoot的web依赖默认内置的有Jackson相应依赖。

2.2@JsonFormat注解的功能

@JsonFormat注解的功能是处理请求中的JSON日期字符串和查询数据库中的日期类型。即可约束时间类型的请求格式和响应格式。
JsonFormat接口的pattern属性：

pattern属性类型为String类型，用于格式化字段或方法参数的自定义模式。默认为空字符串，表示没有指定自定义模式字符串。
当然也可以使用自定义日期模式字符串，如yyyy-MM-dd HH:mm:ss

JsonFormat接口的timezone属性：

东八区（[UTC]/[GMT]+08:00）是比[世界协调时间]（UTC）/[格林尼治时间]（GMT）快8小时的时区，我国就是属于东八区，所以要指定时区为"GTM+8"

2.3@JsonFormat注解的注意点

@JsonFormat只能作用在实体类上，不能作用于方法参数上。@JsonFormat会根据pattrn属性约束日期格式，在返回数据时会返回约束日期格式，这点和@DateTimeFormat不同@JsonFormat注解需要先通过@RequestBody将入参参数映射到实体后，@JsonFormat注解才能去对时间格式进行约束；

2.4@JsonFormat功能演示

pojo层

1. @Data
2. @NoArgsConstructor
3. @AllArgsConstructor
4. @ToString
5. public class User {
6.     private String username;
7.     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone = "GTM+8")
8.     private Date birthday;
9. }

复制代码

controller层

1. @Slf4j
2. @RestController
3. @RequestMapping("/datetimeFormatTest")
4. public class DatetimeFormatTest {
6.     @GetMapping("/exception")
7.     public User dft1(@RequestBody String userMsg) {
8.         ObjectMapper objectMapper = new ObjectMapper();
9.         User user = null;
10.         try {
11.             user = objectMapper.readValue(userMsg, User.class);
12.         } catch (JsonProcessingException e) {
13.             e.printStackTrace();
14.         }
15.         log.info("用户信息是：" + user);
16.         return user;
17.     }
18. }

复制代码

测试结果：

响应的JSON字符串数据如下：
可以发现@JsonFormat注解可以根据pattern属性对返回的数据进行约束

3.总结

当处理的数据格式为非JSON格式（url路径传参、Form-Data）的时候适合使用@DateTimeFormat注解进行处理，就是格式化后的日期格式并不会按照属性pattern中所约束的格式响应，如果想要规定日期格式，可采用SimpleDateFormat对象进行处理。

1. SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
2. String date = simpleDateFormat.format(user.getBirthday());
3. System.out.println(date);

复制代码

当处理的数据格式为JSON数据格式时适合使用@JsonFormat注解进行处理，在这之前需要使用@RequestBody注解获取请求体中的JSON字符串，再通过JSON解析库将JSON字符串转换为对应的POJO类型。或者是从数据库中查出对应的DateTime类型时对类型进行转换。

到此这篇关于Java中@DateTimeFormat和@JsonFormat注解介绍的文章就介绍到这了,更多相关@DateTimeFormat和@JsonFormat注解内容请搜索中国红客联盟以前的文章或继续浏览下面的相关文章希望大家以后多多支持中国红客联盟！