springboot时间格式化与空值格式化

已于 2023-12-12 14:08:15 修改
阅读量1.5k 收藏 4
点赞数
分类专栏： spring boot 文章标签： spring boot java json
于 2023-01-16 17:06:51 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/worilb/article/details/128686586
版权
本文详细介绍了Spring Boot中时间格式化和空值格式化的处理方法，包括Json时间出参格式化，涉及局部和全局配置，以及Json和非Json参数的入参格式化。对于空值格式化，文章讨论了如何将空值转换为特定格式，并解决了自定义转换器后时间序列化和反序列化失效的问题。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

目录

1 时间格式化

1.1 出参格式化(Json)

创建一个测试类：

@Data
public class TestResponse {
   

    @ApiModelProperty("未格式化时间")
    private LocalDateTime localDateTime;

    @ApiModelProperty("未格式化时间")
    private LocalDate localDate;

    @ApiModelProperty("未格式化时间")
    private Date date;
}

restApi：

 @GetMapping("test")
 @ApiOperation("响应测试")
 public TestResponse test(){
   
      TestResponse response = new TestResponse();
      response.setDate(new Date());
      response.setLocalDateTime(LocalDateTime.now());
      response.setLocalDate(LocalDate.now());
      return response;
  }

响应参数带Time的采用的是“ yyyy-MM-dd’T’HH:mm:ss.SSS ”格式，并且DATE默认使用的是UTC时间，比北京时间慢。
在这里插入图片描述

1.1.1 局部配置

在字段上加上注解@JsonFormat

	@ApiModelProperty("已格式化时间")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime localDateTime;


    @ApiModelProperty("已格式化时间")
    @JsonFormat(pattern = "yyyy年MM月dd日")
    private LocalDate localDate;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") //date默认使用UTC时间,北京时间得+8
    @ApiModelProperty("已格式化时间")
    private Date date;

在这里插入图片描述

@JsonFormat是jakson自带注解(spring家族默认使用jakson进行序列化与反序列化)，常用属性如下：

属性 作用
pattern 格式化模板，如时间的’yyyy-MM-dd HH:mm:ss
shape 决定数据类型，如NUMBER、ARRAY，默认为ANY，任何类型
locale 语言环境
timezone 时区，默认为UTC

在这里插入图片描述

在JSR310FormattedSerializerBase类createContextual方法中会检查序列化器，首先会获取目标对象字段上的JsonFormat，如果JsonFormat 不为空，会读取其属性值。根据属性值创建DateTimeFormatter对象，并将其设置为序列化器模板。
最终通过HttpMessageConverter接口实现类的子类MappingJackson2HttpMessageConverter输出响应。MappingJackson2HttpMessageConverter为默认的Json转换类。

在这里插入图片描述
也就是更改了LocalDateSerializer、LocalDateTimeSerializer：

在这里插入图片描述

在这里插入图片描述

1.1.2 全局配置

注释掉@JsomFormat：
在这里插入图片描述

1.1.2.1 yml配置文件中进行全局配置
spring:
  jackson:
#    全局配置,但是对LocalDateTime和LocalDate无效
    date-format: yyyy-MM-dd HH:mm:ss
#    时区
    time-zone: GMT+8

重启，可以看到我们在配置文件中设置的格式与时区注入进了ObjectMapper.
在这里插入图片描述
因为未对LocalDateSerializer和LocalDateTimeSerializer进行改动，结果只对date生效。
在这里插入图片描述

1.1.2.2 编写配置类进行全局配置（推荐）

先取消上一步的配置
在这里插入图片描述

手写ObjectMapper配置类:

@Configuration
public class DateTimeConfiguration {
   

 

    @Bean
    public ObjectMapper initObjectMapper(){
    
        ObjectMapper objectMapper=new ObjectMapper();
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        //JavaTimeModule 是jackson通过jsr310引入的JAVA8格式化类，没有此Module，序列化后的值会比较乱
        objectMapper.registerModule(new JavaTimeModule());
        return objectMapper;
    }

}

