3种时间格式化的方法，SpringBoot篇！

落日映苍穹つ 2023-10-05 09:37 19阅读 0赞

时间格式化在项目中使用频率是非常高的，当我们的 `API` 接口返回结果，需要对其中某一个 `date` 字段属性进行特殊的格式化处理，通常会用到 `SimpleDateFormat` 工具处理。

SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
    Date stationTime = dateFormat.parse(dateFormat.format(PayEndTime()));

可一旦处理的地方较多，不仅 `CV` 操作频繁，还产生很多重复臃肿的代码，而此时如果能将时间格式统一配置，就可以省下更多时间专注于业务开发了。

可能很多人觉得统一格式化时间很简单啊，像下边这样配置一下就行了，但事实上这种方式只对 `date` 类型生效。

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
    spring.jackson.time-zone=GMT+8

而很多项目中用到的时间和日期`API` 比较混乱， `java.util.Date` 、 `java.util.Calendar` 和 `java.time LocalDateTime` 都存在，所以全局时间格式化必须要同时兼容性新旧 `API`。

--------------------

看看配置全局时间格式化前，接口返回时间字段的格式。

@Data
    public class OrderDTO {
    
        private LocalDateTime createTime;
    
        private Date updateTime;
    }

很明显不符合页面上的显示要求（有人抬杠为啥不让前端解析时间，我只能说睡服代码比说服人容易得多~）

![format_png][] 未做任何配置的结果

### 一、@JsonFormat 注解 ###

`@JsonFormat` 注解方式严格意义上不能叫全局时间格式化，应该叫部分格式化，因为`@JsonFormat` 注解需要用在实体类的时间字段上，而只有使用相应的实体类，对应的字段才能进行格式化。

@Data
    public class OrderDTO {
    
        @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd")
        private LocalDateTime createTime;
    
        @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
        private Date updateTime;
    }

字段加上 `@JsonFormat` 注解后，`LocalDateTime` 和 `Date` 时间格式化成功。

![format_png 1][] @JsonFormat 注解格式化

### 二、@JsonComponent 注解（推荐） ###

这是我个人比较推荐的一种方式，前边看到使用 `@JsonFormat` 注解并不能完全做到全局时间格式化，所以接下来我们使用 `@JsonComponent` 注解自定义一个全局格式化类，分别对 `Date` 和 `LocalDate` 类型做格式化处理。

@JsonComponent
    public class DateFormatConfig {
    
        @Value("${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss}")
        private String pattern;
    
        /**
         * @author xiaofu
         * @description date 类型全局时间格式化
         * @date 2020/8/31 18:22
         */
        @Bean
        public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilder() {
    
            return builder -> {
                TimeZone tz = TimeZone.getTimeZone("UTC");
                DateFormat df = new SimpleDateFormat(pattern);
                df.setTimeZone(tz);
                builder.failOnEmptyBeans(false)
                        .failOnUnknownProperties(false)
                        .featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
                        .dateFormat(df);
            };
        }
    
        /**
         * @author xiaofu
         * @description LocalDate 类型全局时间格式化
         * @date 2020/8/31 18:22
         */
        @Bean
        public LocalDateTimeSerializer localDateTimeDeserializer() {
            return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern));
        }
    
        @Bean
        public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
            return builder -> builder.serializerByType(LocalDateTime.class, localDateTimeDeserializer());
        }
    }

看到 `Date` 和 `LocalDate` 两种时间类型格式化成功，此种方式有效。

![format_png 2][] @JsonComponent 注解处理格式化

但还有个问题，实际开发中如果我有个字段不想用全局格式化设置的时间样式，想自定义格式怎么办？

那就需要和 `@JsonFormat` 注解配合使用了。

从结果上我们看到 `@JsonFormat` 注解的优先级比较高，会以 `@JsonFormat` 注解的时间格式为主。

![format_png 3][]

### 三、@Configuration 注解 ###

这种全局配置的实现方式与上边的效果是一样的。

> “
> 
> 注意：在使用此种配置后，字段手动配置`@JsonFormat` 注解将不再生效。
> 
> ”

@Configuration
    public class DateFormatConfig2 {
    
        @Value("${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss}")
        private String pattern;
    
        public static DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    
        @Bean
        @Primary
        public ObjectMapper serializingObjectMapper() {
            ObjectMapper objectMapper = new ObjectMapper();
            JavaTimeModule javaTimeModule = new JavaTimeModule();
            javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer());
            javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer());
            objectMapper.registerModule(javaTimeModule);
            return objectMapper;
        }
    
        /**
         * @author xiaofu
         * @description Date 时间类型装换
         * @date 2020/9/1 17:25
         */
        @Component
        public class DateSerializer extends JsonSerializer<Date> {
            @Override
            public void serialize(Date date, JsonGenerator gen, SerializerProvider provider) throws IOException {
                String formattedDate = dateFormat.format(date);
                gen.writeString(formattedDate);
            }
        }
    
        /**
         * @author xiaofu
         * @description Date 时间类型装换
         * @date 2020/9/1 17:25
         */
        @Component
        public class DateDeserializer extends JsonDeserializer<Date> {
    
            @Override
            public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
                try {
                    return dateFormat.parse(jsonParser.getValueAsString());
                } catch (ParseException e) {
                    throw new RuntimeException("Could not parse date", e);
                }
            }
        }
    
        /**
         * @author xiaofu
         * @description LocalDate 时间类型装换
         * @date 2020/9/1 17:25
         */
        public class LocalDateTimeSerializer extends JsonSerializer<LocalDateTime> {
            @Override
            public void serialize(LocalDateTime value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
                gen.writeString(value.format(DateTimeFormatter.ofPattern(pattern)));
            }
        }
    
        /**
         * @author xiaofu
         * @description LocalDate 时间类型装换
         * @date 2020/9/1 17:25
         */
        public class LocalDateTimeDeserializer extends JsonDeserializer<LocalDateTime> {
            @Override
            public LocalDateTime deserialize(JsonParser p, DeserializationContext deserializationContext) throws IOException {
                return LocalDateTime.parse(p.getValueAsString(), DateTimeFormatter.ofPattern(pattern));
            }
        }
    }

