java：通过Calendar类正确计算两日期之间的间隔

在开发Android应用时偶然需要用到一个提示用户已用天数的功能，从实现上来看无非就是持久化存入用户第一次使用应用的时间firstTime（通过SharedPreferences 、xml、sqlite等），当用户再次使用应用时取得此时时间presentTime,通过两个时间计算其间隔天数。

当取得两个时间变量后，网上计算日期间隔的做法通常是这样的（获得两时间的毫秒数之差再进行处理）：

long beginTime = beginDate.getTime();
long endTime = endDate.getTime();
long betweenDays = (long)((endTime - beginTime) / (1000 * 60 * 60 *24));

long beginTime = beginDate.getTime(); 
long endTime = endDate.getTime(); 
long betweenDays = (long)((endTime - beginTime) / (1000 * 60 * 60 *24)); 

下面测试一下两种特殊情况：

情况1：

Calendar beginCalendar = Calendar.getInstance();
beginCalendar.set(2017,2,3,1,0,0);      //设定时间为2017年3月3日 1:0:0
Calendar endCalendar = Calendar.getInstance();
endCalendar.set(2017,2,3,14,0,0);       //设定时间为2017年3月3日 14:0:0
long beginTime = beginCalendar.getTime().getTime();
long endTime = endCalendar.getTime().getTime();
long betweenDays = (long)((endTime - beginTime) / (1000 * 60 * 60 *24));
System.out.println(betweenDays);        //输出为0

Calendar beginCalendar = Calendar.getInstance();
beginCalendar.set(2017,2,3,1,0,0);		//设定时间为2017年3月3日 1:0:0 
Calendar endCalendar = Calendar.getInstance();
endCalendar.set(2017,2,3,14,0,0);		//设定时间为2017年3月3日 14:0:0 
long beginTime = beginCalendar.getTime().getTime(); 
long endTime = endCalendar.getTime().getTime(); 
long betweenDays = (long)((endTime - beginTime) / (1000 * 60 * 60 *24)); 
System.out.println(betweenDays);		//输出为0

情况2：

Calendar beginCalendar = Calendar.getInstance();
beginCalendar.set(2017,2,2,20,20,20);<span style="white-space: pre;">       </span>//设定时间为2017年3月2日20:20:20
Calendar endCalendar = Calendar.getInstance();
endCalendar.set(2017,2,3,10,10,10);     //设定时间为2017年3月3日10:10:10
long beginTime = beginCalendar.getTime().getTime();
long endTime = endCalendar.getTime().getTime();
long betweenDays = (long)((endTime - beginTime) / (1000 * 60 * 60 *24));
System.out.println(betweenDays);        //输出为0，但其实应该为1

Calendar beginCalendar = Calendar.getInstance();
beginCalendar.set(2017,2,2,20,20,20);		//设定时间为2017年3月2日20:20:20  
Calendar endCalendar = Calendar.getInstance();
endCalendar.set(2017,2,3,10,10,10);		//设定时间为2017年3月3日10:10:10
long beginTime = beginCalendar.getTime().getTime(); 
long endTime = endCalendar.getTime().getTime(); 
long betweenDays = (long)((endTime - beginTime) / (1000 * 60 * 60 *24)); 
System.out.println(betweenDays);		//输出为0，但其实应该为1

可见，对于本应该时间间隔为1的情况该代码输出为0。究其原因，是因为当 两日期的毫秒数之差 < 一天的毫秒数（1000*60*60*24）时，即使两日期跨了一天，强制类型转换后结果也会变成0。通过下图可以看出毫秒数之差小于一天的两种情况。

情况1（毫秒数之差小于一天且不跨天，日期间隔应为0）：

情况2（毫秒数之差小于一天且跨天，日期间隔应为1）：

所以上述代码需要改进，使其能够识别跨天这种特殊情况：

public static int getTimeDistance(Date beginDate , Date endDate ) {
    Calendar beginCalendar = Calendar.getInstance();
    beginCalendar.setTime(beginDate);
    Calendar endCalendar = Calendar.getInstance();
    endCalendar.setTime(endDate);
    long beginTime = beginCalendar.getTime().getTime();
    long endTime = endCalendar.getTime().getTime();
    int betweenDays = (int)((endTime - beginTime) / (1000 * 60 * 60 *24));//先算出两时间的毫秒数之差大于一天的天数

    endCalendar.add(Calendar.DAY_OF_MONTH, -betweenDays);//使endCalendar减去这些天数，将问题转换为两时间的毫秒数之差不足一天的情况
    endCalendar.add(Calendar.DAY_OF_MONTH, -1);//再使endCalendar减去1天
    if(beginCalendar.get(Calendar.DAY_OF_MONTH)==endCalendar.get(Calendar.DAY_OF_MONTH))//比较两日期的DAY_OF_MONTH是否相等
        return betweenDays + 1; //相等说明确实跨天了
    else
        return betweenDays + 0; //不相等说明确实未跨天
}

public static int getTimeDistance(Date beginDate , Date endDate ) {
    Calendar beginCalendar = Calendar.getInstance();
    beginCalendar.setTime(beginDate);
    Calendar endCalendar = Calendar.getInstance();
    endCalendar.setTime(endDate);
    long beginTime = beginCalendar.getTime().getTime();
    long endTime = endCalendar.getTime().getTime();
    int betweenDays = (int)((endTime - beginTime) / (1000 * 60 * 60 *24));//先算出两时间的毫秒数之差大于一天的天数
    
    endCalendar.add(Calendar.DAY_OF_MONTH, -betweenDays);//使endCalendar减去这些天数，将问题转换为两时间的毫秒数之差不足一天的情况
    endCalendar.add(Calendar.DAY_OF_MONTH, -1);//再使endCalendar减去1天
    if(beginCalendar.get(Calendar.DAY_OF_MONTH)==endCalendar.get(Calendar.DAY_OF_MONTH))//比较两日期的DAY_OF_MONTH是否相等
        return betweenDays + 1;	//相等说明确实跨天了
    else
        return betweenDays + 0;	//不相等说明确实未跨天
}

代码中有个细节需要注意，我先使 endCalendar.add(Calendar.DAY_OF_MONTH, -1)，然后比较两日期的DAY_OF_MONTH时间值是否相等，从而确定返回值

而没有直接

return betweenDays + endCalendar.get(Calendar.DAY_OF_MONTH)-beginCalendar.get(Calendar.DAY_OF_MONTH);

return betweenDays + endCalendar.get(Calendar.DAY_OF_MONTH)-beginCalendar.get(Calendar.DAY_OF_MONTH);

是因为有可能出现跨月的情况，例如beginCalendar的日期为2月28日，endCalendar日期为3月1日，endCalendar.get(Calendar.DAY_OF_MONTH)-beginCalendar.get(Calendar.DAY_OF_MONTH)的值就会是-27而不是预期中的1。而使用endCalendar.add(Calendar.DAY_OF_MONTH, -1），Calendar类的方法会自动的对跨月情况进行转换。