SimpleDateFormat的線程安全問題與解決方案

時間 2019-11-22

標籤 simpledateformat 線程安全問題解決方案简体版

原文原文鏈接

1. 緣由java

SimpleDateFormat(下面簡稱sdf)類內部有一個Calendar對象引用,它用來儲存和這個sdf相關的日期信息,例如sdf.parse(dateStr), sdf.format(date) 諸如此類的方法參數傳入的日期相關String, Date等等, 都是交友Calendar引用來儲存的.這樣就會致使一個問題,若是你的sdf是個static的, 那麼多個thread 之間就會共享這個sdf, 同時也是共享這個Calendar引用, 而且, 觀察 sdf.parse() 方法,你會發現有以下的調用:安全

Date parse() {

  calendar.clear(); // 清理calendar

  ... // 執行一些操做, 設置 calendar 的日期什麼的

  calendar.getTime(); // 獲取calendar的時間

}

這裏會致使的問題就是, 若是線程A 調用了 sdf.parse(), 而且進行了 calendar.clear()後還未執行calendar.getTime()的時候,線程B又調用了sdf.parse(), 這時候線程B也執行了sdf.clear()方法, 這樣就致使線程A的的calendar數據被清空了(實際上A,B的同時被清空了). 又或者當 A 執行了calendar.clear() 後被掛起, 這時候B 開始調用sdf.parse()並順利i結束, 這樣 A 的 calendar內存儲的的date 變成了後來B設置的calendar的date多線程

2. 問題重現併發

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

/**
 * @author zhenwei.liu created on 2013 13-8-29 下午5:35
 * @version $Id$
 */
public class DateFormatTest extends Thread {
    private static SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");

    private String name;
    private String dateStr;
    private boolean sleep;

    public DateFormatTest(String name, String dateStr, boolean sleep) {
        this.name = name;
        this.dateStr = dateStr;
        this.sleep = sleep;
    }

    @Override
    public void run() {

        Date date = null;

        if (sleep) {
            try {
                TimeUnit.MILLISECONDS.sleep(2000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }

        try {
            date = sdf.parse(dateStr);
        } catch (ParseException e) {
            e.printStackTrace();
        }

        System.out.println(name + " : date: " + date);
    }

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

        ExecutorService executor = Executors.newCachedThreadPool();

        // A 會sleep 2s 後開始執行sdf.parse()
        executor.execute(new DateFormatTest("A", "1991-09-13", true));
        // B 打了斷點,會卡在方法中間
        executor.execute(new DateFormatTest("B", "2013-09-13", false));

        executor.shutdown();
    }
}

使用Debug模式執行這段代碼,並在sdf.parse()方法裏打上斷點ide

parse() {

    calendar.clear()

    // 這裏打一個斷點

    calendar.getTime()

}

過程:函數

1) 首先A線程跑起來之後會進入sleep高併發

2) B線程跑起來, 卡在斷點處測試

3) A線程醒過來, 執行 calendar.clear(), 並將設置sdf.calendar的date爲1991-09-13, 此時 A B 的 calendar 都爲 1991-09-13網站

4) 讓斷點繼續執行, 輸出以下this

A : date: Fri Sep 13 00:00:00 CDT 1991
B : date: Fri Sep 13 00:00:00 CDT 1991

這並非咱們期待的結果

3. 解決方案

最簡單的解決方案咱們能夠把static去掉,這樣每一個新的線程都會有一個本身的sdf實例,從而避免線程安全的問題

然而,使用這種方法,在高併發的狀況下會大量的new sdf以及銷燬sdf,這樣是很是耗費資源的

在併發狀況下,網站的請求任務與線程執行狀況大概能夠理解爲以下

例如Tomcat的線程池的最大Thread數爲4, 如今須要執行的任務有1000個(理解爲有1000個用戶點了你的網站的某個功能),

而這1000個任務都會用到咱們寫的日期函數處理類

A) 假如說日期函數處理類使用的是new SimpleDateFormat的方法,那麼這裏就會有1000次sdf的建立和銷燬

B) Java中提供了一種ThreadLocal的解決方案,它的工做方式是,每一個線程只會有一個實例,也就是說咱們執行完這1000個任務,總共只會實例化4個sdf.

並且,它並不會有多線程的併發問題,由於,單個線程執行任務確定是順序的,例如Thread #1負責執行Task #1-#250, 那麼他是順序而執行Task #1-#250

而Thread #2擁有本身的sdf實例,他也是順序執行任務 Task #251-#500, 以此類推

下面是一個使用ThreadLocal解決sdf多線程問題的例子

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

/**
 * @author zhenwei.liu created on 2013 13-8-29 下午5:35
 * @version $Id$
 */
public class DateUtil {

    /** 鎖對象 */
    private static final Object lockObj = new Object();

    /** 存放不一樣的日期模板格式的sdf的Map */
    private static Map<String, ThreadLocal<SimpleDateFormat>> sdfMap = new HashMap<String, ThreadLocal<SimpleDateFormat>>();

