还在用 SimpleDateFormat 做时间格式化？小心项目崩掉

左手的ㄟ右手 2023-10-01 22:20 92阅读 0赞

  • SimpleDateFormat.parse() 方法的线程安全问题

    • 错误示例
    • 非线程安全原因分析
    • 解决方法

  • SimpleDateFormat.format() 方法的线程安全问题

    • 错误示例
    • 非线程安全原因分析
    • 解决方法

SimpleDateFormat在多线程环境下存在线程安全问题。

1 SimpleDateFormat.parse() 方法的线程安全问题

1.1 错误示例

错误使用SimpleDateFormat.parse()的代码如下:

  1. import java.text.SimpleDateFormat;
  3. public class SimpleDateFormatTest {
  4.     private static final SimpleDateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  6.     public static void main(String[] args) {
  8.         /**
  9.          * SimpleDateFormat线程不安全，没有保证线程安全(没有加锁)的情况下，禁止使用全局SimpleDateFormat,否则报错 NumberFormatException
  10.          *
  11.          * private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  12.          */
  13.         for (int i = 0; i < 20; ++i) {
  14.             Thread thread = new Thread(() -> {
  15.                 try {
  16.                     // 错误写法会导致线程安全问题
  17.                     System.out.println(Thread.currentThread().getName() + "--" + SIMPLE_DATE_FORMAT.parse("2020-06-01 11:35:00"));
  18.                 } catch (Exception e) {
  19.                     e.printStackTrace();
  20.                 }
  21.             }, "Thread-" + i);
  22.             thread.start();
  23.         }
  24.     }
  25. }

报错：

7580292e0d949e1b49e5ad77be843fc9.png

1.2 非线程安全原因分析

查看源码中可以看到：SimpleDateFormat继承DateFormat类，SimpleDateFormat转换日期是通过继承自DateFormat类的Calendar对象来操作的，Calendar对象会被用来进行日期-时间计算，既被用于format方法也被用于parse方法。

88f72d69da5542eab470072171a32dd4.png

SimpleDateFormat 的 parse(String source) 方法 会调用继承自父类的 DateFormat 的 parse(String source) 方法

d930eb7c2866e59adf9116bcb4a7e511.png

DateFormat 的 parse(String source) 方法会调用SimpleDateFormat中重写的 parse(String text, ParsePosition pos) 方法，该方法中有个地方需要关注

a0f518b1225181eca1b0ff8815316bdd.png

SimpleDateFormat 中重写的 parse(String text, ParsePosition pos) 方法中调用了 establish(calendar) 这个方法：

714b1236940b011ff881cc1823df4724.png

该方法中调用了 Calendar 的 clear() 方法

cf54b908cf9b59281535031cce27967e.png

可以发现整个过程中Calendar对象它并不是线程安全的，如果，a线程将calendar清空了，calendar 就没有新值了，恰好此时b线程刚好进入到parse方法用到了calendar对象，那就会产生线程安全问题了！

正常情况下：

4630bdc4a445354726a2f3b4fc52bd7e.png

非线程安全的流程：

d4767cf7b94fdd83ccf417d600b2e6ce.png

1.3 解决方法

方法1：每个线程都new一个SimpleDateFormat

  1. import java.text.SimpleDateFormat;
  3. public class SimpleDateFormatTest {
  5.     public static void main(String[] args) {
  6.         for (int i = 0; i < 20; ++i) {
  7.             Thread thread = new Thread(() -> {
  8.                 try {
  9.                     // 每个线程都new一个
  10.                     SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  11.                     System.out.println(Thread.currentThread().getName() + "--" + simpleDateFormat.parse("2020-06-01 11:35:00"));
  12.                 } catch (Exception e) {
  13.                     e.printStackTrace();
  14.                 }
  15.             }, "Thread-" + i);
  16.             thread.start();
  17.         }
  18.     }
  19. }

方式2：synchronized等方式加锁

  1. public class SimpleDateFormatTest {
  2.     private static final SimpleDateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  4.     public static void main(String[] args) {
  6.         for (int i = 0; i < 20; ++i) {
  7.             Thread thread = new Thread(() -> {
  8.                 try {
  9.                     synchronized (SIMPLE_DATE_FORMAT) {
  10.                         System.out.println(Thread.currentThread().getName() + "--" + SIMPLE_DATE_FORMAT.parse("2020-06-01 11:35:00"));
  11.                     }
  12.                 } catch (Exception e) {
  13.                     e.printStackTrace();
  14.                 }
  15.             }, "Thread-" + i);
  16.             thread.start();
  17.         }
  18.     }
  19. }

