重构代码；单元测试

2024-08-26 17:36:36 +08:00
parent 43e01e5595
commit 0aaa9331dc
6 changed files with 233 additions and 121 deletions
--- a/src/main/java/xyz/zhouxy/plusone/commons/time/Quarter.java
+++ b/src/main/java/xyz/zhouxy/plusone/commons/time/Quarter.java
@@ -0,0 +1,145 @@
+package xyz.zhouxy.plusone.commons.time;
+
+import java.time.Month;
+import java.time.MonthDay;
+
+import com.google.common.base.Preconditions;
+
+import xyz.zhouxy.plusone.commons.util.Numbers;
+
+/**
+ * 季度
+ * 
+ * @author zhouxy
+ */
+public enum Quarter {
+    /** 第一季度 */
+    Q1(1),
+    /** 第二季度 */
+    Q2(2),
+    /** 第三季度 */
+    Q3(3),
+    /** 第四季度 */
+    Q4(4),
+    ;
+
+    /** 季度值 (1/2/3/4) */
+    private final int value;
+
+    /** 季度开始月份 */
+    private final int firstMonth;
+
+    /** 季度结束月份 */
+    private final int lastMonth;
+
+    /** 常量值 */
+    private static final Quarter[] ENUMS = Quarter.values();
+
+    /**
+     * @param value 季度值 (1/2/3/4)
+     */
+    Quarter(int value) {
+        this.value = value;
+
+        this.lastMonth = value * 3;
+        this.firstMonth = this.lastMonth - 2;
+    }
+
+    /**
+     * 根据给定的月份值返回对应的季度
+     * 
+     * @param monthValue 月份值，取值范围为1到12
+     * @return 对应的季度
+     * @throws IllegalArgumentException 如果月份值不在有效范围内（1到12），将抛出异常
+     */
+    public static Quarter fromMonth(int monthValue) {
+        Preconditions.checkArgument(Numbers.between(monthValue, 1, 13), "Invalid value for MonthOfYear: " + monthValue);
+        return of(computeQuarterValueInternal(monthValue));
+    }
+
+    /**
+     * 根据给定的月份返回对应的季度
+     * 
+     * @param month 月份
+     * @return 对应的季度
+     */
+    public static Quarter fromMonth(Month month) {
+        final int monthValue = month.getValue();
+        return of(computeQuarterValueInternal(monthValue));
+    }
+
+    /**
+     * 根据指定的年份，获取一个新的 YearQuarter 实例
+     * 此方法允许在保持当前季度信息不变的情况下，更改年份
+     *
+     * @param year 指定的年份
+     * @return 返回一个新的 YearQuarter 实例，年份更新为指定的年份
+     */
+    public final YearQuarter atYear(int year) {
+        return YearQuarter.of(year, this);
+    }
+
+    /**
+     * 根据给定的季度值返回对应的季度
+     * 
+     * @param value 季度值 (1/2/3/4)
+     * @return 对应的季度
+     * @throws IllegalArgumentException 如果季度值不在有效范围内（1到4），将抛出异常
+     */
+    public static Quarter of(int value) {
+        if (value < 1 || value > 4) {
+            throw new IllegalArgumentException("Invalid value for Quarter: " + value);
+        }
+        return ENUMS[value - 1];
+    }
+
+    // Getters
+
+    public int getValue() {
+        return value;
+    }
+
+    public Month firstMonth() {
+        return Month.of(firstMonth);
+    }
+
+    public int firstMonthValue() {
+        return firstMonth;
+    }
+
+    public Month lastMonth() {
+        return Month.of(lastMonth);
+    }
+
+    public int lastMonthValue() {
+        return lastMonth;
+    }
+
+    public MonthDay firstMonthDay() {
+        return MonthDay.of(this.firstMonth, 1);
+    }
+
+    public MonthDay lastMonthDay() {
+        // 季度的最后一个月不可能是 2 月
+        final Month month = lastMonth();
+        return MonthDay.of(month, month.maxLength());
+    }
+
+    public int firstDayOfYear(boolean leapYear) {
+        return Month.of(this.firstMonth).firstDayOfYear(leapYear);
+    }
+
+    // Getters end
+
+    // Internal
+
+    /**
+     * 计算给定月份对应的季度值
+     * 
+     * @param monthValue 月份值，取值范围为1到12
+     * @return 对应的季度值
+     */
+    private static int computeQuarterValueInternal(int monthValue) {
+        return (monthValue - 1) / 3 + 1;
+    }
+}
--- a/src/main/java/xyz/zhouxy/plusone/commons/time/YearQuarter.java
+++ b/src/main/java/xyz/zhouxy/plusone/commons/time/YearQuarter.java
@@ -0,0 +1,188 @@
+package xyz.zhouxy.plusone.commons.time;
+
+import java.io.Serializable;
+import java.time.LocalDate;
+import java.time.Month;
+import java.time.YearMonth;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.Objects;
+
+import javax.annotation.Nonnull;
+
+import com.google.common.base.Preconditions;
+
+/**
+ * 表示年份与季度
+ * 
+ * @author zhouxy
+ */
+public final class YearQuarter implements Comparable<YearQuarter>, Serializable {
+    private static final long serialVersionUID = 3804145964419489753L;
+
+    /** 年份 */
+    private final int year;
+    /** 季度 */
+    private final Quarter quarter;
+    /** 季度开始日期 */
+    private final LocalDate firstDate;
+    /** 季度结束日期 */
+    private final LocalDate lastDate;
+
+    private YearQuarter(int year, @Nonnull Quarter quarter) {
+        Preconditions.checkNotNull(quarter, "Quarter can not be null.");
+        this.year = year;
+        this.quarter = quarter;
+        this.firstDate = quarter.firstMonthDay().atYear(year);
+        this.lastDate = quarter.lastMonthDay().atYear(year);
+    }
+
+    /**
+     * 根据指定年份与季度，创建 {@link YearQuarter} 实例
+     * 
+     * @param year 年份
+     * @param quarter 季度
+     * @return {@link YearQuarter} 实例
+     */
+    public static YearQuarter of(int year, @Nonnull Quarter quarter) {
+        return new YearQuarter(year, quarter);
+    }
+
+    /**
+     * 根据指定日期，判断日期所在的年份与季度，创建 {@link YearQuarter} 实例
+     * 
+     * @param date 日期
+     * @return {@link YearQuarter} 实例
+     */
+    public static YearQuarter of(@Nonnull LocalDate date) {
+        return new YearQuarter(date.getYear(), Quarter.fromMonth(date.getMonth()));
+    }
+
+    /**
+     * 根据指定日期，判断日期所在的年份与季度，创建 {@link YearQuarter} 实例
+     * 
+     * @param date 日期
+     * @return {@link YearQuarter} 实例
+     */
+    public static YearQuarter of(@Nonnull Date date) {
+        @SuppressWarnings("deprecation")
+        final int year = date.getYear() + 1900;
+        @SuppressWarnings("deprecation")
+        final int month = date.getMonth() + 1;
+        return of(year, Quarter.fromMonth(month));
+    }
+
+    /**
+     * 根据指定日期，判断日期所在的年份与季度，创建 {@link YearQuarter} 实例
+     * 
+     * @param date 日期
+     * @return {@link YearQuarter} 实例
+     */
+    public static YearQuarter of(Calendar date) {
+        return of(date.get(Calendar.YEAR), Quarter.fromMonth(date.get(Calendar.MONTH) + 1));
+    }
+
+    /**
+     * 根据指定年月，判断其所在的年份与季度，创建 {@link YearQuarter} 实例
+     * 
+     * @param yearMonth 年月
+     * @return {@link YearQuarter} 实例
+     */
+    public static YearQuarter of(YearMonth yearMonth) {
+        return of(yearMonth.getYear(), Quarter.fromMonth(yearMonth.getMonth()));
+    }
+
+    // Getters
+
+    public int getYear() {
+        return year;
+    }
+
+    public Quarter getQuarter() {
+        return quarter;
+    }
+
+    public YearMonth firstYearMonth() {
+        return YearMonth.of(this.year, this.quarter.firstMonth());
+    }
+
+    public Month firstMonth() {
+        return this.quarter.firstMonth();
+    }
+
+    public int firstMonthValue() {
+        return this.quarter.firstMonthValue();
+    }
+
+    public YearMonth lastYearMonth() {
+        return YearMonth.of(this.year, this.quarter.lastMonth());
+    }
+
+    public Month lastMonth() {
+        return this.quarter.lastMonth();
+    }
+
+    public int lastMonthValue() {
+        return this.quarter.lastMonthValue();
+    }
+
+    public LocalDate firstDate() {
+        return firstDate;
+    }
+
+    public LocalDate lastDate() {
+        return lastDate;
+    }
+
+    // Getters end
+
+    // hashCode & equals
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(year, quarter);
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj)
+            return true;
+        if (obj == null)
+            return false;
+        if (getClass() != obj.getClass())
+            return false;
+        YearQuarter other = (YearQuarter) obj;
+        return year == other.year && quarter == other.quarter;
+    }
+
+    // compareTo
+
+    @Override
+    public int compareTo(YearQuarter other) {
+        int cmp = (this.year - other.year);
+        if (cmp == 0) {
+            cmp = (this.quarter.compareTo(other.quarter));
+        }
+        return cmp;
+    }
+
+    public boolean isBefore(YearQuarter other) {
+        return this.compareTo(other) < 0;
+    }
+
+    public boolean isAfter(YearQuarter other) {
+        return this.compareTo(other) > 0;
+    }
+
+    // toString
+
+    /**
+     * 返回 {@link YearQuarter} 的字符串表示形式，如 "Q3 2024"
+     * 
+     * @return {@link YearQuarter} 的字符串表示形式
+     */
+    @Override
+    public String toString() {
+        return this.quarter.name() + " " + this.year;
+    }
+}