springboot對LocalDateTime類型入參和接口返回值格式化

背景

　　使用過java8的朋友應該都知道LocalDateTime類型，它作為全新的日期和時間API ，對比Date類型有着很大的優勢，極大的方便了我們對於時間和日期的操作。不過，如果在日常使用中，如果我們不對這個類型的字段進行處理的話，在打印或者直接返回到頁面的時候往往看到的格式是這樣的 2020-11-11T22:12:03.793 。顯然這種格式對於用戶來說閱讀體驗很差，那么，今天我們將通過這篇文章來介紹一下在使用LocalDateTime是如何在接受參數和返回信息時進行格式化。

測試

我們有如下類，供測試

UserVO.java

public class UserVO {

    private String userName;
    private String sex;
    private LocalDateTime birthday;
    //省略Getter and Setter方法

}

① post請求使用formdata進行傳參，這種情況下只需要在變量上添加@DateTimeFormat注解，案例如下：

public class UserVO {
    private String userName;
    private String sex;
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime birthday;
    //省略Getter and Setter方法
}

    @PostMapping("/testLocalDateTime")
    public UserVO testLocalDateTime(UserVO userVO) {
        System.out.println(userVO);
        return userVO;
    }

 調用之后可以看到控制台成功打印相關信息：

接口返回：

 ② 使用post請求傳參，並將參數放在請求體中以json格式傳參，此時，需要在接口的實體類前添加@RequestBody注解，同時在LocalDateTime類型的變量上添加 @JsonFormat注解，案例如下：

    private String userName;
    private String sex;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime birthday;
    //省略Getter and Setter方法

    @PostMapping("/testLocalDateTime2")
    public UserVO testLocalDateTime2(@RequestBody UserVO userVO) {
        System.out.println(userVO.toString());
        return userVO;
    }

調用之后一樣可以看到控制台成功打印相關信息：

 並且接口返回如下信息：

這里我們可以注意到：這種情況下不需要添加額外配置，也會對返回值進行格式化

補充

如果項目中返回LocalDateTime類型字段過多的話一個一個去添加@JsonFormat顯然是不合理的，那么我們可以在項目中添加如下配置，即可對所有LocalDateTime類型進行序列化和反序列化。

LocalDateTimeConvertConfig.java

此配置適用於於第一種情況，通過formDate進行傳參

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.converter.Converter;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;


@Slf4j
@Configuration
public class LocalDateTimeConvertConfig {
    @Bean
    public Converter<String, LocalDateTime> localDateTimeConvert() {
        return new Converter<String, LocalDateTime>() {
            @Override
            public LocalDateTime convert(String source) {
                DateTimeFormatter df = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
                LocalDateTime dateTime = null;
                try {
                    //2020-01-01 00:00:00
                    switch (source.length()) {
                        case 10:
                            log.debug("傳過來的是日期格式：{}", source);
                            source = source + " 00:00:00";
                            break;
                        case 13:
                            log.debug("傳過來的是日期 小時格式：{}", source);
                            source = source + ":00:00";
                            break;
                        case 16:
                            log.debug("傳過來的是日期 小時:分鍾格式：{}", source);
                            source = source + ":00";
                            break;
                    }
                    dateTime = LocalDateTime.parse(source, df);
                } catch (Exception e) {
                    log.error(e.getMessage(), e);
                }
                return dateTime;
            }
        };
    }
}

LocalDateTimeSerializerConfig.java

此配置適用於第二種情況，將請求參數放在requestbody中，可配合上一個文件使用，兩種方法都可以對接口返回值中的LocalDateTime類型進行格式化

import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@Slf4j
@Configuration
public class LocalDateTimeSerializerConfig {

    @Value("${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss}")
    private String pattern;

    // localDateTime 序列化器
    @Bean
    public LocalDateTimeSerializer localDateTimeSerializer() {
        return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern));
    }

    // localDateTime 反序列化器
    @Bean
    public LocalDateTimeDeserializer localDateTimeDeserializer() {
        return new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(pattern));
    }

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
//        return new Jackson2ObjectMapperBuilderCustomizer() {
//            @Override
//            public void customize(Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder) {
//                jacksonObjectMapperBuilder.featuresToDisable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
//                jacksonObjectMapperBuilder.serializerByType(LocalDateTime.class, localDateTimeSerializer());
//                jacksonObjectMapperBuilder.deserializerByType(LocalDateTime.class, localDateTimeDeserializer());
//            }
//        };
        //這種方式同上
        return builder -> {
            builder.serializerByType(LocalDateTime.class, localDateTimeSerializer());
            builder.deserializerByType(LocalDateTime.class, localDateTimeDeserializer());
            builder.simpleDateFormat(pattern);
        };
    }
}

 配置文件參考：https://blog.csdn.net/J080624/article/details/107065047/

總結

今天這篇文章主要講解了springboot中如何對LocalDateTime進行格式化，同時還提供了配置類來更加方便的全局格式化LocalDateTime格式。