    /**
     * 返回一個ThreadLocal的sdf,每一個線程只會new一次sdf
     * 
     * @param pattern
     * @return
     */
    private static SimpleDateFormat getSdf(final String pattern) {
        ThreadLocal<SimpleDateFormat> tl = sdfMap.get(pattern);

        // 此處的雙重判斷和同步是爲了防止sdfMap這個單例被屢次put重複的sdf
        if (tl == null) {
            synchronized (lockObj) {
                tl = sdfMap.get(pattern);
                if (tl == null) {
                    // 只有Map中尚未這個pattern的sdf纔會生成新的sdf並放入map
                    System.out.println("put new sdf of pattern " + pattern + " to map");

                    // 這裏是關鍵,使用ThreadLocal<SimpleDateFormat>替代原來直接new SimpleDateFormat
                    tl = new ThreadLocal<SimpleDateFormat>() {

                        @Override
                        protected SimpleDateFormat initialValue() {
                            System.out.println("thread: " + Thread.currentThread() + " init pattern: " + pattern);
                            return new SimpleDateFormat(pattern);
                        }
                    };
                    sdfMap.put(pattern, tl);
                }
            }
        }

        return tl.get();
    }

    /**
     * 是用ThreadLocal<SimpleDateFormat>來獲取SimpleDateFormat,這樣每一個線程只會有一個SimpleDateFormat
     * 
     * @param date
     * @param pattern
     * @return
     */
    public static String format(Date date, String pattern) {
        return getSdf(pattern).format(date);
    }

    public static Date parse(String dateStr, String pattern) throws ParseException {
        return getSdf(pattern).parse(dateStr);
    }

}

測試類

import java.text.ParseException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

/**
 * @author zhenyu.nie created on 2013 13-8-26 下午2:13
 * @version 1.0.0
 */
public class Test {

    public static void main(String[] args) {
        final String patten1 = "yyyy-MM-dd";
        final String patten2 = "yyyy-MM";

        Thread t1 = new Thread() {

            @Override
            public void run() {
                try {
                    DateUtil.parse("1992-09-13", patten1);
                } catch (ParseException e) {
                    e.printStackTrace();
                }
            }
        };

        Thread t2 = new Thread() {

            @Override
            public void run() {
                try {
                    DateUtil.parse("2000-09", patten2);
                } catch (ParseException e) {
                    e.printStackTrace();
                }
            }
        };

        Thread t3 = new Thread() {

            @Override
            public void run() {
                try {
                    DateUtil.parse("1992-09-13", patten1);
                } catch (ParseException e) {
                    e.printStackTrace();
                }
            }
        };

        Thread t4 = new Thread() {

            @Override
            public void run() {
                try {
                    DateUtil.parse("2000-09", patten2);
                } catch (ParseException e) {
                    e.printStackTrace();
                }
            }
        };

        Thread t5 = new Thread() {

            @Override
            public void run() {
                try {
                    DateUtil.parse("2000-09-13", patten1);
                } catch (ParseException e) {
                    e.printStackTrace();
                }
            }
        };

        Thread t6 = new Thread() {

            @Override
            public void run() {
                try {
                    DateUtil.parse("2000-09", patten2);
                } catch (ParseException e) {
                    e.printStackTrace();
                }
            }
        };

        System.out.println("單線程執行: ");
        ExecutorService exec = Executors.newFixedThreadPool(1);
        exec.execute(t1);
        exec.execute(t2);
        exec.execute(t3);
        exec.execute(t4);
        exec.execute(t5);
        exec.execute(t6);
        exec.shutdown();

        sleep(1000);

        System.out.println("雙線程執行: ");
        ExecutorService exec2 = Executors.newFixedThreadPool(2);
        exec2.execute(t1);
        exec2.execute(t2);
        exec2.execute(t3);
        exec2.execute(t4);
        exec2.execute(t5);
        exec2.execute(t6);
        exec2.shutdown();
    }

    private static void sleep(long millSec) {
        try {
            TimeUnit.MILLISECONDS.sleep(millSec);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

輸出

單線程執行:
put new sdf of pattern yyyy-MM-dd to map
thread: Thread[pool-1-thread-1,5,main] init pattern: yyyy-MM-dd
put new sdf of pattern yyyy-MM to map
thread: Thread[pool-1-thread-1,5,main] init pattern: yyyy-MM
雙線程執行:
thread: Thread[pool-2-thread-1,5,main] init pattern: yyyy-MM-dd
thread: Thread[pool-2-thread-2,5,main] init pattern: yyyy-MM
thread: Thread[pool-2-thread-1,5,main] init pattern: yyyy-MM
thread: Thread[pool-2-thread-2,5,main] init pattern: yyyy-MM-dd

從輸出咱們能夠看出:

1) 1個線程執行這6個任務的時候,這個線程首次使用過的時候會new一個新的sdf,而且之後都一直用這個sdf,而不是每次處理任務都新建一個新的sdf

2) 2個線程執行6個任務的時候也是同理,可是2個線程的sdf是分開的,每一個線程都有本身的"yyyy-MM-dd", "yyyy-MM"的sdf,因此他們不會有線程安全安全問題

試想,若是使用的是new的實現方法,那麼無論是用1個線程去執行,仍是用2個線程去執行這6個任務,都須要new 6個sdf