目录
- 前言
- 介绍
- 一 cron的结构
- 二 各域的含义
- 三 常用cron表达式
- 实例
- 1 后台添加定时任务处理类
- 2 前端新建定时任务信息
- 3 点击执行一次
- 4 启动定时任务
前言
在实际项目开发中Web应用有一类不可缺少的,那就是定时任务。 定时任务的场景可以说非常广泛,比如某些视频网站,购买会员后,每天会给会员送成长值,每月会给会员送一些电影券; 比如在保证最终一致性的场景中,往往利用定时任务调度进行一些比对工作;比如一些定时需要生成的报表、邮件;比如一些需要定时清理数据的任务等。定时任务在我们软件开发中应用得实在太广泛了,下面就让我们来一起学习学习。
介绍
一 cron的结构
Cron表达式是一个字符串,以5个或6个空格隔开,分为6个或7个域,每一个域代表一个含义,Cron有如下两种语法格式:
- 七个域
Seconds Minutes Hours DayOfMonth Month DayOfWeek Year
即corn从左到右(用空格隔开):秒 分 小时 月份中的日期 月份 星期中的日期 年份
- 六个域
Seconds Minutes Hours DayOfMonth Month DayOfWeek
即corn从左到右(用空格隔开):秒 分 小时 月份中的日期 月份 星期中的日期
二 各域的含义
域 | 允许值 | 允许的特殊字符 |
---|---|---|
秒(Seconds) | 0~59的整数 | , - * / 四个字符 |
分(Minutes) | 0~59的整数 | , - * / 四个字符 |
0~59的整数 | 0~23的整数 | , - * / 四个字符 |
日期(DayOfMonth) | 1~31的整数(但是你需要考虑你月的天数) | ,- * ? / L W C 八个字符 |
月份(Month) | 1~12的整数或者 JAN-DEC | , - * / 四个字符 |
星期(DayOfWeek) | 1~7的整数或者 SUN-SAT (1=SUN) | , - * ? / L C # 八个字符 |
年(可选,留空)(Year) | 1970~2099 | , - * / 四个字符 |
每一个域都能使用数字,但还可以出现如下特殊字符,允许的特殊字符含义如下:
特殊字符 | 含义 |
---|---|
* | 表示匹配该域的任意值。假如在Minutes域使用*, 即表示每分钟都会触发事件 |
? | 只能用在DayOfMonth和DayOfWeek两个域。也匹配域的任意值,但实际不会。因为DayOfMonth和DayOfWeek会相互影响。例如想在每月的20日下午15点触发定时任务,不管20日到底是星期几,则只能使用如下写法: 0 0 15 20 * ?, 其中最后一位只能用?,而不能使用*,如果使用*表示不管星期几都会触发,实际上并不是这样。 |
- | 表示范围。例如在Minutes域使用5-20,表示从5分到20分钟每分钟触发一次 |
/ | 表示起始时间开始触发,然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着从第5分钟开始触发一次后每隔20分钟触发即25,45等分别触发一次. |
, | 表示列出枚举值。例如:在Minutes域使用5,20,则意味着在5和20分每个时间点触发一次。 |
L | 英文单词Last的首字母表示最后,只能出现在DayOfWeek和DayOfMonth域。如果在DayOfWeek域使用5L,意味着在最后的一个星期四触发。如果在DayOfMonth域使用5L 表达倒数第5天触发。 |
W | 英文Workday的首字母,表示有效工作日(周一到周五),只能出现在DayOfMonth域,系统将在离指定日期的最近的有效工作日触发事件。例如:在 DayOfMonth使用5W,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日(周一)触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份 。 |
LW | 这两个字符可以连用,表示在某个月最后一个工作日。 |
# | 用于确定每个月第几个星期几,只能出现在DayOfWeek域。例如在4#2,表示某月的第二个星期三。 |
C | 该字符只在DayOfMonth域和DayOfWeek域中使用,英文Calendar的首字母。指和calendar关联后计算出来的值, 如果日期没有被关联,则相当于日历中所有日期。例如 5C 在日期字段中就相当于日历 5 日以后的第一天。 1C 在星期字段中相当于星期日后的第一天。该特殊字符很少用到,不理解也没有关系。 |
注意
cron 表达式对特殊字符的大小写不敏感,对代表星期的缩写英文大小写也不敏感。
三 常用cron表达式
表达式 | 说明 |
---|---|
0 0 2 1 * ? * | 表示在每月的1日的凌晨2点调整任务 |
0 15 10 ? * MON-FRI | 表示周一到周五每天上午10:15执行作业 |
0 15 10 ? * 6L 2002-2006 | 表示2002-2006年的每个月的最后一个星期五上午10:15执行作业 |
0 0 10,14,16 * * ? | 每天上午10点,下午2点,4点执行 |
0 0/30 9-17 * * ? | 朝九晚五工作时间内每半小时 |
0 0 12 ? * WED | 表示每个星期三中午12点 |
0 0 12 * * ? | 每天中午12点触发 |
0 15 10 ? * * | 每天上午10:15触发 |
0 15 10 * * ? | 每天上午10:15触发 |
0 15 10 * * ? * | 每天上午10:15触发 |
0 15 10 * * ? 2005 | 2005年的每天上午10:15触发 |
0 * 14 * * ? | 在每天下午2点到下午2:59期间的每1分钟触发 |
0 0/5 14 * * ? | 在每天下午2点到下午2:55期间的每5分钟触发 |
0 0/5 14,18 * * ? | 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发 |
0 0-5 14 * * ? | 在每天下午2点到下午2:05期间的每1分钟触发 |
0 10,44 14 ? 3 WED | 每年三月的星期三的下午2:10和2:44触发 |
0 15 10 ? * MON-FRI | 周一至周五的上午10:15触发 |
0 15 10 15 * ? | 每月15日上午10:15触发 |
0 15 10 L * ? | 每月最后一日的上午10:15触发 |
0 15 10 ? * 6L | 每月的最后一个星期五上午10:15触发 |
0 15 10 ? * 6L 2002-2005 | 2002年至2005年的每月的最后一个星期五上午10:15触发 |
0 15 10 ? * 6#3 | 每月的第三个星期五上午10:15触发 |
注意:
(1)有些子表达式能包含一些范围或列表
例如:子表达式(天(星期))可以为 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”,“”字符代表所有可能的值。
因此,“”在子表达式(月)里表示每个月的含义,“*”在子表达式(天(星期))表示星期的每一天。
(2)“/”字符用来指定数值的增量
例如:在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟。
在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样。
(3)“?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值
当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”。
(4)“L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写,但是它在两个子表达式里的含义是不同的。
在天(月)子表达式中,“L”表示一个月的最后一天。
在天(星期)自表达式中,“L”表示一个星期的最后一天,也就是SAT。
如果在“L”前有具体的内容,它就具有其他的含义了。
例如:“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五。
注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题。
实例
若依后台动态管理定时任务
1 后台添加定时任务处理类
支持Bean调用、Class类调用
MyTask.java
/*** @Description* @Author liql* @DateTime 2024-06-04 10:54* @Version 1.0*/
@Component("myTask")
public class MyTask {public void ryMultipleParams(String s, Boolean b){if(b){System.out.println(StringUtils.format("执行多参方法: 字符串类型{},布尔类型{}", s, b));}else {System.out.println("不会打印参数");}}public void ryParams(String params){System.out.println("执行有参方法,参数:" + params);}public void ryNoParams(){System.out.println("执行无参方法-------------------------------------");}
}
2 前端新建定时任务信息
系统监控 -> 定时任务->新增
点击新增的弹窗台下
- 任务名称:自定义,如:定时查询任务状态
- 任务分组:根据字典sys_job_group配置
- 调用目标字符串:设置后台任务方法名称参数
Bean调用示例:
需要添加对应Bean注解@Component或@Service。调用目标字符串: ryTask.ryParams(‘ry’)
Class类调用示例:
添加类和方法指定包即可。调用目标字符串:com.ruoyi.quartz.task.RyTask.ryParams(‘ry’)
方法参数详解:
字符串(需要单引号’'标识 如:ryTask.ryParams(’ry’))
布尔类型(需要true false标识 如:ryTask.ryParams(true))
长整型(需要L标识 如:ryTask.ryParams(2000L))
浮点型(需要D标识 如:ryTask.ryParams(316.50D))
整型(纯数字即可)
-
执行表达式:可查询官方cron表达式介绍
输入:2/5 * * ? * *
表示:从第二秒钟开始触发,每隔5秒触发一次。 -
执行策略:定时任务自定义执行策略
立即执行(所有misfire的任务会马上执行)打个比方,如果9点misfire了,在10:15系统恢复之后,9点,10点的misfire会马上执行
执行一次(会合并部分的misfire,正常执行下一个周期的任务)假设9,10的任务都misfire了,系统在10:15分起来了。只会执行一次misfire,下次正点执行。
放弃执行(所有的misfire不管,执行下一个周期的任务)
- 并发执行:是否需要多个任务间同时执行
- 备注:定时任务描述信息
3 点击执行一次
测试定时任务是否正常及调度日志是否正确记录,如正常执行表示任务配置成功。