LocalDateTime在項目中的使用（LocalDateTime對接前端通過時間戳互轉、LocalDateTime對接數據庫）

1. 博客編寫背景

本文章的編寫背景：由於在 JDK 8 中，Date、Timestamp 對象已經不推薦使用，所以在公司的新項目上，我計劃將 LocalDateTime 使用在新項目中。

由於本人所在項目組，統一的前後端時間的交互方式爲時間戳，而時間戳並不能直接被fastJson 或 jackson 直接轉換，所以踩了不少的坑，個人建議有耐心的看完。

========================================================

若是感覺廢話比較多，那麼直接看標註了【★★★】的即可
個人寫這個博客，並不想直接寫結論，更多的是想給讀者分享踩坑的過程

========================================================

---

2. LocalDateTime 前端交互

2.1 LocalDateTime 向前端寫入時間戳

2.1.1 fastJson 默認的寫入格式

本項目使用的是 fastJson 會寫前端，我們先看下以下代碼

1. 回寫前端的 VO 對象

@Data
public class LocalDateTimeVO {
    private LocalDateTime localDateTime;
}

2. 測試方法

public static void main(String[] args) {
    LocalDateTimeVO localDateTimeVO = new LocalDateTimeVO();
    localDateTimeVO.setLocalDateTime(LocalDateTime.now());
    String json = JSON.toJSONString(localDateTimeVO);
    System.out.println(json);
}

3. 控制檯輸出

{"localDateTime":"2020-03-12T23:00:28.747"}

從上圖中可以看出，服務端並不能正常的返回時間戳給前端。並不符合需求。

2.1.2 更改 fastJson 寫入格式，讓其回寫時間戳 （★★★）

1. fastJson提供了自定義 json 轉換的方法 @JSONFiled，我們添加 serializeUsing，將其指定到我們自定義的序列化控制器即可。
2. 自定義 fastJson 序列化轉換器，重寫 ObjectSerializer

/**
 * 由於 LocalDateTime 類型在轉換 JSON 的時候，並不能被轉換爲字符串，使用 @JsonFormat 只能轉換爲指定的 pattern 類型，因此我們需要自定義一個序列化執行器
 * LocalDateTime 序列化（將 LocalDateTime類型 轉換爲 時間戳 返回給前端 ）
 *
 * @author Chimm Huang
 * @date 2020/3/7
 */
public class LocalDateTimeSerializer implements ObjectSerializer {
    @Override
    public void write(JSONSerializer serializer, Object object, Object fieldName, Type fieldType, int features) throws IOException {
        if (object != null) {
            LocalDateTime localDateTime = (LocalDateTime) object;
            //將localDateTime轉換爲中國區（+8）時間戳。
            serializer.write(localDateTime.toInstant(ZoneOffset.ofHours(8)).toEpochMilli());
        } else {
            serializer.write(null);
        }
    }
}

3. 使用我們自己寫的 fastJson 序列化轉換器

@Data
public class LocalDateTimeVO {
    @JSONField(serializeUsing = LocalDateTimeSerializer.class)
    private LocalDateTime localDateTime;
}

4. 再次執行測試方法，控制檯輸出

{"localDateTime":1584026032912}

可以看出，LocalDateTime 已經成功被轉換爲了時間戳，並且可以返回給前端。

2.2 接收前端傳遞的時間戳爲 LocalDateTimme

2.2.1 LocalDateTime 默認接收的格式

不管我們傳遞時間戳（1584026032912），還是傳遞自定義格式（“2020-03-13”），在服務端接受的時候，都會報錯400。也就是說，傳入的格式是錯誤的，無法被 spring 轉換爲 LocalDateTime

經過我的粗略測試，我發現，默認的接受格式爲 LocalDateTime 特有的格式，即：2020-03-12T23:00:28.747，除此之外都會報400。這種格式與 Date 格式的唯一區別就在於，Date 在日與時之間是用空格區分的，而 LocalDateTime 是用 T 來區分的。

2.2.2 更改 fastJson 反序列化方法，讓其能夠轉換時間戳爲 LocalDateTime（★★★）

1. fastJson 提供的 @JSONField 註解包括了反序列化轉換器的指定，因此，我們重寫其方法 ObjectDeserializer

