SpringMVC日期格式屬性自動轉成時間戳實現源碼分析

背景介紹

SpringMVC搭建的微服務系統，後端數據庫對時間類型的存儲使用的是Long類型，而前端框架傾向於使用yyyy-MM-dd HH:mm:ss這種標準顯示格式，前端JSON格式的請求報文與後臺的接口交互都需要進行格式轉換，這部分轉換功能由後臺實現。

使用時我們發現，前端定義的JSON請求，時間格式爲yyyy-MM-dd HH:mm:ss，如果後臺定義的POJO相應的屬性爲Long類型，可以自動轉換爲時間戳，對此非常好奇，框架是如何實現這一功能的？

框架選型、版本及主要功能

spring boot 2.1.6.RELEASE
spring cloud Greenwich.SR3
alibaba fastjson 1.2.60

注意json框架使用的是fastjson

代碼演示

爲了方便演示，定義一個特別簡單的POJO類：

public class DateReq {

	private String dateFormat;
	private Long timestamp;

    // 省略getter/setter/toString方法
}

再定義一個簡單的Controller方法：

@RestController
public class DemoController {

	@PostMapping(value = "/json/demo/info")
	public ApiResponse<?> dateJson(@RequestBody DateReq request) {
		System.out.println(request);
	}
}

請求報文如下：

{
    "dateFormat": "2020-08-07 18:50:00",
    "timestamp": "2020-08-07 18:50:00"
}

響應的結果:DateReq{dateFormat='2020-08-07 18:50:00', timestamp=1596797400000}

從結果可以發現，dateFormat字段我們定義的是String類型，timestamp定義的是Long類型，請求報文兩個字段使用相同的值，但是到了Controller方法裏，timestamp自動變成Long類型的時間戳了，並且是按東8區轉換的。

在這裏我們可以得到一個使用經驗：POJO的時間格式是可以自動轉換成Long類型時間戳的，默認時區取操作系統的時區，或者通過jvm參數-Duser.timezone=GMT+08設置。

源碼閱讀

既然看到了自動轉換的效果，非常好奇框架是怎麼實現的，我們通過斷點查找堆棧：

deserialze:79, LongCodec (com.alibaba.fastjson.serializer)
parseField:85, DefaultFieldDeserializer (com.alibaba.fastjson.parser.deserializer)
parseField:1224, JavaBeanDeserializer (com.alibaba.fastjson.parser.deserializer)
deserialze:850, JavaBeanDeserializer (com.alibaba.fastjson.parser.deserializer)
parseRest:1538, JavaBeanDeserializer (com.alibaba.fastjson.parser.deserializer)
deserialze:-1, FastjsonASMDeserializer_3_DateReq (com.alibaba.fastjson.parser.deserializer)
deserialze:284, JavaBeanDeserializer (com.alibaba.fastjson.parser.deserializer)
parseObject:692, DefaultJSONParser (com.alibaba.fastjson.parser)
parseObject:383, JSON (com.alibaba.fastjson)
parseObject:448, JSON (com.alibaba.fastjson)
parseObject:556, JSON (com.alibaba.fastjson)
readType:263, FastJsonHttpMessageConverter (com.alibaba.fastjson.support.spring)
read:237, FastJsonHttpMessageConverter (com.alibaba.fastjson.support.spring)
readWithMessageConverters:204, AbstractMessageConverterMethodArgumentResolver (org.springframework.web.servlet.mvc.method.annotation)
readWithMessageConverters:157, RequestResponseBodyMethodProcessor (org.springframework.web.servlet.mvc.method.annotation)
resolveArgument:130, RequestResponseBodyMethodProcessor (org.springframework.web.servlet.mvc.method.annotation)
resolveArgument:124, HandlerMethodArgumentResolverComposite (org.springframework.web.method.support)

發現了兩處有價值的信息：

觸發消息類型轉換類是FastJsonHttpMessageConverter
真正完成類型映射是fastjson框架

有這個思路，閱讀源碼時可以把重點放在fastjson上，從JSON反序列化爲POJO，Long類型字段處理，找到這段代碼：

public <T> T deserialze(DefaultJSONParser parser, Type clazz, Object fieldName) {
        JSONLexer lexer = parser.lexer;

        Long longObject;
        try {
            int token = lexer.token();
            if (token == 2) {
                long longValue = lexer.longValue();
                lexer.nextToken(16);
                longObject = longValue;
            } else if (token == 3) {
                BigDecimal number = lexer.decimalValue();
                longObject = TypeUtils.longValue(number);
                lexer.nextToken(16);
            } else {
                if (token == 12) {
                    JSONObject jsonObject = new JSONObject(true);
                    parser.parseObject(jsonObject);
                    longObject = TypeUtils.castToLong(jsonObject);
                } else {
                    Object value = parser.parse();
                    // 關注這一行，yyyy-MM-dd HH:mm:ss會執行這一行代碼
                    longObject = TypeUtils.castToLong(value);
                }

                if (longObject == null) {
                    return null;
                }
            }
        } catch (Exception var9) {
            throw new JSONException("parseLong error, field : " + fieldName, var9);
        }

        return clazz == AtomicLong.class ? new AtomicLong(longObject) : longObject;
    }