运行结果同之前YML中配置一样：
在这里插入图片描述
所以LocalDateSerializer和LocalDateTimeSerializer中也得按我们需要的格式进行序列化：

 	@Bean
    public ObjectMapper initObjectMapper(){
    //自定义ObjectMapper配置并注册BEAN
        ObjectMapper objectMapper=new ObjectMapper();
        JavaTimeModule javaTimeModule=new JavaTimeModule();
        //针对LocalDateTime和LocalDate
        javaTimeModule.addSerializer(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
        //针对Date类
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        //JavaTimeModule 是jackson通过jsr310引入的JAVA8格式化类，没有此Module，序列化后的值会比较乱
        objectMapper.registerModule(javaTimeModule);
        return objectMapper;
    }

上面localdate字段未被全局序列化覆盖，因为字段上加了注解，说明局部优先于全局：
在这里插入图片描述
去掉注解：

在这里插入图片描述

在这里插入图片描述
也可以通过Jackson2ObjectMapperBuilder来构建新的ObjectMapper实例设置序列化与反序列化方式：

@Configuration
public class DateTimeConfiguration {
   


 	@Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
    //通过ObjectMapper构造器构建实例
        return builder -> {
   
            builder.simpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS"); //date格式,序列化和反序列化都是它
            //序列化
            builder.serializerByType(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日HH时mm分ss秒")));
            builder.serializerByType(LocalDate.class,new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日")));
            //反序列化
            builder.deserializerByType(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日HH时mm分ss秒")));
            builder.deserializerByType(LocalDate.class,new LocalDateDeserializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日")));
        };
    }

 

   //    @Bean
//    public ObjectMapper initObjectMapper(){ //自定义ObjectMapper配置并注册BEAN
//        ObjectMapper objectMapper=new ObjectMapper();
//        JavaTimeModule javaTimeModule=new JavaTimeModule();
//        //针对LocalDateTime和LocalDate
//        javaTimeModule.addDeserializer(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
//        javaTimeModule.addSerializer(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
//        //针对Date类
//        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
//        //JavaTimeModule 是jackson通过jsr310引入的JAVA8格式化类，没有此Module，序列化后的值会比较乱
//        objectMapper.registerModule(javaTimeModule);
//        return objectMapper;
//    }

}

1.2 入参格式化

1.2.1 json参数

创建测试接口

	@PostMapping("body")
    @ApiOperation("json请求测试")
    public TestResponse body(@RequestBody TestResponse testResponse){
   
        log.info("打印的body:{}",testResponse);
        return testResponse;
    }

在这里插入图片描述
在这里插入图片描述
因为LocalDateTimeDeserializer与LocalDateDeserializer默认格式模板分别为’yyyy-MM-ddTHH:mm:ss 、'yyyy-MM-dd '.
在这里插入图片描述
在这里插入图片描述
我们按照默认格式传输自然没问题：
在这里插入图片描述
在这里插入图片描述

1.2.1.1 局部配置

同样，我们也可以像局部序列化一样局部反序列化时间。
还是使用@JsonFormat注解（序列化与反序列化一致），此时，标了注解字段全局序列化配置失效：

	@ApiModelProperty("已格式化时间")
    @JsonFormat(pattern = "yyyy年MM月dd日HH时mm分ss秒")
    private LocalDateTime localDateTime;


    @ApiModelProperty("已格式化时间")
    @JsonFormat(pattern = "yyyy年MM月dd日")
    private LocalDate localDate;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss.SSS") //date默认使用UTC时间,北京时间得+8
    @ApiModelProperty("已格式化时间")
    private Date date;

同序列化时相同，JSR310DateTimeDeserializerBase反序列化时也是读取注解中的属性值，创建新的JsonDeserializer（包括LocalDateTimeDeserializer、LocalDateDeserializer等）
在这里插入图片描述

1.2.1.2 全局配置

序列化我们用了全局配置，反序列化自然也应该使用全局配置
去掉注解：
在这里插入图片描述
再已有全局配置加上反序列化方式：

	@Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
   
        return builder -> {
   
            builder.simpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS"); //date格式,序列化和反序列化都是它
            //序列化
            builder.serializerByType(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日HH时mm分ss秒")));
            builder.serializerByType(LocalDate.class,new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日")));
            //反序列化
            builder.deserializerByType(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日HH时mm分ss秒")));
            builder.deserializerByType(LocalDate.class,new LocalDateDeserializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日")));
        };
    }

在这里插入图片描述
自然也可以自定义并注册ObjectMapper到BEAN

	@Bean
    public ObjectMapper initObjectMapper(){
    //自定义ObjectMapper配置并注册BEAN
        ObjectMapper objectMapper=new ObjectMapper();
        JavaTimeModule javaTimeModule=new JavaTimeModule();
        //针对LocalDateTime和LocalDate
        //序列化
        javaTimeModule.addSerializer(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
        //反序列化
        javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
        javaTimeModule.addDeserializer(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        //针对Date类 序列化和反序列化都是它
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        //JavaTimeModule 是jackson通过jsr310引入的JAVA8格式化类，没有此Module，序列化后的值会比较乱
        objectMapper.registerModule(javaTimeModule);
        return objectMapper;
    }

//    @Bean
//    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
   
//        return builder -> {
   
//            builder.simpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS"); //date格式,序列化和反序列化都是它
//            //序列化
//            builder.serializerByType(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日HH时mm分ss秒")));
//            builder.serializerByType(LocalDate.class,new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日")));
//            //反序列化
//            builder.deserializerByType(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日HH时mm分ss秒")));
//            builder.deserializerByType(LocalDate.class,new LocalDateDeserializer(DateTimeFormatter.ofPattern("yyyy年MM月dd日")));
//        };
//    }
1.2.2 非json参数

将接口改入参改成非JSON类型

 	@PostMapping("param")
    @ApiOperation("普通参数请求测试")
    public TestResponse body(TestResponse testResponse){
   
        try {
   
            log.info("打印的param:{}",testResponse);
        } catch (Exception e) {
   
            e.printStackTrace();
        }
        return testResponse;
    }

在这里插入图片描述

在这里插入图片描述
此时我们配置的json反序列化方式是无效的

1.2.2.1 局部配置

我们再字段上加上注解@DateTimeFormat

	@ApiModelProperty("已格式化时间")
    @DateTimeFormat(pattern = "yyyy年MM月dd日HH时mm分ss秒")
    private LocalDateTime localDateTime;


    @ApiModelProperty("已格式化时间")
    @DateTimeFormat(pattern = "yyyy年MM月dd日")
最低0.47元/天 解锁文章
SpringBoot：几种常用的接口日期格式化方法
web13508588635的博客
02-15 832
在 Spring Boot 中，可以使用自定义参数转换器实现日期格式化。public?class?????@Bean????public?LocalDate>?????????return?new?????????????@Override????????????public?LocalDate?source)?????????????????return?????????????????????????????@Bean????public?????????return?new????????
springboot返回json的格式化问题
houzidengyue的博客
08-21 5110
在实际开发过程中，接口的定义和规范，严格意义上会细化到，空字符串应该返回null还是""，亦或是"null"，空数组应该返回null还是[]，包括是不是要返回value为null的字段。但是springboot默认使用的是Jackson json转换器。Jackson在设置json的格式化问题时虽然可以通过手动重写方法实现，但是不够灵活。因而可以使用阿里的fastjson实现格式的灵活配置，下面介...
springboot json时间格式化处理的方法
10-18
主要介绍了springboot json时间格式化处理的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
convert 日期格式_Springboot 关于日期时间格式化处理方式总结
weixin_39965490的博客
11-21 660
项目中使用LocalDateTime系列作为DTO中时间的数据类型，但是SpringMVC收到参数后总报错，为了配置全局时间类型转换，尝试了如下处理方式。注：本文基于Springboot2.x测试，如果无法生效可能是spring版本较低导致的。PS：如果你的Controller中的LocalDate类型的参数啥注解(RequestParam、PathVariable等)都没加，也是会出错的，因为默...
SpringBoot-日期格式化
最新发布
存在,即合理
06-05 599
在需要进行日期格式转换的Date属性上添加注解@DateTimeFormat(pattern = "需要转换的格式")springboot应用中，@RestController注解的json默认序列化中，日期格式默认为：2020-12-03T15:12:26.000+00:00 类型的显示。
SpringBoot 时间格式化
白云苍狗
07-30 475
主要针对接口响应数据，在返回给前端的时候时间格式参差不齐，采用统一配置的形式对时间进行格式化，避免了业务代码中的多余操作，SpringBoot 时间格式化、@JsonFormate、@JsonComponent
SpringBoot配置时间格式化
Web开发者
12-05 592
SpringBoot配置时间格式化
springboot全局日期格式化的两种方式
09-07
在Spring Boot应用中，日期格式化是一个常见的需求。本文将详细介绍两种实现Spring Boot全局日期格式化的方法，以帮助开发者在处理日期字段时提高效率和代码的整洁性。 ### 方式一：配置参数 #### YAML配置 ...
SpringBoot：定制JSON字段(日期格式、字段重命名、空值不返回、字段不显示等)以及反序列化操作
q736317048的博客
11-22 2031
在测试时发现有一些时间返回格式不对，或字段名不规范等，还有就是空值字段显示，我们都可以实现自定义的形式来返回数据 常用框架 阿里 fastjson,谷歌gson等 JavaBean序列化为Json， 性能：Jackson > FastJson > Gson > Json-lib 同个结构 Jackson、FastJson、Gson类库各有优点，各有自己的专长 空间换时间，时间换空间 jackson处理相关自动 指定字段不返回：@JsonIgnore 比如用户密码是不需要
springboot 使用spring cache缓存 和 使用fastjson配置redis系列化
09-13
// 设置Fastjson的配置，例如是否忽略空值、时间格式等 FastJsonConfig fastJsonConfig = new FastJsonConfig(); fastJsonConfig.setDateFormat("yyyy-MM-dd HH:mm:ss"); serializer.setFastJsonConfig...
[springboot] 时间全局格式化
weixin_48901677的博客
06-05 2572
springBoot 时间全局格式化，支持接收不完整时间格式
springboot 格式化日期
qq_37741426的博客
06-17 156
1、配置时区为上海时区 实体无须添加注解 多加八个小时 spring: jackson: date-format: yyyy-MM-dd HH:mm:ss time-zone: Asia/Shanghai 2、数据库连接后缀添加 ?useUnicode=true&zeroDateTimeBehavior=convertToNull&autoReconnect=true&characterEncoding=utf-8&useSSL=false&s
SpringBoot格式化日期
『愚』的博客
04-06 1318
在application.yml中添加如下代码： # 全局配置返回字符串 spring: jackson: date-format: yyyy-MM-dd HH:mm:ss time-zone: GMT+8
springboot 时间格式化
xy的博客
07-07 497
方法一：属性上加注解 时间属性上添加注解：@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") ``` @Data @Builder @NoArgsConstructor @AllArgsConstructor public class Employee implements Serializable { private Long id; ...
SpringBoot时间格式化
我的博客
10-03 367
文章目录方法一 JS格式化方法二 后端SimpleDateFormat格式化方法三 DateTimeFormatter格式化方法四 全局时间格式化方法五 全局时间格式化 方法一 JS格式化 function dateFormat(fmt, date) { let ret; const opt = { "Y+": date.getFullYear().toString(), // 年 "m+": (date.getMonth() + 1).toS
springboot时间格式化
wangwenzhe的博客
06-29 379
springboot时间格式化配置 # jackson时间格式化 spring.jackson.date-format = yyyy-MM-dd HH:mm:ss
在SpringBoot中格式化Json 时间
weixin_45776913的博客
07-21 1153
在SpringBoot中格式化Json 时间 参考链接: https://blog.youkuaiyun.com/u011277123/article/details/88856540 1.概括 在本文中我们将展示如何在SpringBoot中格式化Json 时间 我们将讨论使用Jackson格式化日期的各种方法,它被Spring Boot用作默认的JSON处理器。同时将会拓展一些使用fastJson格式化日期的方法 2.在时间字段上使用@JsonFromat 2.1 使用@JsonFromat格式化特定字段; pu
时间格式化springBoot
panbingqi2018
11-29 371
时间格式化，springBoot 只需在实体类get方法加上这个就可以了 @JsonFormat(pattern=“yyyy-MM-dd”) public Date getContSecStartDate() { return contSecStartDate; }
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值