为何阿里巴巴禁止把SimpleDateFormat定义为static类型的？

为何阿里巴巴禁止把SimpleDateFormat定义为static类型的？

https://mp.weixin.qq.com/s/2uzr800WYtu4R0hycfGruA

Hollis java思惟导图 今天

转自公众号：Hollis

在平常开发中，咱们常常会用到时间相关类，咱们有不少办法在Java代码中获取时间。可是不一样的方法获取到的时间的格式都不尽相同，这时候就须要一种格式化工具，把时间显示成咱们须要的格式。

最经常使用的方法就是使用SimpleDateFormat类。这是一个看上去功能比较简单的类，可是，一旦使用不当也有可能致使很大的问题。

在阿里巴巴Java开发手册中，有以下明确规定：

那么，本文就围绕SimpleDateFormat的用法、原理等来深刻分析下如何以正确的姿式使用它。

SimpleDateFormat用法

SimpleDateFormat是Java提供的一个格式化和解析日期的工具类。它容许进行格式化（日期 -> 文本）、解析（文本 -> 日期）和规范化。SimpleDateFormat 使得能够选择任何用户定义的日期-时间格式的模式。

在Java中，可使用SimpleDateFormat的format方法，将一个Date类型转化成String类型，而且能够指定输出格式。

// Date转String
Date data = new Date();
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String dataStr = sdf.format(data);
System.out.println(dataStr);

以上代码，转换的结果是：2018-11-25 13:00:00，日期和时间格式由”日期和时间模式”字符串指定。若是你想要转换成其余格式，只要指定不一样的时间模式就好了。

在Java中，可使用SimpleDateFormat的parse方法，将一个String类型转化成Date类型。

// String转Data
System.out.println(sdf.parse(dataStr));

日期和时间模式表达方法

在使用SimpleDateFormat的时候，须要经过字母来描述时间元素，并组装成想要的日期和时间模式。经常使用的时间元素和字母的对应表以下：

模式字母一般是重复的，其数量肯定其精确表示。以下表是经常使用的输出格式的表示方法。

输出不一样时区的时间

时区是地球上的区域使用同一个时间定义。之前，人们经过观察太阳的位置（时角）决定时间，这就使得不一样经度的地方的时间有所不一样（地方时）。1863年，首次使用时区的概念。时区经过设立一个区域的标准时间部分地解决了这个问题。

世界各个国家位于地球不一样位置上，所以不一样国家，特别是东西跨度大的国家日出、日落时间一定有所误差。这些误差就是所谓的时差。

现今全球共分为24个时区。因为实用上经常1个国家，或1个省份同时跨着2个或更多时区，为了照顾到行政上的方便，常将1个国家或1个省份划在一块儿。因此时区并不严格按南北直线来划分，而是按天然条件来划分。例如，中国幅员宽广，差很少跨5个时区，但为了使用方便简单，实际上在只用东八时区的标准时即北京时间为准。

因为不一样的时区的时间是不同的，甚至同一个国家的不一样城市时间均可能不同，因此，在Java中想要获取时间的时候，要重点关注一下时区问题。

默认状况下，若是不指明，在建立日期的时候，会使用当前计算机所在的时区做为默认时区，这也是为何咱们经过只要使用new Date()就能够获取中国的当前时间的缘由。

那么，如何在Java代码中获取不一样时区的时间呢？SimpleDateFormat能够实现这个功能。

SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
sdf.setTimeZone(TimeZone.getTimeZone("America/Los_Angeles"));
System.out.println(sdf.format(Calendar.getInstance().getTime()));

以上代码，转换的结果是： 2018-11-24 21:00:00 。既中国的时间是11月25日的13点，而美国洛杉矶时间比中国北京时间慢了16个小时（这还和冬夏令时有关系，就不详细展开了）。

若是你感兴趣，你还能够尝试打印一下美国纽约时间（America/New_York）。纽约时间是2018-11-25 00:00:00。纽约时间比中国北京时间慢了13个小时。

