【Java】给定执行周期和首次执行时间，生成Cron表达式工具类

逃离我推掉我的手 2023-09-29 17:26 116阅读 0赞

文章目录

  • 背景需求
  • 代码实现
    • 枚举及常量
    • 工具类
    • 测试

背景需求

页面通过配置执行周期和初次执行时间，后台根据这两个参数，生成对应的Cron表达式，定期生成执行任务的Task，当然，这里也可以直接使用Cron表达式插件，但是对使用者有一定的理解成本。

87d77b2c11d54284514318da6429a21b.png

代码实现

枚举及常量

定义执行周期：

  1. /**
  2.  * 执行周期枚举
  3.  *
  4.  * @author zhurunhua
  5.  * @since 2022/10/24 11:30
  6.  */
  7. public enum PeriodEnum {
  9.     /**
  10.      * 执行一次
  11.      */
  12.     ONCE,
  13.     /**
  14.      * 每天
  15.      */
  16.     DAILY,
  17.     /**
  18.      * 每周
  19.      */
  20.     WEEKLY,
  21.     /**
  22.      * 每月
  23.      */
  24.     MONTHLY
  25. }

定义星期中英文枚举

  1. /**
  2.  * 星期枚举
  3.  *
  4.  * @author zhurunhua
  5.  * @since 2022/10/24 11:30
  6.  */
  7. @Getter
  8. public enum WeekEnum {
  11.     /**
  12.      * 周一
  13.      */
  14.     Monday("星期一", "Mon"),
  15.     /**
  16.      * 周二
  17.      */
  18.     Tuesday("星期二", "Tue"),
  19.     /**
  20.      * 周三
  21.      */
  22.     Wednesday("星期三", "Wed"),
  23.     /**
  24.      * 周四
  25.      */
  26.     Thursday("星期四", "Thu"),
  27.     /**
  28.      * 周五
  29.      */
  30.     Friday("星期五", "Fri"),
  31.     /**
  32.      * 周六
  33.      */
  34.     Saturday("星期六", "Sat"),
  35.     /**
  36.      * 周日
  37.      */
  38.     Sunday("星期日", "Sun"),
  39.     ;
  41.     private static final Map<String, WeekEnum> CODE_ROLE_MAP = new HashMap<>();
  43.     private static final Map<String, WeekEnum> NAME_ROLE_MAP = new HashMap<>();
  45.     static {
  47.         for (WeekEnum type : WeekEnum.values()) {
  49.             NAME_ROLE_MAP.put(type.name, type);
  50.             CODE_ROLE_MAP.put(type.code, type);
  51.         }
  52.     }
  54.     private final String name;
  56.     private final String code;
  58.     WeekEnum(final String name, final String code) {
  60.         this.name = name;
  61.         this.code = code;
  62.     }
  64.     /**
  65.      * to WeekEnum by code.
  66.      *
  67.      * @param code code
  68.      * @return WeekEnum
  69.      */
  70.     public static WeekEnum codeOf(final String code) {
  72.         if (StringUtils.isBlank(code)) {
  74.             return Sunday;
  75.         }
  76.         WeekEnum matchType = CODE_ROLE_MAP.get(code);
  77.         return Objects.isNull(matchType) ? Sunday : matchType;
  78.     }
  80.     /**
  81.      * to WeekEnum by name.
  82.      *
  83.      * @param name name
  84.      * @return WeekEnum
  85.      */
  86.     public static WeekEnum nameOf(final String name) {
  88.         if (Strings.isNullOrEmpty(name)) {
  90.             return Sunday;
  91.         }
  92.         WeekEnum matchType = NAME_ROLE_MAP.get(name);
  93.         return Objects.isNull(matchType) ? Sunday : matchType;
  94.     }

cron表达式模板常量：

  1. /**
  2.  * cron表达式模板
  3.  *
  4.  * @author zhurunhua
  5.  * @since 2022/10/24 11:50
  6.  */
  7. public interface CronPatternConstant {
  9.     /**
  10.      * 执行单次cron表达式模板
  11.      * eg: 59 59 23 1 12 ? 2022 (2022-12-01 23:59:59执行一次)
  12.      */
  13.     String ONCE_CRON_PATTERN = "%s %s %s %s %s ? %s";
  14.     /**
  15.      * 每天执行cron表达式模板
  16.      * eg: 59 59 23 * * ? (每日23:59:59执行)
  17.      */
  18.     String DAILY_CRON_PATTERN = "%s %s %s * * ?";
  19.     /**
  20.      * 每周执行cron表达式模板
  21.      * eg: 59 59 23 ? * Fri (每周五23:59:59执行)
  22.      */
  23.     String WEEKLY_CRON_PATTERN = "%s %s %s ? * %s";
  24.     /**
  25.      * 每月执行cron表达式模板
  26.      * eg: 59 59 23 8 * ? (每月8号23:59:59执行)
  27.      */
  28.     String MONTHLY_CRON_PATTERN = "%s %s %s %s * ?";
  29. }

工具类

  1. /**
  2.  * Cron表达式工具类
  3.  *
  4.  * @author zhurunhua
  5.  * @since 2022/10/24 11:46
  6.  */
  7. @Slf4j
  8. public enum GenerateCronUtil {
  10.     /**
  11.      * 单例
  12.      */
  13.     INSTANCE;
  15.     private final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  16.     private final SimpleDateFormat weekFormat = new SimpleDateFormat("E");
  18.     /**
  19.      * 根据执行周期和初次执行时间，生成cron表达式
  20.      *
  21.      * @param period    执行周期
  22.      * @param beginTime 初次执行时间
  23.      * @return cron表达式
  24.      */
  25.     public String generateCronByPeriodAndTime(PeriodEnum period, String beginTime) {
  27.         Date parsedDate;
  28.         try {
  30.             parsedDate = dateFormat.parse(beginTime);
  31.         } catch (ParseException e) {
  33.             log.error("parse time error. [time]: {}", beginTime);
  34.             return "";
  35.         }
  36.         String[] dateAndTime = beginTime.split(" ");
  37.         String date = dateAndTime[0];
  38.         String time = dateAndTime[1];
  39.         String[] splitDate = date.split("-");
  40.         String year = splitDate[0];
  41.         String month = splitDate[1];
  42.         String day = splitDate[2];
  43.         String[] splitTime = time.split(":");
  44.         String hour = splitTime[0];
  45.         String minute = splitTime[1];
  46.         String second = splitTime[2];
  47.         String cron = "";
  48.         switch (period) {
  50.             case ONCE:
  51.                 cron = String.format(CronPatternConstant.ONCE_CRON_PATTERN, second, minute, hour, day, month, year);
  52.                 break;
  53.             case DAILY:
  54.                 cron = String.format(CronPatternConstant.DAILY_CRON_PATTERN, second, minute, hour);
  55.                 break;
  56.             case WEEKLY:
  57.                 String week = weekFormat.format(parsedDate);
  58.                 String weekCode = WeekEnum.nameOf(week).getCode();
  59.                 cron = String.format(CronPatternConstant.WEEKLY_CRON_PATTERN, second, minute, hour, weekCode);
  60.                 break;
  61.             case MONTHLY:
  62.                 cron = String.format(CronPatternConstant.MONTHLY_CRON_PATTERN, second, minute, hour, day);
  63.                 break;
  64.             default:
  65.                 break;
  66.         }
  67.         return cron;
  68.     }
  69. }

测试

  1. public class Test {
  3.     public static void main(String[] args) throws ParseException {
  5.         String time = "2022-12-01 12:00:00";
  6.         String onceCron = GenerateCronUtil.INSTANCE.generateCronByPeriodAndTime(PeriodEnum.ONCE, time);
  7.         String dailyCron = GenerateCronUtil.INSTANCE.generateCronByPeriodAndTime(PeriodEnum.DAILY, time);
  8.         String weeklyCron = GenerateCronUtil.INSTANCE.generateCronByPeriodAndTime(PeriodEnum.WEEKLY, time);
  9.         String monthlyCron = GenerateCronUtil.INSTANCE.generateCronByPeriodAndTime(PeriodEnum.MONTHLY, time);
  10.         System.out.println("单次执行cron：" + onceCron);
  11.         System.out.println("每天执行cron：" + dailyCron);
  12.         System.out.println("每周执行cron：" + weeklyCron);
  13.         System.out.println("每月执行cron：" + monthlyCron);
  14.     }
  15. }

输出：

  1. 单次执行cron：00 00 12 01 12 ? 2022
  2. 每天执行cron：00 00 12 * * ?
  3. 每周执行cron：00 00 12 ? * Thu
  4. 每月执行cron：00 00 12 01 * ?

发表评论

表情：
评论列表 （有 0 条评论，116人围观）

还没有评论，来说两句吧...

相关阅读