歡迎光臨
每天分享高質量文章

還在使用 SimpleDateFormat?你的專案崩沒?

  • 問題場景復現
  • 多執行緒不安全原因
  • 解決方案
    • 只在需要的時候創建新實體,不用static修飾
    • synchronized大法好
    • ThreadLocal
    • 基於JDK1.8的DateTimeFormatter

日常開發中,我們經常需要使用時間相關類,說到時間相關類,想必大家對SimpleDateFormat並不陌生。主要是用它進行時間的格式化輸出和解析,挺方便快捷的,但是SimpleDateFormat並不是一個執行緒安全的類。在多執行緒情況下,會出現異常,想必有經驗的小伙伴也遇到過。下麵我們就來分析分析SimpleDateFormat為什麼不安全?是怎麼引發的?以及多執行緒下有那些SimpleDateFormat的解決方案?

先看看《阿裡巴巴開發手冊》對於SimpleDateFormat是怎麼看待的:

附《阿裡巴巴Java開發手冊》v1.4.0(詳盡版)下載鏈接:https://yfzhou.oss-cn-beijing.aliyuncs.com/blog/img/《阿裡巴巴開發手冊》v 1.4.0.pdf

問題場景復現

一般我們使用SimpleDateFormat的時候會把它定義為一個靜態變數,避免頻繁創建它的物件實體,如下代碼:

public class SimpleDateFormatTest {

    private static final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    public static String formatDate(Date date) throws ParseException {
        return sdf.format(date);
    }

    public static Date parse(String strDate) throws ParseException {
        return sdf.parse(strDate);
    }

    public static void main(String[] args) throws InterruptedException, ParseException {

        System.out.println(sdf.format(new Date()));

    }
}

是不是感覺沒什麼毛病?單執行緒下自然沒毛病了,都是運用到多執行緒下就有大問題了。
測試下:

public static void main(String[] args) throws InterruptedException, ParseException {

    ExecutorService service = Executors.newFixedThreadPool(100);

    for (int i = 0; i 20; i++) {
        service.execute(() -> {
            for (int j = 0; j 10; j++) {
                try {
                    System.out.println(parse("2018-01-02 09:45:59"));
                } catch (ParseException e) {
                    e.printStackTrace();
                }
            }
        });
    }
    // 等待上述的執行緒執行完
    service.shutdown();
    service.awaitTermination(1, TimeUnit.DAYS);
}

控制台打印結果:


你看這不崩了?部分執行緒獲取的時間不對,部分執行緒直接報java.lang.NumberFormatException: multiple points錯,執行緒直接掛死了。

多執行緒不安全原因

因為我們吧SimpleDateFormat定義為靜態變數,那麼多執行緒下SimpleDateFormat的實體就會被多個執行緒共享,B執行緒會讀取到A執行緒的時間,就會出現時間差異和其它各種問題。SimpleDateFormat和它繼承的DateFormat類也不是執行緒安全的

來看看SimpleDateFormat的format()方法的原始碼

// Called from Format after creating a FieldDelegate
private StringBuffer format(Date date, StringBuffer toAppendTo,
                            FieldDelegate delegate)
 
{
    // Convert input date to time field list
    calendar.setTime(date);

    boolean useDateFormatSymbols = useDateFormatSymbols();

    for (int i = 0; i         int tag = compiledPattern[i] >>> 8;
        int count = compiledPattern[i++] & 0xff;
        if (count == 255) {
            count = compiledPattern[i++] <16;
            count |= compiledPattern[i++];
        }

        switch (tag) {
        case TAG_QUOTE_ASCII_CHAR:
            toAppendTo.append((char)count);
            break;

        case TAG_QUOTE_CHARS:
            toAppendTo.append(compiledPattern, i, count);
            i += count;
            break;

        default:
            subFormat(tag, count, delegate, toAppendTo, useDateFormatSymbols);
            break;
        }
    }
    return toAppendTo;
}

註意calendar.setTime(date);,SimpleDateFormat的format方法實際操作的就是Calendar。

因為我們宣告SimpleDateFormat為static變數,那麼它的Calendar變數也就是一個共享變數,可以被多個執行緒訪問。

假設執行緒A執行完calendar.setTime(date),把時間設置成2019-01-02,這時候被掛起,執行緒B獲得CPU執行權。執行緒B也執行到了calendar.setTime(date),把時間設置為2019-01-03。執行緒掛起,執行緒A繼續走,calendar還會被繼續使用(subFormat方法),而這時calendar用的是執行緒B設置的值了,而這就是引發問題的根源,出現時間不對,執行緒掛死等等。

其實SimpleDateFormat原始碼上作者也給過我們提示:

* Date formats are not synchronized.
* It is recommended to create separate format instances for each thread.
* If multiple threads access a format concurrently, it must be synchronized
* externally.

意思就是

日期格式不同步。
建議為每個執行緒創建單獨的格式實體。
如果多個執行緒同時訪問一種格式,則必須在外部同步該格式。

解決方案

只在需要的時候創建新實體,不用static修飾

public static String formatDate(Date date) throws ParseException {
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    return sdf.format(date);
}

public static Date parse(String strDate) throws ParseException {
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    return sdf.parse(strDate);
}

如上代碼,僅在需要用到的地方創建一個新的實體,就沒有執行緒安全問題,不過也加重了創建物件的負擔,會頻繁地創建和銷毀物件,效率較低。

synchronized大法好

private static final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

public static String formatDate(Date date) throws ParseException {
    synchronized(sdf){
        return sdf.format(date);
    }
}

public static Date parse(String strDate) throws ParseException {
    synchronized(sdf){
        return sdf.parse(strDate);
    }
}

簡單粗暴,synchronized往上一套也可以解決執行緒安全問題,缺點自然就是併發量大的時候會對性能有影響,執行緒阻塞。

ThreadLocal

private static ThreadLocal threadLocal = new ThreadLocal() {
    @Override
    protected DateFormat initialValue() {
        return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    }
};

public static Date parse(String dateStr) throws ParseException {
    return threadLocal.get().parse(dateStr);
}

public static String format(Date date) {
    return threadLocal.get().format(date);
}

ThreadLocal可以確保每個執行緒都可以得到單獨的一個SimpleDateFormat的物件,那麼自然也就不存在競爭問題了。

基於JDK1.8的DateTimeFormatter

也是《阿裡巴巴開發手冊》給我們的解決方案,對之前的代碼進行改造:

public class SimpleDateFormatTest {

    private static final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

    public static String formatDate2(LocalDateTime date) {
        return formatter.format(date);
    }

    public static LocalDateTime parse2(String dateNow) {
        return LocalDateTime.parse(dateNow, formatter);
    }

    public static void main(String[] args) throws InterruptedException, ParseException {

        ExecutorService service = Executors.newFixedThreadPool(100);

        // 20個執行緒
        for (int i = 0; i 20; i++) {
            service.execute(() -> {
                for (int j = 0; j 10; j++) {
                    try {
                        System.out.println(parse2(formatDate2(LocalDateTime.now())));
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            });
        }
        // 等待上述的執行緒執行完
        service.shutdown();
        service.awaitTermination(1, TimeUnit.DAYS);


    }
}

運行結果就不貼了,不會出現報錯和時間不准確的問題。

DateTimeFormatter原始碼上作者也加註釋說明瞭,他的類是不可變的,並且是執行緒安全的。

* This class is immutable and thread-safe.

ok,現在是不是可以對你專案里的日期工具類進行一波優化了呢?

赞(0)

分享創造快樂