SimpleDateFormat執行緒不安全了?這裡有5種解決方案

語言: CN / TW / HK
摘要:我們知道SimpleDateFormat是執行緒不安全,本文會介紹多種解決方案來保證執行緒安全。

本文分享自華為雲社群《java的SimpleDateFormat執行緒不安全出問題了,虛竹教你多種解決方案》,作者:小虛竹 。

場景

在java8以前,要格式化日期時間,就需要用到SimpleDateFormat

但我們知道SimpleDateFormat是執行緒不安全的,處理時要特別小心,要加鎖或者不能定義為static,要在方法內new出物件,再進行格式化。很麻煩,而且重複地new出物件,也加大了記憶體開銷。

SimpleDateFormat執行緒為什麼是執行緒不安全的呢?

來看看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);
		...
    }

問題就出在成員變數calendar,如果在使用SimpleDateFormat時,用static定義,那SimpleDateFormat變成了共享變數。那SimpleDateFormat中的calendar就可以被多個執行緒訪問到。

SimpleDateFormat的parse方法也是執行緒不安全的:

 public Date parse(String text, ParsePosition pos)
    {
     ...
         Date parsedDate;
        try {
            parsedDate = calb.establish(calendar).getTime();
            // If the year value is ambiguous,
            // then the two-digit year == the default start year
            if (ambiguousYear[0]) {
                if (parsedDate.before(defaultCenturyStart)) {
                    parsedDate = calb.addYear(100).establish(calendar).getTime();
                }
            }
        }
        // An IllegalArgumentException will be thrown by Calendar.getTime()
        // if any fields are out of range, e.g., MONTH == 17.
        catch (IllegalArgumentException e) {
            pos.errorIndex = start;
            pos.index = oldStart;
            return null;
        }

        return parsedDate;  
 }

由原始碼可知,最後是呼叫**parsedDate = calb.establish(calendar).getTime();**獲取返回值。方法的引數是calendar,calendar可以被多個執行緒訪問到,存線上程不安全問題。

我們再來看看**calb.establish(calendar)**的原始碼

calb.establish(calendar)方法先後呼叫了cal.clear()和cal.set(),先清理值,再設值。但是這兩個操作並不是原子性的,也沒有執行緒安全機制來保證,導致多執行緒併發時,可能會引起cal的值出現問題了。

驗證SimpleDateFormat執行緒不安全

public class SimpleDateFormatDemoTest {

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

    public static void main(String[] args) {
    		//1、建立執行緒池
        ExecutorService pool = Executors.newFixedThreadPool(5);
        //2、為執行緒池分配任務
        ThreadPoolTest threadPoolTest = new ThreadPoolTest();
        for (int i = 0; i < 10; i++) {
            pool.submit(threadPoolTest);
        }
        //3、關閉執行緒池
        pool.shutdown();
    }
    static class  ThreadPoolTest implements Runnable{

        @Override
        public void run() {
				String dateString = simpleDateFormat.format(new Date());
				try {
					Date parseDate = simpleDateFormat.parse(dateString);
					String dateString2 = simpleDateFormat.format(parseDate);
					System.out.println(Thread.currentThread().getName()+" 執行緒是否安全: "+dateString.equals(dateString2));
				} catch (Exception e) {
					System.out.println(Thread.currentThread().getName()+" 格式化失敗 ");
				}
        }
    }
}

出現了兩次false,說明執行緒是不安全的。而且還拋異常,這個就嚴重了。

解決方案

解決方案1:不要定義為static變數,使用區域性變數

就是要使用SimpleDateFormat物件進行format或parse時,再定義為區域性變數。就能保證執行緒安全。

public class SimpleDateFormatDemoTest1 {

