快捷導(dǎo)航

Springboot 全局時間格式化三種方式示例詳解

更新時間：2024年01月03日 09:14:29 作者：天空只是云

時間格式化在項目中使用頻率是非常高的,當(dāng)我們的 API? 接口返回結(jié)果,需要對其中某一個 date? 字段屬性進(jìn)行特殊的格式化處理,通常會用到 SimpleDateFormat? 工具處理,這篇文章主要介紹了3 種 Springboot 全局時間格式化方式,需要的朋友可以參考下

?一、@JsonFormat 注解

?@JsonFormat? 注解方式嚴(yán)格意義上不能叫全局時間格式化，應(yīng)該叫部分格式化，因為@JsonFormat? 注解需要用在實體類的時間字段上，而只有使用相應(yīng)的實體類，對應(yīng)的字段才能進(jìn)行格式化。

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

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

那就需要和 @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;
}

從結(jié)果上我們看到 @JsonFormat? 注解的優(yōu)先級比較高，會以 @JsonFormat? 注解的時間格式為主。

?三、@Configuration 注解

這種全局配置的實現(xiàn)方式與上邊的效果是一樣的。

注意：在使用此種配置后，字段手動配置@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));
        }
    }
}