IT评测·应用市场-qidao123.com技术社区

标题: 定时任务Cron表达式工具类Cron Util [打印本页]

---

作者: 农民    时间: 2025-4-20 11:11
标题: 定时任务Cron表达式工具类Cron Util
依赖

cron-utils的github地点：https://github.com/jmrozanec/cron-utils

1. <dependency>
2.     <groupId>com.cronutils</groupId>
3.     <artifactId>cron-utils</artifactId>
4.     <version>9.2.1</version>
5. </dependency>

复制代码

基本使用

定义cron表达式的支持范围

1. // 创建cron定义，自定义cron表达式支持的范围
2. CronDefinition cronDefinition =
3.     CronDefinitionBuilder.defineCron()
4.         .withSeconds().and()
5.         .withMinutes().and()
6.         .withHours().and()
7.         .withDayOfMonth()
8.             .supportsHash().supportsL().supportsW().and()
9.         .withMonth().and()
10.         .withDayOfWeek()
11.             .withIntMapping(7, 0)
12.             .supportsHash().supportsL().supportsW().and()
13.         .withYear().optional().and()
14.         .instance();
16. // 传入要生成的cron表达式类型获取cron定义
17. cronDefinition = CronDefinitionBuilder.instanceDefinitionFor(CronType.QUARTZ);

复制代码

支持定时任务的类型：

• CRON4J
  
• QUARTZ
  
• UNIX
  
• SPRING
  
• SPRING53
  

天生cron表达式

1. import static com.cronutils.model.field.expression.FieldExpressionFactory.*;
3. Cron cron = CronBuilder.cron(CronDefinitionBuilder.instanceDefinitionFor(CronType.QUARTZ))
4.     .withYear(always())
5.     .withDoM(between(SpecialChar.L, 3))
6.     .withMonth(always())
7.     .withDoW(questionMark())
8.     .withHour(always())
9.     .withMinute(always())
10.     .withSecond(on(0))
11.     .instance();
13. String cronAsString = cron.asString(); // 0 * * L-3 * ? *

复制代码

各方法对应cron表达式关系：

• always：表现*
  
• questionMark：表现?
  
• on：表现具体值
  
• between：表现-，比方，between(0,5)表现0-5
  
• and：表现,，比方，and(on(1),on(5))表现0,5
  
• every：表现/，比方，every(on(2),3)表现2/3
  

获取cron表达式描述

1. public class Test {
3.     public static void main(String[] args) {
4.         // 创建cron描述器
5.         CronDescriptor descriptor = CronDescriptor.instance();
6.         // 创建cron定义
7.         CronDefinition cronDefinition = CronDefinitionBuilder.instanceDefinitionFor(QUARTZ);
8.         // 创建cron解析器
9.         CronParser cronParser = new CronParser(cronDefinition);
10.         String describe = descriptor.describe(cronParser.parse("0 0 12 ? * 6"));
11.         System.out.println(describe);
12.         describe = descriptor.describe(cronParser.parse("*/45 * * * * ?"));
13.         System.out.println(describe);
14.         
15.         // 设置语言
16.                 descriptor = CronDescriptor.instance(Locale.CHINESE);
17.         describe = descriptor.describe(cronParser.parse("0 0 12 ? * 6"));
18.         System.out.println(describe);
19.         describe = descriptor.describe(cronParser.parse("*/45 * * * * ?"));
20.         System.out.println(describe);
21.     }
22. }

复制代码

1. // 运行结果：
2. at 12:00 at Friday day
3. every 45 seconds
4. 在 12:00 在 星期五 天
5. 每 45 秒

复制代码

校验cron表达式的精确性

1. public class Test {
3.     public static void main(String[] args) {
4.         CronDefinition cronDefinition = CronDefinitionBuilder.instanceDefinitionFor(QUARTZ);
5.         CronParser cronParser = new CronParser(cronDefinition);
6.         Cron cron = cronParser.parse("0 0 12 ? * 6");
7.         // 校验cron表达式
8.         cron.validate();
9.         cron = cronParser.parse("0 0 12 ? * ?");
10.         cron.validate();
11.     }
12. }