固然，这不是显示其余时区的惟一方法，不过本文主要为了介绍SimpleDateFormat，其余方法暂不介绍了。

SimpleDateFormat线程安全性

因为SimpleDateFormat比较经常使用，并且在通常状况下，一个应用中的时间显示模式都是同样的，因此不少人愿意使用以下方式定义SimpleDateFormat：

public class Main {
   private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
   public static void main(String[] args) {
       simpleDateFormat.setTimeZone(TimeZone.getTimeZone("America/New_York"));
       System.out.println(simpleDateFormat.format(Calendar.getInstance().getTime()));
   }
}

这种定义方式，存在很大的安全隐患。

问题重现

咱们来看一段代码，如下代码使用线程池来执行时间输出。

/** * @author Hollis */ 
public class Main {

   /**
    * 定义一个全局的SimpleDateFormat
    */
   private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

   /**
    * 使用ThreadFactoryBuilder定义一个线程池
    */
   private static ThreadFactory namedThreadFactory = new ThreadFactoryBuilder()
       .setNameFormat("demo-pool-%d").build();

   private static ExecutorService pool = new ThreadPoolExecutor(5, 200,
       0L, TimeUnit.MILLISECONDS,
       new LinkedBlockingQueue<Runnable>(1024), namedThreadFactory, new ThreadPoolExecutor.AbortPolicy());

   /**
    * 定义一个CountDownLatch，保证全部子线程执行完以后主线程再执行
    */
   private static CountDownLatch countDownLatch = new CountDownLatch(100);

   public static void main(String[] args) {
       //定义一个线程安全的HashSet
       Set<String> dates = Collections.synchronizedSet(new HashSet<String>());
       for (int i = 0; i < 100; i++) {
           //获取当前时间
           Calendar calendar = Calendar.getInstance();
           int finalI = i;
           pool.execute(() -> {
                   //时间增长
                   calendar.add(Calendar.DATE, finalI);
                   //经过simpleDateFormat把时间转换成字符串
                   String dateString = simpleDateFormat.format(calendar.getTime());
                   //把字符串放入Set中
                   dates.add(dateString);
                   //countDown
                   countDownLatch.countDown();
           });
       }
       //阻塞，直到countDown数量为0
       countDownLatch.await();
       //输出去重后的时间个数
       System.out.println(dates.size());
   }
}

以上代码，其实比较容易理解。就是循环一百次，每次循环的时候都在当前时间基础上增长一个天数（这个天数随着循环次数而变化），而后把全部日期放入一个线程安全的、带有去重功能的Set中，而后输出Set中元素个数。

上面的例子我特地写的稍微复杂了一些，不过我几乎都加了注释。这里面涉及到了线程池的建立、CountDownLatch、lambda表达式、线程安全的HashSet等知识。感兴趣的朋友能够逐一了解一下。

正常状况下，以上代码输出结果应该是100。可是实际执行结果是一个小于100的数字。

缘由就是由于SimpleDateFormat做为一个非线程安全的类，被当作了共享变量在多个线程中进行使用，这就出现了线程安全问题。

在阿里巴巴Java开发手册的第一章第六节——并发处理中关于这一点也有明确说明：

那么，接下来咱们就来看下究竟是为何，以及该如何解决。

线程不安全缘由

经过以上代码，咱们发现了在并发场景中使用SimpleDateFormat会有线程安全问题。其实，JDK文档中已经明确代表了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.

那么接下来分析下为何会出现这种问题，SimpleDateFormat底层究竟是怎么实现的？

咱们跟一下SimpleDateFormat类中format方法的实现其实就能发现端倪。



SimpleDateFormat中的format方法在执行过程当中，会使用一个成员变量calendar来保存时间。这其实就是问题的关键。

因为咱们在声明SimpleDateFormat的时候，使用的是static定义的。那么这个SimpleDateFormat就是一个共享变量，随之，SimpleDateFormat中的calendar也就能够被多个线程访问到。

假设线程1刚刚执行完calendar.setTime把时间设置成2018-11-11，还没等执行完，线程2又执行了calendar.setTime把时间改为了2018-12-12。这时候线程1继续往下执行，拿到的calendar.getTime获得的时间就是线程2改过以后的。

