java时间类-Period时间差计算场景

#1024程序员节 | 征文#

我们在平时业务中经常会遇到时间差值计算的场景，比如结束时间距离开始时间的间隔了多少月、多少天、时分秒等要求。

那在实际编码的过程中如何实现呢？

本文将以Java Springboot框架演示如何实现，时间差的计算及差值格式转化。

首先在java8中的java.time时间类型中的类函数 Period.between 可以用来计算两个日期之间的时间差，获取年、月、天等信息。为了支持 String 类型的日期输入，我们可以将字符串解析为 LocalDate，然后计算时间差。

以下是封装的 DateUtils 工具类，支持 String 和 LocalDate 类型的输入：

package com.javastudy.springboot3framework.myapp.util;

import java.time.LocalDate;
import java.time.Period;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeParseException;
/**
 * @author zhizhou   2024/10/21 21:22
 */
public class DateUtils {
    
    // 定义日期格式
    private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd");
    
    /**
     * 计算时间差，返回月和天的差异
     * @param startAt 起始日期，支持 String 和 LocalDate
     * @param endAt 结束日期，支持 String 和 LocalDate
     * @return 返回格式化后的月数和天数的差异
     */
    public static String calculatePeriod(String startAt/*yyyy-mm-dd*/, String endAt/*yyyy-mm-dd*/) {
        LocalDate startDate = parseStringToDate(startAt);
        LocalDate endDate = parseStringToDate(endAt);
        return calculatePeriod(startDate, endDate);
    }
    
    public static String calculatePeriod(LocalDate startAt, LocalDate endAt) {
        Period period = Period.between(startAt, endAt);
        return period.getMonths() + " 月 和 " + period.getDays() + " 天";
    }
    
    // 工具方法：解析字符串为LocalDate
    private static LocalDate parseStringToDate(String date) {
        try {
            return LocalDate.parse(date, DATE_FORMATTER);
        } catch (DateTimeParseException e) {
            throw new IllegalArgumentException("格式不合法, 请使用 yyyy-MM-dd");
        }
    }
    
    public static void main(String[] args) {
        // 测试
        System.out.println(calculatePeriod("2024-08-15", "2024-10-21")); //输出 2 月 和 6 天
        System.out.println(calculatePeriod(LocalDate.of(2024, 8, 15), LocalDate.of(2024, 10, 21))); //输出 2 月 和 6 天
    }
}

说明：

1. 入参支持 String 和 LocalDate：字符串将解析为 LocalDate 类型，如果解析失败会抛出 IllegalArgumentException。
2. 计算月和天的差异：使用 Period.between 方法来计算两个日期之间的月数和天数。
3. 日期格式支持：字符串日期格式为 yyyy-MM-dd，可以根据需要修改。

示例输出：

System.out.println(calculatePeriod("2024-08-15", "2024-10-21")); //输出 2 月 和 6 天

System.out.println(calculatePeriod(LocalDate.of(2024, 8, 15), LocalDate.of(2024, 10, 21))); 
//输出 2 月 和 6 天

这个方法可以灵活地处理日期格式输入，并计算时间差异。
这种要求在实际业务中很容易遇到，这样，你可以在实际应用中处理更精确的时间差计算。