Springboot 全局時間格式化操作

Posted on by

時間格式化在項目中使用頻率是非常高的，當我們的 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;
}

很明顯不符合頁面上的顯示要求（有人抬杠為啥不讓前端解析時間，我隻能說睡服代碼比說服人容易得多~）

一、@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 時間格式化成功。

二、@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 兩種時間類型格式化成功，此種方式有效。

@JsonComponent 註解處理格式化

但還有個問題，實際開發中如果我有個字段不想用全局格式化設置的時間樣式，想自定義格式怎麼辦？

那就需要和 @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")
    private Date updateTime;
}

從結果上我們看到 @JsonFormat 註解的優先級比較高，會以 @JsonFormat 註解的時間格式為主。

三、@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));
        }
    }
}

SpringBoot全局日期格式轉換失效問題記錄

今天新搭建瞭一個項目, 像以前一樣在一個配置類上做瞭個全局字符串轉換日期對象的轉換器!

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
        return builder -> {
           .............
        };
    }
}
//-----------------
//或者使用官網提供的 通過註解`@JsonComponent`來聲明其靜態內部類,都沒生效!

但是發現失效瞭, 在debug模式下根本沒有進來,沒有任何反應! 後面發現原因在繼承瞭WebMvcConfigurationSupport配置類,導致自動配置失效！

在網上找到的原因, 如下圖所示：

自動配置在當WebMvcConfigurationSupport類不存在的時候才會生效WebMvc自動化配置，WebMvc自動配置類中不僅定義瞭classpath:/META-INF/resources/，classpath:/resources/，classpath:/static/，classpath:/public/等路徑的映射，還定義瞭配置文件spring.mvc開頭的配置信息等。

類路徑上的 HttpMessageConverter 失效

解決方案

是在自己繼承瞭WebMvcConfigurationSupport上配置轉換器：

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport  {
    
    /**
     * 解決繼承WebMvcConfigurationSupport,靜態資源訪問不到
     *
     * @param registry
     * @author: ZhiHao
     * @date: 2020/6/11
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        super.addResourceHandlers(registry);
    }
    /**
     * 解決繼承WebMvcConfigurationSupport, json方式全局日期反序列化失效
     *
     * @param converters
     * @author: ZhiHao
     * @date: 2020/6/11
     */
    @Override
    protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        ObjectMapper objectMapper = new ObjectMapper();
        SimpleModule module = new SimpleModule();
        module.addDeserializer(Date.class, new JsonDeserializer<Date>() {
            @Override
            public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
                return DateConverterConfig.parse(jsonParser.getText());
            }
        });
        objectMapper.registerModule(module);
        converter.setObjectMapper(objectMapper);
        converters.add(converter);
        super.configureMessageConverters(converters);
    }
    /**
     * 解決繼承WebMvcConfigurationSupport, 普通請求,String轉換Date-轉換器
     *
     * @param registry
     * @author: ZhiHao
     * @date: 2020/6/11
     */
    @Override
    protected void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new DateConverterConfig());
    }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：