一文告訴你Java日期時(shí)間API到底有多爛

作者：YourBatman 2021-01-22 08:13:58

日期時(shí)間API因?yàn)檫^于常用，因此你可能都覺得它毫不起眼。坦白的說，如果你沒有復(fù)雜的日期時(shí)間需求要處理，如涉及到時(shí)區(qū)、偏移量、跨時(shí)區(qū)轉(zhuǎn)換、國(guó)際化顯示等等，那么可能覺得Date也能將就。

前言

你好，我是A哥(YourBatman)。

好看的代碼，千篇一律!難看的代碼，其實(shí)沒有什么代碼是“史上最爛”的，要有也只有“史上更爛”。

日期是商業(yè)邏輯計(jì)算的一個(gè)關(guān)鍵部分，任何企業(yè)的程序都需要正確的處理日期時(shí)間問題，否則很可能帶來事故和損失。為此本系列僅著眼于這一個(gè)點(diǎn)就寫了好幾篇文章，目的是幫助你系統(tǒng)化的搞定所有問題/難題。

平時(shí)我們都熱衷于吐槽同事的代碼有多爛，今天我們就來玩點(diǎn)狠的：吐槽吐槽JDK，看看它的日期時(shí)間API設(shè)計(jì)得到底有多爛。

❝說明：本文指的日期時(shí)間API是Date/Calendar系列，而非Java 8新的API。畢竟一般我們稱后者為JSR 310日期時(shí)間，請(qǐng)注意區(qū)分哈❞

本文提綱

版本約定

JDK：8

正文

誠(chéng)然，Java的API絕大多數(shù)設(shè)計(jì)得都是非常優(yōu)秀且成功的，否則Java也不可能成為編程語言界的常青藤，并且還常年霸榜。但是，JDK也有失手的地方，存在設(shè)計(jì)得非常爛的API，先來了解下。

最爛API投票

談到對(duì)Java API不滿意程度的調(diào)研，最出名的當(dāng)屬2010年國(guó)外一個(gè)大佬Tiago Fernandez發(fā)起的一個(gè)很有意思的投票，投票結(jié)果的數(shù)據(jù)統(tǒng)計(jì)圖表如下：

對(duì)橫向標(biāo)題欄的各個(gè)單詞解釋一下，從左到右依次為：

計(jì)算最終得分的公式為：

Score = (I can live with) + (Painful * 2) + (Crappy * 3) + (Hellish * 4)

按照此公式，計(jì)算出各API的得分，畫成直方圖直觀的展示出來：

好，排名出來了。從最爛 -> 最好的名次依次為：

EJB 2.x，簡(jiǎn)直“遙遙領(lǐng)先”
Date/Time/Calendar，今天的豬腳
XML/DOM
AWT/Swing
...

爛歸爛，想一想什么樣的爛API對(duì)你的產(chǎn)生影響會(huì)是最大的呢?答：很常用卻很爛的。倘若一個(gè)API設(shè)計(jì)得很爛但你很少用或者幾乎不用接觸，你也不會(huì)對(duì)它產(chǎn)生很大厭惡感。打個(gè)比方，一堆屎本身很臭，但若你并不需要走到它身旁也就聞不到，自然就不會(huì)覺得它有多礙眼了。

回到這個(gè)統(tǒng)計(jì)結(jié)果來，EJB 2.x的API設(shè)計(jì)得最爛這個(gè)結(jié)果無可厚非，但站在時(shí)間維度的現(xiàn)在(2021年)回頭來看，是可以完全忽略它了，畢竟現(xiàn)在的我們絕無可能再接觸到它，再爛又有何干呢?

EJB 2.x這個(gè)老古董，相信在看文章的絕大部分同學(xué)都沒見過甚至沒聽過它吧，A哥2015年入行，一上來Spring 4.x嘎嘎就是干，從未接觸過EJB。

❝說明：這個(gè)統(tǒng)計(jì)是2010年做的，那會(huì)EJB2.x的使用量還比較大，因此上了“榜首”❞

XML/DOM設(shè)計(jì)得也不好，但已完全被第三庫(kù)(如dom4j)取代，后者成為了事實(shí)的標(biāo)準(zhǔn);AWT/Swing是市場(chǎng)的抉擇，你用Java開發(fā)界面才會(huì)用到，否則不會(huì)接觸，屬于正常。

最后再看“屈居”第二名的Date/Time/Calendar日期時(shí)間API，它就不得了了。畢竟此API有個(gè)很大的特點(diǎn)：哪怕到了現(xiàn)在(2021年)依舊非常常用。所以，它設(shè)計(jì)得爛帶來的實(shí)際影響是蠻大的。

下面就來具體了解下它有哪些坑爹的設(shè)計(jì)和槽點(diǎn)，一起不吐不快。

