踩过的坑！LocalDateTime计算间隔天数，小心比较器和Period的陷阱

2023-12-07 08:12:02

实习期间，我遇到了一个棘手的bug，它让我头疼了好几天。这个bug与使用LocalDateTime计算两个日期之间的天数间隔有关。在本文中，我将分享我的经历，并讨论使用compareTo()和Period.between()方法可能导致的错误。我希望我的经验能够帮助你避免这些陷阱，并使你的LocalDateTime代码更加健壮。

问题

我在一个项目中需要计算两个日期之间的天数间隔，并根据这个间隔做出相应的处理。我使用的是LocalDateTime类，并尝试使用compareTo()方法来比较两个日期，如下所示：

LocalDateTime startDate = LocalDateTime.now();
LocalDateTime endDate = LocalDateTime.now().plusDays(1);
int daysBetween = startDate.compareTo(endDate);

但是，当我运行这段代码时，daysBetween的值总是为0，即使endDate明显比startDate大一天。这让我感到非常困惑，我检查了代码好几次，但都没有发现任何错误。

解决方案

经过一番研究，我终于找到了问题的根源。原来，compareTo()方法并不是用来计算两个日期之间的天数间隔的。它只返回一个整数，表示第一个日期与第二个日期的关系。如果第一个日期等于第二个日期，则返回0；如果第一个日期大于第二个日期，则返回1；如果第一个日期小于第二个日期，则返回-1。

为了计算两个日期之间的天数间隔，我应该使用Period.between()方法。这个方法返回一个Period对象，其中包含了两个日期之间的年、月和日间隔。要获得天数间隔，我只需要使用Period.getDays()方法即可，如下所示：

LocalDateTime startDate = LocalDateTime.now();
LocalDateTime endDate = LocalDateTime.now().plusDays(1);
Period period = Period.between(startDate, endDate);
int daysBetween = period.getDays();