Calendar类set()方法的“陷阱”

2023年6月5日更新：我看还有开发同志在用Calendar，我想目前大部分项目jdk一般使用的都是JDK8及以上了，而且JDK11和17市场份额好像在爆发，其实更建议使用 JDK8提供的日期时间API（LocalDate和LocalDateTime），确实要更好用一些。

-------------------- 以下为原文 --------------------

在项目中，需要获取指定年份和月份的最后一天。我在网上找到了一个用Calendar类获取的方法，代码如下：

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;

public class TestCalendar {
	public static void main(String[] args) {
		String s = new SimpleDateFormat("yyyy-MM-dd")
				.format(getLastDay(2017, 9));
		System.out.println(s);
	}

	public static Date getLastDay(int year, int month) {
		//获取Calendar类的实例
		Calendar c = Calendar.getInstance();
		//设置年份
		c.set(Calendar.YEAR, year);
		//设置月份，因为月份从0开始，所以用month - 1
		c.set(Calendar.MONTH, month - 1);
		//获取当前时间下，该月的最大日期的数字
		int lastDay = c.getActualMaximum(Calendar.DAY_OF_MONTH);
		//将获取的最大日期数设置为Calendar实例的日期数
		c.set(Calendar.DAY_OF_MONTH, lastDay);

		return c.getTime();
	}
}

刚开始使用这个方法的时候，很正常。后来在10月31号（这个日期很重要）当天测试的时候，传递的参数时2017年9月，即上面的代码，但是结果却出现的了问题，结果如下图：

本来该是2017-09-30，可是结果却是2017-10-01，我原先测试过，这个方法是没有问题的，可是出了这样的问题。后来我断点测试，在刚获取到Calendar实例的时候，实例中的字段值如下图：

但是发现在执行完

c.set(Calendar.MONTH, month - 1);

这行的代码的时候，Calendar的实例中，MONTH字段的值不是我预想中的8（月份字段从0开始），而是9，而且DAY_OF_MONTH字段的值从31变成了1，如下图所示：

因此，可以判断Calendar实例获取到的时候，是10月31号，实例中的DAY_OF_MONTH的值是31，当把MONTH字段的值设置为8后，因为9月份只有30天，那DAY_OF_MONTH的值就多1，会自动向后顺延1天，变成了2017-10-01 。

但是，还是有其他的问题，因为下面还执行了

c.set(Calendar.DAY_OF_MONTH, lastDay);

这句代码，最后的日期应该是2017-10-31才对，但是run的结果却是2017-10-01，debug的结果是2017-10-31 。

我第一感觉认为Calendar类是不是存在线程安全问题，可是后来一想就觉得不对，毕竟我只是在主线程中运行，没有多线程，并不存在这个问题。

第二天我又尝试了下，发现了问题的原因，如上面的最后一张图所示，在debug的过程中，我用IDEA的watches功能查看了Calendar实例的字段值，用了get()方法，如果我删除掉这几个get方法之后，发现run和debug的值是一样的，都是2017-10-01，说明问题出在get()方法上。

因此，可以做如下修改：

在代码中，直接打印变量c的值，可以发现，在调用get()方法之前，变量c的各字段值是set()方法设置的，但是并没有对其进行验证计算，在调用get()方法的过程中，会对各字段验证计算。我查看了部分源码，在调用get(),add(),getTime()等方法的过程中，底层都会调用computeTime()方法，对各字段的时间验证计算。

另外，又做了一个demo测试，以佐证上面的结论，如下：

import java.text.SimpleDateFormat;
import java.util.Calendar;

public class TestCalendar2 {

	public static void main(String[] args) {
		Calendar c = Calendar.getInstance();
		c.set(Calendar.MONTH, 8);           //将月份设置为9月
		c.set(Calendar.DAY_OF_MONTH, 32);   //将日期设置为32
		System.out.println(c);              //直接打印Calendar实例，不使用getTime()方法
		c.get(Calendar.MONTH);
		System.out.println(c);
	}
}

结果如下：

即使设置的DAY_OF_MONTH值是明显非法的，但是并不会在调用get()方法之前进行计算进位。

在查询问题的过程中，也看到了其他的一些问题，这篇文章对add(),set(),roll()方法的区别做了解释：

新浪博客

回到最初的问题，获取指定年份和月份的最大的日期的方法要怎么办？

方法可以改为：

public static Date getLastDay(int year, int month) {
	Calendar c = Calendar.getInstance();    //获取Calendar类的实例
	c.clear();
	c.set(Calendar.YEAR, year);             //设置年份
	c.set(Calendar.MONTH, month - 1);       //设置月份，因为月份从0开始，所以用month - 1
	int lastDay = c.getActualMaximum(Calendar.DAY_OF_MONTH);    //获取当前时间下，该月的最大日期的数字
	c.set(Calendar.DAY_OF_MONTH, lastDay);  //将获取的最大日期数设置为Calendar实例的日期数
	return c.getTime();                     //返回日期
}

用clear()方法，将Calendar实例的字段和时间都设置为未定义，这样可以解决这个问题。

当然网上也有将月份设置为下个月，然后用add(Calendar.DAY_OF_MONTH, -1)这样的方法也可以得到结果，不过这里就不详细介绍了。