日期時(shí)間API的七宗罪

罪狀一：Date同時(shí)表示日期和時(shí)間

java.util.Date被設(shè)計(jì)為日期 + 時(shí)間的結(jié)合體。也就是說如果只需要日期，或者只需要單純的時(shí)間，用Date是做不到的。

@Test 
public void test1() { 
    System.out.println(new Date()); 
} 
 
輸出： 
Fri Jan 22 00:25:06 CST 2021

這就導(dǎo)致語義非常的不清晰，比如說：

/** 
 * 是否是假期 
 */ 
private static boolean isHoliday(Date date){ 
    return  ...; 
}

判斷某一天是否是假期，只和日期有關(guān)，和具體時(shí)間沒有關(guān)系。如果代碼這樣寫語義只能靠注釋解釋，方法本身無法達(dá)到自描述的效果，也無法通過強(qiáng)類型去約束，因此容易出錯(cuò)。

❝說明：本文所有例子不考慮時(shí)區(qū)問題，下同❞

罪狀二：坑爹的年月日

@Test 
public void test2() { 
    Date date = new Date(); 
    System.out.println("當(dāng)前日期時(shí)間：" + date); 
    System.out.println("年份：" + date.getYear()); 
    System.out.println("月份：" + date.getMonth()); 
} 
 
輸出： 
當(dāng)前日期時(shí)間：Fri Jan 22 00:25:16 CST 2021 
年份：121 
月份：0

what?年份是121年，這什么鬼?月份返回0，這又是什么鬼?

無奈，看看這兩個(gè)方法的Javadoc：

尼瑪，原來 2021 - 1900 = 121是這么來的。那么問題來了，為何是1900這個(gè)數(shù)字呢?

月份，竟然從0開始，這是學(xué)的誰呢?簡(jiǎn)直打破了我認(rèn)為的只有index索引值才是從0開始的認(rèn)知啊，這種做法非常的不符合人類思維有木有。

❝索引值從0開始就算了，畢竟那是給計(jì)算機(jī)看的無所謂，但是你這月份主要是給人看的呀❞

罪狀三：Date是可變的

oh my god，也就是說我把一個(gè)Date日期時(shí)間對(duì)象傳給你，你竟然還能給我改掉，真是太沒安全感可言了。

@Test 
public void test() { 
    Date currDate = new Date(); 
    System.out.println("當(dāng)前日期是①：" + currDate); 
    boolean holiday = isHoliday(currDate); 
    System.out.println("是否是假期：" + holiday); 
 
    System.out.println("當(dāng)前日期是②：" + currDate); 
} 
 
/** 
 * 是否是假期 
 */ 
private static boolean isHoliday(Date date) { 
    // 架設(shè)等于這一天才是假期，否則不是 
    Date holiday = new Date(2021 - 1900, 10 - 1, 1); 
 
    if (date.getTime() == holiday.getTime()) { 
        return true; 
    } else { 
        // 模擬寫代碼時(shí)不注意，使壞 
        date.setTime(holiday.getTime()); 
        return true; 
    } 
} 
 
輸出： 
當(dāng)前日期是①：Fri Jan 22 00:41:59 CST 2021 
是否是假期：true 
當(dāng)前日期是②：Fri Oct 01 00:00:00 CST 2021

我就像讓你幫我判斷下遮天是否是假期，然后你竟然連我的日期都給我改了?過分了啊。這是多么可怕的事，存在重大安全隱患有木有。

針對(duì)這種case，一般來說我們函數(shù)內(nèi)部操作的參數(shù)只能是副本：要么調(diào)用者傳進(jìn)來的就是副本，要么內(nèi)部自己生成一個(gè)副本。

在本利中提高程序健壯性只需在isHoliday首行加入這句代碼即可：

private static boolean isHoliday(Date date) { 
    date = (Date) date.clone(); 
    ... 
}

再次運(yùn)行程序，輸出：

當(dāng)前日期是①：Fri Jan 22 00:44:10 CST 2021 
是否是假期：true 
當(dāng)前日期是②：Fri Jan 22 00:44:10 CST 2021

bingo。

但是呢，Date作為高頻使用的API，并不能要求每個(gè)程序員都有這種安全意識(shí)，畢竟即使百密也會(huì)有一疏。所以說，把Date設(shè)計(jì)為一個(gè)可變的類是非常糟糕的設(shè)計(jì)。

罪狀四：無法理喻的java.sql.Date

來，看看java.util.Date類的繼承結(jié)構(gòu)：

它的三個(gè)子類均處于java.sql包內(nèi)。且先不談這種垮包繼承的合理性問題，直接看下面這個(gè)使用例子：