/**
 * 由於 時間戳 並不能直接被 fastJSON 轉換爲 LocalDateTime 類型，因此我們需要自定義一個序列化執行器
 * LocalDateTime 反序列化（將前端傳遞的 時間戳 轉換爲 LocalDateTime 類型）
 *
 * @author Chimm Huang
 * @date 2020/3/7
 */
public class LocalDateTimeDeserializer implements ObjectDeserializer {

    @Override
    @SuppressWarnings("unchecked")
    public LocalDateTime deserialze(DefaultJSONParser parser, Type type, Object fieldName) {
        long timestamp = parser.getLexer().longValue();
        if(timestamp == 0) {
            return null;
        }
        return Instant.ofEpochMilli(timestamp).atZone(ZoneOffset.ofHours(8)).toLocalDateTime();
    }

    @Override
    public int getFastMatchToken() {
        return 0;
    }
}

2. 使用我們自己寫的 fastJson 反序列化轉換器

@Data
pubcli class LocalDateTimeVO {
    @JSONField(serializeUsing = LocalDateTimeSerializer.class, deserializeUsing = LocalDateTimeDeserializer.class)
    private LocalDateTime localDateTime;
}

3. 測試方法

public static void main(String[] args) {
    String json = "{\"localDateTime\":1584026032912}";
    LocalDateTimeVO localDateTimeVO = JSON.parseObject(json, LocalDateTimeVO.class);
    System.out.println(localDateTimeVO);
}

4. 控制檯執行結果展示

LocalDateTimeVO(localDateTime=2020-03-12T23:13:52.912)

可以看出，時間戳成功被 fastJson 接受，並轉換爲了 LocalDateTime。

2.2.3 【坑】更改 SpringBoot 的 @RequestBody 爲 fastJson 接收（★★★）

當你看到這個小標題時，肯定會很疑惑，我們項目目前不就是使用的 fastJson
嗎？
實際情況經過我測試，得出的結論是，我們在回寫前端的時候，是使用 fastJson 進行轉換的，但是在接受 Json 的時候，是使用 Spring 默認的 jackson 來接受的，所以這會導致，我們重寫了 fastJson 的反序列化方法並未執行。前端傳遞時間戳給後端，後端報錯400。

---

因此，我們需要更改 spring 默認提供的 jackson 爲 fastJson

/**
 * springboot 默認使用的是 jackson 進行 requestBody 請求的封裝，該項目切換爲使用 fastJson 進行請求封裝和響應
 * 配置 springboot 使用 fastJson 進行數據的請求接受和響應
 *
 * @author Chimm Huang
 * @date 2020/3/7
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    public HttpMessageConverter<String> stringConverter() {
        return new StringHttpMessageConverter(StandardCharsets.UTF_8);
    }

    public FastJsonHttpMessageConverter fastConverter() {
        //1、定義一個convert轉換消息的對象
        FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();
        //2、添加fastJson的配置信息
        FastJsonConfig fastJsonConfig = new FastJsonConfig();
        fastJsonConfig.setSerializerFeatures(
                SerializerFeature.WriteMapNullValue,
                SerializerFeature.WriteNullStringAsEmpty,
                SerializerFeature.WriteNullNumberAsZero,
                SerializerFeature.WriteNullListAsEmpty,
                SerializerFeature.WriteNullBooleanAsFalse);

        fastJsonConfig.setCharset(StandardCharsets.UTF_8);
        //2-1 處理中文亂碼問題
        List<MediaType> fastMediaTypes = new ArrayList<>();
        fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
        fastConverter.setSupportedMediaTypes(fastMediaTypes);
        //3、在convert中添加配置信息
        fastConverter.setFastJsonConfig(fastJsonConfig);
        return fastConverter;
    }

    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.clear();
        converters.add(stringConverter());
        converters.add(fastConverter());
    }
}

配置完成之後，後端與前端使用時間戳進行交互已完成。

---

3. LocalDateTime 與數據庫交互（★★★）

與數據庫交互比較簡單，我們使用的 mybatis 的版本爲 3.4.5。且數據庫時間類型爲：datetime
我們只需要在 pom 文件中引入 jsr310 座標即可

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-typehandlers-jsr310</artifactId>
    <version>1.0.2</version>
</dependency>