重點關注longObject = TypeUtils.castToLong(value);，yyyy-MM-dd HH:mm:ss格式的數據會執行這一行代碼，跟進去查看源碼：

public static Long castToLong(Object value) {
        if (value == null) {
            return null;
        } else if (value instanceof BigDecimal) {
            return longValue((BigDecimal)value);
        } else if (value instanceof Number) {
            return ((Number)value).longValue();
        } else {
            if (value instanceof String) {
                String strVal = (String)value;
                if (strVal.length() == 0 || "null".equals(strVal) || "NULL".equals(strVal)) {
                    return null;
                }

                if (strVal.indexOf(44) != 0) {
                    strVal = strVal.replaceAll(",", "");
                }

                try {
                    return Long.parseLong(strVal);
                } catch (NumberFormatException var4) {
                    // 在異常裏做最後的掙扎，今天的案例是執行到這裏的
                    JSONScanner dateParser = new JSONScanner(strVal);
                    Calendar calendar = null;
                    if (dateParser.scanISO8601DateIfMatch(false)) {
                        calendar = dateParser.getCalendar();
                    }

                    dateParser.close();
                    if (calendar != null) {
                        return calendar.getTimeInMillis();
                    }
                }
            }

            if (value instanceof Map) {
                Map map = (Map)value;
                if (map.size() == 2 && map.containsKey("andIncrement") && map.containsKey("andDecrement")) {
                    Iterator iter = map.values().iterator();
                    iter.next();
                    Object value2 = iter.next();
                    return castToLong(value2);
                }
            }

            throw new JSONException("can not cast to long, value : " + value);
        }
    }

可以看到在castToLong方法裏，對假想的數據類型做各種假設處理，很不幸的是我們試驗的數據格式，是在NumberFormatException異常裏完成的最後掙扎，使用JSONScanner類接收的請求數據。

可以看到在這裏通過調用dateParser.scanISO8601DateIfMatch對數據進行解析，得到calendar對象實例，最終通過calendar獲取時間戳，scanISO8601DateIfMatch方法邏輯很複雜，總共有450多行，這裏截取了其中一部分展現一下：