复制代码

工具类

WeekEnum

定义星期的罗列类信息

1. @Getter
2. @AllArgsConstructor
3. public enum WeekEnum {
5.     SUNDAY(1, "星期天"),
6.     MONDAY(2, "星期一"),
7.     TUESDAY(3, "星期二"),
8.     WEDNESDAY(4, "星期三"),
9.     THURSDAY(5, "星期四"),
10.     FRIDAY(6, "星期五"),
11.     SATURDAY(7, "星期六");
13.     private Integer code;
15.     private String desc;
16. }

复制代码

CycleTypeEnum

定义要天生的cron表达式类型罗列类信息

1. @Getter
2. @AllArgsConstructor
3. public enum CycleTypeEnum {
5.     MINUTE(1, "分钟"),
6.     HOUR(2, "小时"),
7.     DAY(3, "日"),
8.     WEEK(4, "周"),
9.     MONTH(5, "月"),
10.     QUARTER(6, "季度"),
11.     YEAR(7, "年");
13.     private Integer code;
15.     private String desc;
16. }

复制代码

RepeatRuleEnum

定义要天生月、季度的cron表达式循环规则罗列类信息

1. @Getter
2. @AllArgsConstructor
3. public enum RepeatRuleEnum {
5.     WEEK(1, "周"),
6.     DATE(2, "日期");
8.     private Integer code;
10.     private String desc;
11. }

复制代码

CronDto

定义cron表达式工具类的请求体信息

1. @Data
2. public class CronDto {
4.     /**
5.      * 周期类型 minute:分钟 hour: 小时; day: 天; week: 周; month: 月; quarter: 季; year: 年
6.      */
7.     private Integer cycleType;
9.     /**
10.      * 执行时间
11.      */
12.     private LocalDateTime executionTime;
14.     /**
15.      * 指定一周哪几天
16.      */
17.     private List<Integer> weekDays;
19.     /**
20.      * 指定一个月哪几天
21.      */
22.     private List<Integer> monthDays;
24.     /**
25.      * 指定一年哪几月
26.      */
27.     private List<Integer> quartzMonths;
29.     /**
30.      * 一周的星期几
31.      */
32.     private Integer dayOfWeek;
34.     /**
35.      * 第几周
36.      */
37.     private Integer week;
39.     /**
40.      * 重复规则：周 天
41.      */
42.     private Integer repeatRule;
43. }

复制代码

CronUtils

根据年、月、日、时、分、秒、星期、季度实现不同的cron表达式
注意：天生年、月、季度的cron表达式时可以根据日或者星期额外判定