    public static void main(String[] args) {
    		//1、建立執行緒池
        ExecutorService pool = Executors.newFixedThreadPool(5);
        //2、為執行緒池分配任務
        ThreadPoolTest threadPoolTest = new ThreadPoolTest();
        for (int i = 0; i < 10; i++) {
            pool.submit(threadPoolTest);
        }
        //3、關閉執行緒池
        pool.shutdown();
    }
    static class  ThreadPoolTest implements Runnable{

		@Override
		public void run() {
			SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
			String dateString = simpleDateFormat.format(new Date());
			try {
				Date parseDate = simpleDateFormat.parse(dateString);
				String dateString2 = simpleDateFormat.format(parseDate);
				System.out.println(Thread.currentThread().getName()+" 執行緒是否安全: "+dateString.equals(dateString2));
			} catch (Exception e) {
				System.out.println(Thread.currentThread().getName()+" 格式化失敗 ");
			}
		}
    }
}

由圖可知,已經保證了執行緒安全,但這種方案不建議在高併發場景下使用,因為會建立大量的SimpleDateFormat物件,影響效能。

解決方案2:加鎖:synchronized鎖和Lock鎖

加synchronized鎖

SimpleDateFormat物件還是定義為全域性變數,然後需要呼叫SimpleDateFormat進行格式化時間時,再用synchronized保證執行緒安全。

public class SimpleDateFormatDemoTest2 {

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

    public static void main(String[] args) {
    		//1、建立執行緒池
        ExecutorService pool = Executors.newFixedThreadPool(5);
        //2、為執行緒池分配任務
        ThreadPoolTest threadPoolTest = new ThreadPoolTest();
        for (int i = 0; i < 10; i++) {
            pool.submit(threadPoolTest);
        }
        //3、關閉執行緒池
        pool.shutdown();
    }

    static class  ThreadPoolTest implements Runnable{

		@Override
		public void run() {
			try {
				synchronized (simpleDateFormat){
					String dateString = simpleDateFormat.format(new Date());
					Date parseDate = simpleDateFormat.parse(dateString);
					String dateString2 = simpleDateFormat.format(parseDate);
					System.out.println(Thread.currentThread().getName()+" 執行緒是否安全: "+dateString.equals(dateString2));
				}
			} catch (Exception e) {
				System.out.println(Thread.currentThread().getName()+" 格式化失敗 ");
			}
		}
    }
}

如圖所示,執行緒是安全的。定義了全域性變數SimpleDateFormat,減少了建立大量SimpleDateFormat物件的損耗。但是使用synchronized鎖,
同一時刻只有一個執行緒能執行鎖住的程式碼塊,在高併發的情況下會影響效能。但這種方案不建議在高併發場景下使用

加Lock鎖

加Lock鎖和synchronized鎖原理是一樣的,都是使用鎖機制保證執行緒的安全。

public class SimpleDateFormatDemoTest3 {

	private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
	private static Lock lock = new ReentrantLock();
    public static void main(String[] args) {
    		//1、建立執行緒池
        ExecutorService pool = Executors.newFixedThreadPool(5);
        //2、為執行緒池分配任務
        ThreadPoolTest threadPoolTest = new ThreadPoolTest();
        for (int i = 0; i < 10; i++) {
            pool.submit(threadPoolTest);
        }
        //3、關閉執行緒池
        pool.shutdown();
    }

    static class  ThreadPoolTest implements Runnable{

		@Override
		public void run() {
			try {
				lock.lock();
					String dateString = simpleDateFormat.format(new Date());
					Date parseDate = simpleDateFormat.parse(dateString);
					String dateString2 = simpleDateFormat.format(parseDate);
					System.out.println(Thread.currentThread().getName()+" 執行緒是否安全: "+dateString.equals(dateString2));
			} catch (Exception e) {
				System.out.println(Thread.currentThread().getName()+" 格式化失敗 ");
			}finally {
				lock.unlock();
			}
		}
    }
}

由結果可知,加Lock鎖也能保證執行緒安全。要注意的是,最後一定要釋放鎖,程式碼裡在finally裡增加了lock.unlock();,保證釋放鎖。