private boolean scanISO8601DateIfMatch(boolean strict, int rest) {
        if (rest < 8) {
            return false;
        }

        char c0 = charAt(bp);
        char c1 = charAt(bp + 1);
        char c2 = charAt(bp + 2);
        char c3 = charAt(bp + 3);
        char c4 = charAt(bp + 4);
        char c5 = charAt(bp + 5);
        char c6 = charAt(bp + 6);
        char c7 = charAt(bp + 7);

        if ((!strict) && rest > 13) {
            char c_r0 = charAt(bp + rest - 1);
            char c_r1 = charAt(bp + rest - 2);
        }

        char c10;
       

        if (rest < 9) {
            return false;
        }

        char c8 = charAt(bp + 8);
        char c9 = charAt(bp + 9);

        int date_len = 10;
        char y0, y1, y2, y3, M0, M1, d0, d1;
        if ((c4 == '-' && c7 == '-') // cn
                ||  (c4 == '/' && c7 == '/') // tw yyyy/mm/dd
        ) {
            y0 = c0;
            y1 = c1;
            y2 = c2;
            y3 = c3;
            M0 = c5;
            M1 = c6;
            d0 = c8;
            d1 = c9;
        } else if ((c4 == '-' && c6 == '-') // cn yyyy-m-dd
        ) {
            y0 = c0;
            y1 = c1;
            y2 = c2;
            y3 = c3;
            M0 = '0';
            M1 = c5;

            if (c8 == ' ') {
                d0 = '0';
                d1 = c7;
                date_len = 8;
            } else {
                d0 = c7;
                d1 = c8;
                date_len = 9;
            }
        } else if ((c2 == '.' && c5 == '.') // de dd.mm.yyyy
                || (c2 == '-' && c5 == '-') // in dd-mm-yyyy
        ) {
            d0 = c0;
            d1 = c1;
            M0 = c3;
            M1 = c4;
            y0 = c6;
            y1 = c7;
            y2 = c8;
            y3 = c9;
        } else if (c8 == 'T') {
            y0 = c0;
            y1 = c1;
            y2 = c2;
            y3 = c3;
            M0 = c4;
            M1 = c5;
            d0 = c6;
            d1 = c7;
            date_len = 8;
        } else {
            if (c4 == '年' || c4 == '년') {
                y0 = c0;
                y1 = c1;
                y2 = c2;
                y3 = c3;

                if (c7 == '月' || c7 == '월') {
                    M0 = c5;
                    M1 = c6;
                    if (c9 == '日' || c9 == '일') {
                        d0 = '0';
                        d1 = c8;
                    } else if (charAt(bp + 10) == '日' || charAt(bp + 10) == '일'){
                        d0 = c8;
                        d1 = c9;
                        date_len = 11;
                    } else {
                        return false;
                    }
                } else if (c6 == '月' || c6 == '월') {
                    M0 = '0';
                    M1 = c5;
                    if (c8 == '日' || c8 == '일') {
                        d0 = '0';
                        d1 = c7;
                    } else if (c9 == '日' || c9 == '일'){
                        d0 = c7;
                        d1 = c8;
                    } else {
                        return false;
                    }
                } else {
                    return false;
                }
            } else {
                return false;
            }
        }

        if (!checkDate(y0, y1, y2, y3, M0, M1, d0, d1)) {
            return false;
        }

        setCalendar(y0, y1, y2, y3, M0, M1, d0, d1);

        char t = charAt(bp + date_len);
       

        if (charAt(bp + date_len + 3) != ':') {
            return false;
        }
        if (charAt(bp + date_len + 6) != ':') {
            return false;
        }

        char h0 = charAt(bp + date_len + 1);
        char h1 = charAt(bp + date_len + 2);
        char m0 = charAt(bp + date_len + 4);
        char m1 = charAt(bp + date_len + 5);
        char s0 = charAt(bp + date_len + 7);
        char s1 = charAt(bp + date_len + 8);

        if (!checkTime(h0, h1, m0, m1, s0, s1)) {
            return false;
        }

        setTime(h0, h1, m0, m1, s0, s1);

        char dot = charAt(bp + date_len + 9);
        int millisLen = -1; // 有可能沒有毫秒區域，沒有毫秒區域的時候下一個字符位置有可能是'Z'、'+'、'-'
        int millis = 0;
       
        calendar.set(Calendar.MILLISECOND, millis);

        int timzeZoneLength = 0;
        char timeZoneFlag = charAt(bp + date_len + 10 + millisLen);

        if (timeZoneFlag == ' ') {
            millisLen++;
            timeZoneFlag = charAt(bp + date_len + 10 + millisLen);
        }

        char end = charAt(bp + (date_len + 10 + millisLen + timzeZoneLength));
        if (end != EOI && end != '"') {
            return false;
        }
        ch = charAt(bp += (date_len + 10 + millisLen + timzeZoneLength));

        token = JSONToken.LITERAL_ISO8601_DATE;
        return true;
    }

支持的格式還是挺多，不過基本上符合國內的日期使用習慣，像2020-08-08和2020/08/08，甚至2020年08月08日都行，解析的思路是按位截取判斷，然後作爲Calendar的參數，上述節選的代碼有刪節，有興趣可以查看原代碼。

小結

簡單做個小結，fastjson在SpringMVC中註冊了FastJsonHttpMessageConverter轉換器，並且由該轉換器驅動fastjson的反序列化能力，對一些常用格式的數據進行自動轉換，加快了研發效率。本篇內容從一個好奇心開始，到查閱源碼，瞭解框架內組件的協同，並在源碼中證實自己的想法，學習框架內解決問題的思路，希望這份好奇心，能夠驅動對框架源碼的閱讀。

專注Java高併發、分佈式架構，更多技術乾貨分享與心得，請關注公衆號：Java架構社區
可以掃左邊二維碼添加好友，邀請你加入Java架構社區微信羣共同探討技術

SpringMVC日期格式屬性自動轉成時間戳實現源碼分析

背景介紹

框架選型、版本及主要功能

代碼演示

源碼閱讀

小結

AI模型 Llama 3體驗筆記

【面試準備】又一次失敗的面試經歷，題目離譜～資深軟件測試工程師

dotnet 8 版本與銀河麒麟V10和UOS系統的 glibc 兼容性

學一點Ceph知識：初識Ceph

SpringMVC Json自定義序列化和反序列化

SpringMVC日期格式屬性自動轉成時間戳實現源碼分析

spring-cloud-gateway聚合swagger文檔

基於SpringCloud的enum枚舉值國際化處理實踐

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結