除了format方法之外，SimpleDateFormat的parse方法也有一样的问题。

因此，不要把SimpleDateFormat做为一个共享变量使用。

如何解决

前面介绍过了SimpleDateFormat存在的问题以及问题存在的缘由，那么有什么办法解决这种问题呢？

解决方法有不少，这里介绍三个比较经常使用的方法。

使用局部变量

for (int i = 0; i < 100; i++) {
   //获取当前时间
   Calendar calendar = Calendar.getInstance();
   int finalI = i;
   pool.execute(() -> {
       // SimpleDateFormat声明成局部变量
   SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
       //时间增长
       calendar.add(Calendar.DATE, finalI);
       //经过simpleDateFormat把时间转换成字符串
       String dateString = simpleDateFormat.format(calendar.getTime());
       //把字符串放入Set中
       dates.add(dateString);
       //countDown
       countDownLatch.countDown();
   });
}

SimpleDateFormat变成了局部变量，就不会被多个线程同时访问到了，就避免了线程安全问题。

加同步锁

除了改为局部变量之外，还有一种方法你们可能比较熟悉的，就是对于共享变量进行加锁。

for (int i = 0; i < 100; i++) {
   //获取当前时间
   Calendar calendar = Calendar.getInstance();
   int finalI = i;
   pool.execute(() -> {
       //加锁
       synchronized (simpleDateFormat) {
           //时间增长
           calendar.add(Calendar.DATE, finalI);
           //经过simpleDateFormat把时间转换成字符串
           String dateString = simpleDateFormat.format(calendar.getTime());
           //把字符串放入Set中
           dates.add(dateString);
           //countDown
           countDownLatch.countDown();
       }
   });
}

经过加锁，使多个线程排队顺序执行。避免了并发致使的线程安全问题。

其实以上代码还有能够改进的地方，就是能够把锁的粒度再设置的小一点，能够只对simpleDateFormat.format这一行加锁，这样效率更高一些。

使用ThreadLocal

第三种方式，就是使用 ThreadLocal。 ThreadLocal 能够确保每一个线程均可以获得单独的一个 SimpleDateFormat 的对象，那么天然也就不存在竞争问题了。

/**
* 使用ThreadLocal定义一个全局的SimpleDateFormat
*/
private static ThreadLocal<SimpleDateFormat> simpleDateFormatThreadLocal = new ThreadLocal<SimpleDateFormat>() {
   @Override
   protected SimpleDateFormat initialValue() {
       return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
   }
};

//用法
String dateString = simpleDateFormatThreadLocal.get().format(calendar.getTime());

固然，以上代码也有改进空间，就是，其实SimpleDateFormat的建立过程能够改成延迟加载。这里就不详细介绍了。

使用DateTimeFormatter

若是是Java8应用，可使用DateTimeFormatter代替SimpleDateFormat，这是一个线程安全的格式化工具类。就像官方文档中说的，这个类 simple beautiful strongimmutable thread-safe。

 

//解析日期
String dateStr= "2016年10月25日";
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy年MM月dd日");
LocalDate date= LocalDate.parse(dateStr, formatter);

//日期转换为字符串
LocalDateTime now = LocalDateTime.now();
DateTimeFormatter format = DateTimeFormatter.ofPattern("yyyy年MM月dd日 hh:mm a");
String nowStr = now .format(format);
System.out.println(nowStr);

 

总结

本文介绍了SimpleDateFormat的用法，SimpleDateFormat主要能够在String和Date之间作转换，还能够将时间转换成不一样时区输出。同时提到在并发场景中SimpleDateFormat是不能保证线程安全的，须要开发者本身来保证其安全性。

主要的几个手段有改成局部变量、使用synchronized加锁、使用Threadlocal为每个线程单首创建一个和使用Java8中的DateTimeFormatter类代替等。

但愿经过此文，你能够在使用SimpleDateFormat的时候更加驾轻就熟。