在高併發的情況下會影響效能。這種方案不建議在高併發場景下使用

解決方案3:使用ThreadLocal方式

使用ThreadLocal保證每一個執行緒有SimpleDateFormat物件副本。這樣就能保證執行緒的安全。

public class SimpleDateFormatDemoTest4 {

	private static ThreadLocal<DateFormat> threadLocal = new ThreadLocal<DateFormat>(){
		@Override
		protected DateFormat initialValue() {
			return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
		}
	};
    public static void main(String[] args) {
    		//1、建立執行緒池
        ExecutorService pool = Executors.newFixedThreadPool(5);
        //2、為執行緒池分配任務
        ThreadPoolTest threadPoolTest = new ThreadPoolTest();
        for (int i = 0; i < 10; i++) {
            pool.submit(threadPoolTest);
        }
        //3、關閉執行緒池
        pool.shutdown();
    }

    static class  ThreadPoolTest implements Runnable{

		@Override
		public void run() {
			try {
					String dateString = threadLocal.get().format(new Date());
					Date parseDate = threadLocal.get().parse(dateString);
					String dateString2 = threadLocal.get().format(parseDate);
					System.out.println(Thread.currentThread().getName()+" 執行緒是否安全: "+dateString.equals(dateString2));
			} catch (Exception e) {
				System.out.println(Thread.currentThread().getName()+" 格式化失敗 ");
			}finally {
				//避免記憶體洩漏,使用完threadLocal後要呼叫remove方法清除資料
				threadLocal.remove();
			}
		}
    }
}

使用ThreadLocal能保證執行緒安全,且效率也是挺高的。適合高併發場景使用

解決方案4:使用DateTimeFormatter代替SimpleDateFormat

使用DateTimeFormatter代替SimpleDateFormat(DateTimeFormatter是執行緒安全的,java 8+支援)

DateTimeFormatter介紹 傳送門:萬字博文教你搞懂java原始碼的日期和時間相關用法

public class DateTimeFormatterDemoTest5 {
	private static DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

	public static void main(String[] args) {
		//1、建立執行緒池
		ExecutorService pool = Executors.newFixedThreadPool(5);
		//2、為執行緒池分配任務
		ThreadPoolTest threadPoolTest = new ThreadPoolTest();
		for (int i = 0; i < 10; i++) {
			pool.submit(threadPoolTest);
		}
		//3、關閉執行緒池
		pool.shutdown();
	}
	static class  ThreadPoolTest implements Runnable{

		@Override
		public void run() {
			try {
				String dateString = dateTimeFormatter.format(LocalDateTime.now());
				TemporalAccessor temporalAccessor = dateTimeFormatter.parse(dateString);
				String dateString2 = dateTimeFormatter.format(temporalAccessor);
				System.out.println(Thread.currentThread().getName()+" 執行緒是否安全: "+dateString.equals(dateString2));
			} catch (Exception e) {
				e.printStackTrace();
				System.out.println(Thread.currentThread().getName()+" 格式化失敗 ");
			}
		}
	}
}

使用DateTimeFormatter能保證執行緒安全,且效率也是挺高的。適合高併發場景使用

解決方案5:使用FastDateFormat 替換SimpleDateFormat

使用FastDateFormat 替換SimpleDateFormat(FastDateFormat 是執行緒安全的,Apache Commons Lang包支援,不受限於java版本)

public class FastDateFormatDemo6 {
	private static FastDateFormat fastDateFormat = FastDateFormat.getInstance("yyyy-MM-dd HH:mm:ss");

	public static void main(String[] args) {
		//1、建立執行緒池
		ExecutorService pool = Executors.newFixedThreadPool(5);
		//2、為執行緒池分配任務
		ThreadPoolTest threadPoolTest = new ThreadPoolTest();
		for (int i = 0; i < 10; i++) {
			pool.submit(threadPoolTest);
		}
		//3、關閉執行緒池
		pool.shutdown();
	}
	static class  ThreadPoolTest implements Runnable{