1. public class CronUtils {
3.     /**
4.      * 星期
5.      */
6.     private static final List<Integer> WEEKS = Arrays.stream(WeekEnum.values()).map(WeekEnum::getCode).collect(Collectors.toList());
8.     public static String createCron(CronDto cronDto) {
9.         Integer cycleType = cronDto.getCycleType();
10.         LocalDateTime executionTime = cronDto.getExecutionTime();
11.         CronBuilder cronBuilder = CronBuilder.cron(CronDefinitionBuilder.instanceDefinitionFor(CronType.QUARTZ));
12.         // 每分钟一次
13.         if (Objects.equals(CycleTypeEnum.MINUTE.getCode(), cycleType)) {
14.             return getSecondCron(cronBuilder, executionTime);
15.         }
16.         // 每小时一次
17.         if (Objects.equals(CycleTypeEnum.HOUR.getCode(), cycleType)) {
18.             return getMinuteCron(cronBuilder, executionTime);
19.         }
20.         // 每日一次
21.         if (Objects.equals(CycleTypeEnum.DAY.getCode(), cycleType)) {
22.             return getDayCron(cronBuilder, executionTime);
23.         }
24.         // 每周一次
25.         if (Objects.equals(CycleTypeEnum.WEEK.getCode(), cycleType)) {
26.             return getWeekCron(cronDto, cronBuilder, executionTime);
27.         }
28.         // 每月一次
29.         if (Objects.equals(CycleTypeEnum.MONTH.getCode(), cycleType)) {
30.             return getMonthCron(cronDto, cronBuilder, executionTime);
31.         }
32.         // 每季度一次
33.         if (Objects.equals(CycleTypeEnum.QUARTER.getCode(), cycleType)) {
34.             return getQuarterCron(cronDto, cronBuilder, executionTime);
35.         }
36.         // 每年一次
37.         if (Objects.equals(CycleTypeEnum.YEAR.getCode(), cycleType)) {
38.             return getYearCron(cronBuilder, executionTime);
39.         }
40.         return "";
41.     }
43.     public static String getYearCron(CronBuilder cronBuilder, LocalDateTime executionTime) {
44.         return cronBuilder.withSecond(on(executionTime.getSecond()))
45.                 .withMinute(on(executionTime.getMinute()))
46.                 .withHour(on(executionTime.getHour()))
47.                 .withDoM(on(executionTime.getDayOfMonth()))
48.                 .withMonth(on(executionTime.getMonthValue()))
49.                 .withDoW(questionMark())
50.                 .instance()
51.                 .asString();
52.     }
54.     public static String getQuarterCron(CronDto cronDto, CronBuilder cronBuilder, LocalDateTime executionTime) {
55.         List<FieldExpression> flist = new ArrayList<>();
56.         cronDto.getQuartzMonths().forEach(e -> flist.add(FieldExpressionFactory.on(e)));
57.         return cronBuilder.withSecond(on(executionTime.getSecond()))
58.                 .withMinute(on(executionTime.getMinute()))
59.                 .withHour(on(executionTime.getHour()))
60.                 .withDoM(questionMark())
61.                 .withMonth(and(flist))
62.                 .withDoW(on(WEEKS.get(cronDto.getDayOfWeek()), SpecialChar.HASH, cronDto.getWeek()))
63.                 .instance()
64.                 .asString();
65.     }
67.     public static String getMonthCron(CronDto cronDto, CronBuilder cronBuilder, LocalDateTime executionTime) {
68.         Integer repeatRule = cronDto.getRepeatRule();
69.         // 按周
70.         if (Objects.equals(RepeatRuleEnum.WEEK.getCode(), repeatRule)) {
71.             List<FieldExpression> weekDays = new ArrayList<>();
72.             if (!CollectionUtils.isEmpty(cronDto.getWeekDays())) {
73.                 cronDto.getWeekDays().forEach(e -> weekDays.add(FieldExpressionFactory.on(WEEKS.get(cronDto.getDayOfWeek()),
74.                         SpecialChar.HASH, e)));
75.             }
76.             return cronBuilder.withSecond(on(executionTime.getSecond()))
77.                     .withMinute(on(executionTime.getMinute()))
78.                     .withHour(on(executionTime.getHour()))
79.                     .withDoM(questionMark())
80.                     .withMonth(always())
81.                     .withDoW(CollectionUtils.isEmpty(weekDays) ? on(WEEKS.get(cronDto.getDayOfWeek()), SpecialChar.HASH,
82.                             cronDto.getWeek()) : and(weekDays))
83.                     .instance()
84.                     .asString();
86.         }
87.         // 按天
88.         if (Objects.equals(RepeatRuleEnum.DATE.getCode(), repeatRule)) {
89.             List<FieldExpression> monthDays = new ArrayList<>();
90.             cronDto.getMonthDays().forEach(e -> monthDays.add(FieldExpressionFactory.on(e)));
91.             return cronBuilder.withSecond(on(executionTime.getSecond()))
92.                     .withMinute(on(executionTime.getMinute()))
93.                     .withHour(on(executionTime.getHour()))
94.                     .withDoM(and(monthDays))
95.                     .withMonth(always())
96.                     .withDoW(questionMark())
97.                     .instance()
98.                     .asString();
99.         }
100.         return "";
101.     }
103.     public static String getWeekCron(CronDto cronDto, CronBuilder cronBuilder, LocalDateTime executionTime) {
104.         List<FieldExpression> weekDays = new ArrayList<>();
105.         cronDto.getWeekDays().forEach(e -> weekDays.add(FieldExpressionFactory.on(e)));
106.         return cronBuilder.withSecond(on(executionTime.getSecond()))
107.                 .withMinute(on(executionTime.getMinute()))
108.                 .withHour(on(executionTime.getHour()))
109.                 .withDoM(questionMark())
110.                 .withMonth(always())
111.                 .withDoW(and(weekDays))
112.                 .instance()
113.                 .asString();
114.     }
116.     public static String getDayCron(CronBuilder cronBuilder, LocalDateTime executionTime) {
117.         return cronBuilder.withSecond(on(executionTime.getSecond()))
118.                 .withMinute(on(executionTime.getMinute()))
119.                 .withHour(on(executionTime.getHour()))
120.                 .withDoM(always())
121.                 .withMonth(always())
122.                 .withDoW(questionMark())
123.                 .instance()
124.                 .asString();
125.     }
127.     public static String getMinuteCron(CronBuilder cronBuilder, LocalDateTime executionTime) {
128.         return cronBuilder.withSecond(on(executionTime.getSecond()))
129.                 .withMinute(on(executionTime.getMinute()))
130.                 .withHour(always())
131.                 .withDoM(always())
132.                 .withMonth(always())
133.                 .withDoW(questionMark())
134.                 .instance()
135.                 .asString();
136.     }
138.     public static String getSecondCron(CronBuilder cronBuilder, LocalDateTime executionTime) {
139.         return cronBuilder.withSecond(on(executionTime.getSecond()))
140.                 .withMinute(always())
141.                 .withHour(always())
142.                 .withDoM(always())
143.                 .withMonth(always())
144.                 .withDoW(questionMark())
145.                 .instance()
146.                 .asString();
147.     }
148. }