![format_png 4][]

### 总结 ###

分享了一个简单却又很实用的 `Springboot` 开发技巧，其实所谓的开发效率，不过是一个又一个开发技巧堆砌而来，聪明的程序员总是能用最少的代码完成任务。

![format_png 5][]

往期推荐

[定时任务最简单的3种实现方法（超好用）][3]

[2020-08-18][3]

[![format_png 6][] ][3]

[List 集合去重的 3 种方法][List _ 3]

[2020-08-17][List _ 3]

[![format_png 7][] ][List _ 3]

[4种分布式Session的实现方式！老大直呼666...][4_Session_666...]

[2020-07-23][4_Session_666...]

[![format_png 8][] ][4_Session_666...]

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wT3phTDV1VzJhTUQzR0ZNenhaazhrT0tnRkVwTjl0TWNOZUtucFFRcmxxUlFpYjY5alNRQ1Vqc2liTnZzSHhoOU9XNU52aWF5aWJlNXZvTU5yVnBLWVllM2cvNjQw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wT3phTDV1VzJhTUQzR0ZNenhaazhrT0tnRkVwTjl0TUZkTGRwMXJlSUthTkhubVE4bW1ycHZGczRieGtIVDl5b1dMbnFpY2hiNGd4WU9DMmNIRUVEUUEvNjQw?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wT3phTDV1VzJhTUQzR0ZNenhaazhrT0tnRkVwTjl0TVd2QmFFUm9WT3RKTDlqMGpPSldPd2lhYjdvaWJhekFUVVBWZDMzSEV5YWliOEE0U0dMaWFWYXVTcmcvNjQw?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wT3phTDV1VzJhTUQzR0ZNenhaazhrT0tnRkVwTjl0TVpSeVpwdjF4Vnk1YnFvWmxISmNkZXRVM0FUSVE5OGNmSkxpYmNOeFpzWGFuUjhaZUdKRHRtTVEvNjQw?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wT3phTDV1VzJhTUQzR0ZNenhaazhrT0tnRkVwTjl0TXJJaWFDaWFDUllMMXNnaWI5ZkFYRlY3aWNlTHpzTjBwaWNhMW95VjVLdGljSG84a3h2VUJMaWFXOHh4NlEvNjQw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9iOTZDaWJDdDcwaWFid2p5b2pMaEEwM1B0eFVua05QUkVudDJGNDh5d2ZYTHBEZERBamljT1RQSThROTR0VkxiSjU4dGJSczEyaWFYREtoVU9XOWdkNE5sRkEvNjQw?x-oss-process=image/format,png
[3]: http://mp.weixin.qq.com/s?__biz=MzU1NTkwODE4Mw%3D%3D&chksm=fbcc7ce4ccbbf5f2500afa479ed59650792b4f2b2ebbb9e9d8bb397de6dca64c7f2617e23625&idx=2&mid=2247487964&scene=21&sn=dbcd21c4d57a62b8e2cf2aba18acb761#wechat_redirect
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy9Icld3Nlp1WENzZ3U0VDZWN1IxZzJ1UXZCbmlieVZmNkxkaWJ3S3M0OFA5M1BFbE1UbUY2SFE3ZzE0OWFGeExiaGQ5TGZnbm5DZXBpYzlKaWJtYU1tZ2dhYWcvNjQw?x-oss-process=image/format,png
[List _ 3]: http://mp.weixin.qq.com/s?__biz=MzU1NTkwODE4Mw%3D%3D&chksm=fbcc7c9accbbf58c2c98e4085c8c4cd1bc574753bd0a707b072ad9dd8ef664281aa199bfa83c&idx=1&mid=2247487906&scene=21&sn=fe0d98192629e7267899a54b2795dc4a#wechat_redirect
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy9Icld3Nlp1WENzaWFLQU51VFlLa2gzenVwVUk5RFNnMEZxd3lVYU9xYnhFNFEydFQ5dEVSQ2duemd5cE5YWjNFUEFUNzZQOUFyZUJSR2Z5THY4R3lKdHcvNjQw?x-oss-process=image/format,png
[4_Session_666...]: http://mp.weixin.qq.com/s?__biz=MzU1NTkwODE4Mw%3D%3D&chksm=fbcc62e1ccbbebf756fe7d76e57d620c3c79e02a22313a451846b5cc99722a5ecbd47b710e43&idx=1&mid=2247487449&scene=21&sn=a180501f05bebdb15cc327e07eed50df#wechat_redirect
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy9Icld3Nlp1WENzaWEzSHl5a1h5TkNLZnZ1dGhpY0lJQ2d5VWxUemlhR1c5aHo2NXQ4Yk45NUhqMXo4WHQxUHJZaWNHUHRNNWM2QWVpYWZOeXVDTklxeFQwdVFnLzY0MA?x-oss-process=image/format,png