		@Override
		public void run() {
			try {
				String dateString = fastDateFormat.format(new Date());
				Date parseDate =  fastDateFormat.parse(dateString);
				String dateString2 = fastDateFormat.format(parseDate);
				System.out.println(Thread.currentThread().getName()+" 執行緒是否安全: "+dateString.equals(dateString2));
			} catch (Exception e) {
				e.printStackTrace();
				System.out.println(Thread.currentThread().getName()+" 格式化失敗 ");
			}
		}
	}
}

使用FastDateFormat能保證執行緒安全,且效率也是挺高的。適合高併發場景使用

FastDateFormat原始碼分析

 Apache Commons Lang 3.5
//FastDateFormat
@Override
public String format(final Date date) {
   return printer.format(date);
}

	@Override
	public String format(final Date date) {
		final Calendar c = Calendar.getInstance(timeZone, locale);
		c.setTime(date);
		return applyRulesToString(c);
	}

原始碼中 Calender 是在 format 方法裡建立的,肯定不會出現 setTime 的執行緒安全問題。這樣執行緒安全疑惑解決了。那還有效能問題要考慮?

我們來看下FastDateFormat是怎麼獲取的

FastDateFormat.getInstance();
FastDateFormat.getInstance(CHINESE_DATE_TIME_PATTERN);

看下對應的原始碼

/**
 * 獲得 FastDateFormat例項,使用預設格式和地區
 *
 * @return FastDateFormat
 */
public static FastDateFormat getInstance() {
   return CACHE.getInstance();
}

/**
 * 獲得 FastDateFormat 例項,使用預設地區<br>
 * 支援快取
 *
 * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式
 * @return FastDateFormat
 * @throws IllegalArgumentException 日期格式問題
 */
public static FastDateFormat getInstance(final String pattern) {
   return CACHE.getInstance(pattern, null, null);
}

這裡有用到一個CACHE,看來用了快取,往下看

private static final FormatCache<FastDateFormat> CACHE = new FormatCache<FastDateFormat>(){
   @Override
   protected FastDateFormat createInstance(final String pattern, final TimeZone timeZone, final Locale locale) {
      return new FastDateFormat(pattern, timeZone, locale);
   }
};

//
abstract class FormatCache<F extends Format> {
    ...
    private final ConcurrentMap<Tuple, F> cInstanceCache = new ConcurrentHashMap<>(7);

	private static final ConcurrentMap<Tuple, String> C_DATE_TIME_INSTANCE_CACHE = new ConcurrentHashMap<>(7);
    ...
}

在getInstance 方法中加了ConcurrentMap 做快取,提高了效能。且我們知道ConcurrentMap 也是執行緒安全的。

實踐

/**
 * 年月格式 {@link FastDateFormat}:yyyy-MM
 */
public static final FastDateFormat NORM_MONTH_FORMAT = FastDateFormat.getInstance(NORM_MONTH_PATTERN);

//FastDateFormat
public static FastDateFormat getInstance(final String pattern) {
   return CACHE.getInstance(pattern, null, null);
}

如圖可證,是使用了ConcurrentMap 做快取。且key值是格式,時區和locale(語境)三者都相同為相同的key。

結論

1、不要定義為static變數,使用區域性變數

2、加鎖:synchronized鎖和Lock鎖

3、使用ThreadLocal方式

4、使用DateTimeFormatter代替SimpleDateFormat(DateTimeFormatter是執行緒安全的,java 8+支援)

5、使用FastDateFormat 替換SimpleDateFormat(FastDateFormat 是執行緒安全的,Apache Commons Lang包支援,java8之前推薦此用法)

 

點選關注,第一時間瞭解華為雲新鮮技術~