复制代码

使用案例

1. public class Test {
2.     public static void main(String[] args) {
3.         CronDto cronDto = new CronDto();
4.         cronDto.setCycleType(1);
5.         cronDto.setExecutionTime(LocalDateTime.now());
6.         String cron = createCron(cronDto);
7.         System.out.println(cron);
9.         cronDto.setCycleType(2);
10.         cron = createCron(cronDto);
11.         System.out.println(cron);
13.         cronDto.setCycleType(3);
14.         cron = createCron(cronDto);
15.         System.out.println(cron);
17.         cronDto.setCycleType(4);
18.         cronDto.setWeekDays(Arrays.asList(1, 2));
19.         cron = createCron(cronDto);
20.         System.out.println(cron);
22.         cronDto.setCycleType(5);
23.         cronDto.setRepeatRule(1);
24.         cronDto.setDayOfWeek(1);
25.         cron = createCron(cronDto);
26.         System.out.println(cron);
28.         cronDto.setCycleType(5);
29.         cronDto.setRepeatRule(1);
30.         cronDto.setWeek(1);
31.         cronDto.setDayOfWeek(1);
32.         cronDto.setWeekDays(null);
33.         cron = createCron(cronDto);
34.         System.out.println(cron);
36.         cronDto.setCycleType(5);
37.         cronDto.setRepeatRule(2);
38.         cronDto.setMonthDays(Arrays.asList(1, 2));
39.         cron = createCron(cronDto);
40.         System.out.println(cron);
42.         cronDto.setCycleType(6);
43.         cronDto.setQuartzMonths(Arrays.asList(1, 2));
44.         cron = createCron(cronDto);
45.         System.out.println(cron);
47.         cronDto.setCycleType(7);
48.         cron = createCron(cronDto);
49.         System.out.println(cron);
50.     }
51. }

复制代码

1. // 运行结果：
2. 14 * * * * ?
3. 14 28 * * * ?
4. 14 28 9 * * ?
5. 14 28 9 ? * 1,2
6. 14 28 9 ? * 2#1,2#2
7. 14 28 9 ? * 2#1
8. 14 28 9 1,2 * ?
9. 14 28 9 ? 1,2 2#1
10. 14 28 9 19 11 ?

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

---

欢迎光临 IT评测·应用市场-qidao123.com技术社区 (https://dis.qidao123.com/)

Powered by Discuz! X3.4