@Test 
public void test3() { 
    // 竟然還沒有空構(gòu)造器 
    // java.util.Date date = new java.sql.Date(); 
    java.util.Date date = new java.sql.Date(System.currentTimeMillis()); 
 
    // 按到當(dāng)前的時(shí)分秒 
    System.out.println(date.getHours()); 
    System.out.println(date.getMinutes()); 
    System.out.println(date.getSeconds()); 
}

運(yùn)行程序，暴雷了：

java.lang.IllegalArgumentException 
 at java.sql.Date.getHours(Date.java:187) 
 at com.yourbatman.formatter.DateTester.test3(DateTester.java:65) 
 ...

what?又是一打破認(rèn)知的結(jié)果啊，第一句getHours()就報(bào)錯(cuò)啦。走進(jìn)java.sql.Date的方法源碼進(jìn)去一看，握草重寫了父類方法：

還有這么重寫父類方法的?還有王法嗎?這也算是JDK能干出來的事?赤裸裸的違背里氏替換原則等眾多設(shè)計(jì)原則，子類能力竟然比父類小，使用起來簡(jiǎn)直讓人云里霧里。

java.util.Date的三個(gè)子類均位于java.sql包內(nèi)，他們?nèi)峭ㄟ^Javadoc描述來進(jìn)行分工的：

java.sql.Date：只表示日期
java.sql.Time：只表示時(shí)間
java.sql.Timestamp：表示日期 + 時(shí)間

這么一來，似乎可以“理解”java.sql.Date為何重寫父類的getHours()方法改為拋出IllegalArgumentException異常了，畢竟它只能表示日期嘛。但是這種通過繼承再閹割的實(shí)現(xiàn)手法你們接受得了?反正我是不能的~

罪狀五：無法處理時(shí)區(qū)

因?yàn)槿掌跁r(shí)間的特殊性，不同的國(guó)家地區(qū)在同一時(shí)刻顯示的日期時(shí)間應(yīng)該是不一樣的，但Date做不到，因?yàn)樗讓哟a是這樣的：

也就是說它表示的是一個(gè)具體時(shí)刻(時(shí)間戳)，這個(gè)數(shù)值放在全球任何地方都是一模一樣的，也就是說new Date()和System.currentTimeMillis()沒啥兩樣。

JDK提供了TimeZone表示時(shí)區(qū)的概念，但它在Date里并無任何體現(xiàn)，只能使用在格式化器上，這種設(shè)計(jì)著實(shí)讓我再一次看不懂了。

罪狀六：線程不安全的格式化器

關(guān)于Date的格式化，站在架構(gòu)設(shè)計(jì)的角度來看，首先不得不吐槽的是Date明明屬于java.util包，那么它的格式化器DateFormat為毛卻跑到j(luò)ava.text里去了呢?這種依賴管理的什么鬼?是不是有點(diǎn)太過于隨意了呢?

另外，JDK提供了一個(gè)DateFormat的子類實(shí)現(xiàn)SimpleDateFormat專門用于格式化日期時(shí)間。但是它卻被設(shè)計(jì)為了線程不安全的，一個(gè)定位為模版組件的API竟然被設(shè)計(jì)為線程不安全的類，實(shí)屬瞎整。

就因?yàn)檫@個(gè)坑的存在，讓多少初中級(jí)工程師淚灑職場(chǎng)，算了說多了都是淚。另外，因?yàn)榫€程不安全問題并非必現(xiàn)問題，因此在黑盒/白盒測(cè)試、功能測(cè)試階段都可能測(cè)不出來，留下潛在風(fēng)險(xiǎn)。

❝這就是“靈異事件”：測(cè)試環(huán)境測(cè)試得好好的，為何到線上就出問題了呢?❞

罪狀七：Calendar難當(dāng)大任

從JDK 1.1 開始，Java日期時(shí)間API似乎進(jìn)步了些，引入了Calendar類，并且對(duì)職責(zé)進(jìn)行了劃分：

Calendar類：日期和時(shí)間字段之間轉(zhuǎn)換
DateFormat類：格式化和解析字符串
Date類：只用來承載日期和時(shí)間

有了Calendar后，原有Date中的大部分方法均標(biāo)記為廢棄，交由Calendar代替。

Date終于單純了些：只需要展示日期時(shí)間而無需再顧及年月日操作、格式化操作等等了。值得注意的是，這些方法只是被標(biāo)記為過期，并未刪除。即便如此，請(qǐng)?jiān)趯?shí)際開發(fā)中也一定不要使用它們。

引入了一個(gè)Calendar似乎分離了職責(zé)，但Calendar難當(dāng)大任，設(shè)計(jì)上依舊存在很多問題。