方式3：使用ThreadLocal 为每个线程创建一个独立变量

  1. import java.text.DateFormat;
  2. import java.text.SimpleDateFormat;
  4. public class SimpleDateFormatTest {
  6.     private static final ThreadLocal<DateFormat> SAFE_SIMPLE_DATE_FORMAT = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
  8.     public static void main(String[] args) {
  10.         for (int i = 0; i < 20; ++i) {
  11.             Thread thread = new Thread(() -> {
  12.                 try {
  13.                         System.out.println(Thread.currentThread().getName() + "--" + SAFE_SIMPLE_DATE_FORMAT.get().parse("2020-06-01 11:35:00"));
  14.                 } catch (Exception e) {
  15.                     e.printStackTrace();
  16.                 }
  17.             }, "Thread-" + i);
  18.             thread.start();
  19.         }
  20.     }
  21. }

ThreadLocal的详细使用细节见：

https://blog.csdn.net/QiuHaoqian/article/details/117077792

2 SimpleDateFormat.format() 方法的线程安全问题

2.1 错误示例

  1. import java.text.SimpleDateFormat;
  2. import java.util.Date;
  3. import java.util.concurrent.LinkedBlockingQueue;
  4. import java.util.concurrent.ThreadPoolExecutor;
  5. import java.util.concurrent.TimeUnit;
  7. public class SimpleDateFormatTest {
  8.     // 时间格式化对象
  9.     private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("mm:ss");
  11.     public static void main(String[] args) throws InterruptedException {
  12.         // 创建线程池执行任务
  13.         ThreadPoolExecutor threadPool = new ThreadPoolExecutor(
  14.                 10, 10, 60, TimeUnit.SECONDS, new LinkedBlockingQueue<>(1000));
  16.         for (int i = 0; i < 1000; i++) {
  17.             int finalI = i;
  18.             // 执行任务
  19.             threadPool.execute(new Runnable() {
  20.                 @Override
  21.                 public void run() {
  22.                     Date date = new Date(finalI * 1000); // 得到时间对象
  23.                     formatAndPrint(date); // 执行时间格式化
  24.                 }
  25.             });
  26.         }
  27.         threadPool.shutdown(); // 线程池执行完任务之后关闭
  28.     }
  30.     /**
  31.      * 格式化并打印时间
  32.      */
  33.     private static void formatAndPrint(Date date) {
  34.         String result = simpleDateFormat.format(date); // 执行格式化
  35.         System.out.println("时间：" + result); // 打印最终结果
  36.     }
  37. }

5fcb1130cfcca35beb0f36b491cb5b1a.png

从上述结果可以看出，程序的打印结果竟然是有重复内容的，正确的情况应该是没有重复的时间才对。

2.2 非线程安全原因分析

为了找到问题所在，查看原因 SimpleDateFormat 中 format 方法的源码来排查一下问题，format 源码如下：

4491e3132e72f744832232d9ef4c936b.png

从上述源码可以看出，在执行任务 SimpleDateFormat.format() 方法时，会使用 calendar.setTime() 方法将输入的时间进行转换，那么我们想象一下这样的场景：

  • 线程 1 执行了 calendar.setTime(date) 方法，将用户输入的时间转换成了后面格式化时所需要的时间；
  • 线程 1 暂停执行，线程 2 得到 CPU 时间片开始执行；
  • 线程 2 执行了 calendar.setTime(date) 方法，对时间进行了修改；
  • 线程 2 暂停执行，线程 1 得出 CPU 时间的继续执行，因为线程 1 和线程 2 使用的是同一对象，而时间已经被线程 2 修改了，所以此时当前线程 1 继续执行的时候就会出现线程安全的问题了。

正常的情况下，程序的执行是这样的：

5b218d5f3a2bfd6499263aa7a988ddd7.png

非线程安全的执行流程是这样的：

e3940d2ed1061d27277931ea6134f596.png

2.3 解决方法

同样有三种解决方法