@Test 
public void test4() { 
    Calendar calendar = Calendar.getInstance(TimeZone.getDefault()); 
    calendar.set(2021, 10, 1); // -> 依舊是可變的 
 
    System.out.println(calendar.get(Calendar.YEAR)); 
    System.out.println(calendar.get(Calendar.MONTH)); 
    System.out.println(calendar.get(Calendar.DAY_OF_MONTH)); 
} 
 
輸出： 
2021 
10 
1

年月日的處理上似乎可以接受沒有問題了。從結(jié)果中可以發(fā)現(xiàn)，Calendar年份的傳值不用再減去1900了，這和Date是不一樣的，不知道這種行為不一致會(huì)不會(huì)讓有些人抓狂。

❝說明：Calendar相關(guān)的API是由IBM捐過來的，所以和Date不一樣貌似也“情有可原”❞

另外，還有個(gè)重點(diǎn)是Calendar依舊是可變的，所以存在不安全因素，參與計(jì)算改變值時(shí)請(qǐng)使用其副本變量。

總的來說，Calendar在Date的基礎(chǔ)上做了改善，但僅限于修修補(bǔ)補(bǔ)，并未從根本上解決問題。最重要的是Calendar的API使用起來真的很不方便，而且該類在語義上也完全不符合日期/時(shí)間的含義，使用起來更顯尷尬。

總之，無論是Date，還是Calendar，還是格式化DateFormat都用著太方便，且存在各式各樣的安全隱患、線程安全問題等等，這是API沒有設(shè)計(jì)好的地方。

并不孤單

日期時(shí)間API屬于基礎(chǔ)API，在各個(gè)語言中都是必備的。然而不僅僅是Java面臨著API設(shè)計(jì)很爛的處境，有些其它流行語言一樣如此，涌現(xiàn)出1個(gè)(1堆)三方庫(kù)比乙方庫(kù)設(shè)計(jì)更好的情況，比如：

Python：日期時(shí)間處理庫(kù)Arrow
JavaScript：日期時(shí)間處理庫(kù)Moment.js
.Net：日期時(shí)間處理庫(kù)Joda-Time

所以說，Java它并不孤單(自我安慰一把)

自我救贖：JSR 310

因?yàn)樵腄ate日期時(shí)間體系存在“七宗罪”，催生了第三方Java日期時(shí)間庫(kù)的誕生，如大名鼎鼎的Joda-Time的流行甚至一度成為標(biāo)配。

對(duì)于Java來說，如此重要的API模塊豈能被第三方庫(kù)給占據(jù)，開發(fā)者本就想簡(jiǎn)單的處理個(gè)日期時(shí)間還得導(dǎo)入第三方庫(kù)，使用也太不方便了吧。當(dāng)時(shí)的Java如日中天，因此就開啟了“收編”Joda-Time之旅。

2013年9月份，具有劃時(shí)代意義的Java 8大版本正式發(fā)布，該版本帶來了非常多的新特性，其中最引入矚目之一便是全新的日期時(shí)間API：JSR 310。

JSR 310規(guī)范的領(lǐng)導(dǎo)者是Stephen Colebourne，此人也是Joda-Time的締造者。不客氣的說JSR 310是在Joda-Time的基礎(chǔ)上建立的，參考了其絕大部分的API實(shí)現(xiàn)，因此若你之前是Joda-Time的重度使用者，現(xiàn)在遷移到Java 8原生的JSR 310日期時(shí)間上來幾乎無縫。

即便這樣，也并不能說JSR 310就完全等于Joda-Time的官方版本，還是有些許詫異的，例舉如下：

首先當(dāng)然是包名的差別，org.joda.time -> java.time標(biāo)準(zhǔn)日期時(shí)間包
JSR 310不接受null值，Joda-Time把Null值當(dāng)0處理
JSR 310所有拋出的異常是DateTimeException，它是個(gè)RuntimeException，而Joda-Time都是checked exception

簡(jiǎn)單感受下JSR 310 API：

@Test 
public void test5() { 
    System.out.println(LocalDate.now(ZoneId.systemDefault())); 
    System.out.println(LocalTime.now(ZoneId.systemDefault())); 
    System.out.println(LocalDateTime.now(ZoneId.systemDefault())); 
 
    System.out.println(OffsetTime.now(ZoneId.systemDefault())); 
    System.out.println(OffsetDateTime.now(ZoneId.systemDefault())); 
    System.out.println(ZonedDateTime.now(ZoneId.systemDefault())); 
 
    System.out.println(DateTimeFormatter.ISO_LOCAL_DATE.format(LocalDate.now())); 
    System.out.println(DateTimeFormatter.ISO_LOCAL_TIME.format(LocalTime.now())); 
    System.out.println(DateTimeFormatter.ISO_LOCAL_DATE_TIME.format(LocalDateTime.now())); 
}