方法1：每个线程都new一个SimpleDateFormat

  1. public class SimpleDateFormatTest {
  3.     public static void main(String[] args) throws InterruptedException {
  4.         // 创建线程池执行任务
  5.         ThreadPoolExecutor threadPool = new ThreadPoolExecutor(
  6.                 10, 10, 60, TimeUnit.SECONDS, new LinkedBlockingQueue<>(1000));
  8.         for (int i = 0; i < 1000; i++) {
  9.             int finalI = i;
  10.             // 执行任务
  11.             threadPool.execute(new Runnable() {
  12.                 @Override
  13.                 public void run() {
  14.                     // 得到时间对象
  15.                     Date date = new Date(finalI * 1000);
  16.                     // 执行时间格式化
  17.                     formatAndPrint(date);
  18.                 }
  19.             });
  20.         }
  21.         // 线程池执行完任务之后关闭
  22.         threadPool.shutdown();
  23.     }
  25.     /**
  26.      * 格式化并打印时间
  27.      */
  28.     private static void formatAndPrint(Date date) {
  29.         String result = new SimpleDateFormat("mm:ss").format(date); // 执行格式化
  30.         System.out.println("时间：" + result); // 打印最终结果
  31.     }
  32. }

方式2：synchronized等方式加锁

所有的线程必须排队执行某些业务才行，这样无形中就降低了程序的运行效率了

  1. public class SimpleDateFormatTest {
  2.     // 时间格式化对象
  3.     private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("mm:ss");
  5.     public static void main(String[] args) throws InterruptedException {
  6.         // 创建线程池执行任务
  7.         ThreadPoolExecutor threadPool = new ThreadPoolExecutor(
  8.                 10, 10, 60, TimeUnit.SECONDS, new LinkedBlockingQueue<>(1000));
  10.         for (int i = 0; i < 1000; i++) {
  11.             int finalI = i;
  12.             // 执行任务
  13.             threadPool.execute(new Runnable() {
  14.                 @Override
  15.                 public void run() {
  16.                     Date date = new Date(finalI * 1000); // 得到时间对象
  17.                     formatAndPrint(date); // 执行时间格式化
  18.                 }
  19.             });
  20.         }
  21.         // 线程池执行完任务之后关闭
  22.         threadPool.shutdown();
  23.     }
  25.     /**
  26.      * 格式化并打印时间
  27.      */
  28.     private static void formatAndPrint(Date date) {
  29.         // 执行格式化
  30.         String result = null;
  31.         // 加锁
  32.         synchronized (SimpleDateFormatTest.class) {
  33.             result = simpleDateFormat.format(date);
  34.         }
  35.         // 打印最终结果
  36.         System.out.println("时间：" + result);
  37.     }
  38. }

方式3：使用ThreadLocal 为每个线程创建一个独立变量

  1. public class SimpleDateFormatTest {
  2.     // 创建 ThreadLocal 并设置默认值
  3.     private static ThreadLocal<SimpleDateFormat> dateFormatThreadLocal =
  4.             ThreadLocal.withInitial(() -> new SimpleDateFormat("mm:ss"));
  6.     public static void main(String[] args) {
  7.         // 创建线程池执行任务
  8.         ThreadPoolExecutor threadPool = new ThreadPoolExecutor(10, 10, 60,
  9.                 TimeUnit.SECONDS, new LinkedBlockingQueue<>(1000));
  10.         // 执行任务
  11.         for (int i = 0; i < 1000; i++) {
  12.             int finalI = i;
  13.             // 执行任务
  14.             threadPool.execute(() -> {
  15.                 Date date = new Date(finalI * 1000); // 得到时间对象
  16.                 formatAndPrint(date); // 执行时间格式化
  17.             });
  18.         }
  19.         threadPool.shutdown(); // 线程池执行完任务之后关闭
  20.     }
  22.     /**
  23.      * 格式化并打印时间
  24.      */
  25.     private static void formatAndPrint(Date date) {
  26.         String result = dateFormatThreadLocal.get().format(date); // 执行格式化
  27.         System.out.println("时间：" + result);  // 打印最终结果
  28.     }
  29. }

ba025446a242446598a4a9b55e253fcb.jpeg

发表评论

表情：
评论列表 （有 0 条评论，92人围观）

还没有评论，来说两句吧...

相关阅读