学习成长

提供在线文档,方便大家学习


SpringBoot----定时任务

<p>使用SpringBoot创建定时任务非常简单,目前主要有以下三种创建方式:</p> <p>一、基于注解(@Scheduled) 二、基于接口(SchedulingConfigurer) 前者相信大家都很熟悉,但是实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务,这时候基于接口的定时任务就派上用场了。 三、基于注解设定多线程定时任务</p> <p>我们的项目中采用第一种方式,基于注解@Scheduled来创建定时任务。</p> <p>@EnableScheduling //开启定时任务 启动类代码如下:</p> <pre><code class="language-java">package com.example.scheduleddemo; import org.springframework.boot.Banner; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.scheduling.annotation.EnableScheduling; @SpringBootApplication @EnableScheduling //开启定时任务 public class ScheduledDemoApplication { public static void main(String[] args) { new SpringApplicationBuilder(ScheduledDemoApplication.class).bannerMode(Banner.Mode.OFF).run(args); } }</code></pre> <p>@Scheduled //执行任务间隔设置 开启定时任务的注解:@EnableScheduling 为了方便,可以用在启动类上</p> <p>执行任务间隔设置的这个注解:@Scheduled 查看其源码,可以发现有这么几个参数:cron、zone、fixedDelay、fixedDelayString、fixedRate、fixedRateString、initialDelay、initialDelayString 用法分别如下:</p> <h4>1.cron参数详解:</h4> <p>该参数接收一个cron表达式,cron表达式是一个字符串,字符串以5或6个空格隔开,分开共6或7个域,每一个域代表一个含义。 按顺序依次为:</p> <pre><code>[秒] [分] [小时] [日] [月] [周] [年] 秒(0~59)|分钟(0~59)|小时(0~23)|天(月)(0~31,但是你需要考虑你月的天数)|月(0~11)|天(星期)(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)|年份(1970-2099)</code></pre> <table> <thead> <tr> <th>序号</th> <th>说明</th> <th>必填</th> <th>允许填写的值</th> <th>允许的通配符</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>秒</td> <td>是</td> <td>0-59</td> <td>, - * /</td> </tr> <tr> <td>2</td> <td>分</td> <td>是</td> <td>0-59</td> <td>, - * /</td> </tr> <tr> <td>3</td> <td>时</td> <td>是</td> <td>0-23</td> <td>, - * /</td> </tr> <tr> <td>4</td> <td>日</td> <td>是</td> <td>1-31</td> <td>, - * ? / L W</td> </tr> <tr> <td>5</td> <td>月</td> <td>是</td> <td>1-12 / JAN-DEC</td> <td>, - * /</td> </tr> <tr> <td>6</td> <td>周</td> <td>是</td> <td>1-7 or SUN-SAT</td> <td>, - * ? / L #</td> </tr> <tr> <td>7</td> <td>年</td> <td>否</td> <td>1970-2099</td> <td>, - * /</td> </tr> </tbody> </table> <p>通配符说明:</p> <p>1.<em> 表示所有值。 例如:在分的字段上设置 </em>,表示每一分钟都会触发。 2.? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作,但不关心是周几,所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ? 3.- 表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。 4., 表示指定多个值,例如在周字段上设置 “MON,WED,FRI” 表示周一,周三和周五触发 5./ 用于递增触发。如在秒上面设置”5/15” 表示从5秒开始,每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始,每隔三天触发一次。 6.L 表示最后的意思。在日字段设置上,表示当月的最后一天(依据当前月份,如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六,相当于”7”或”SAT”。如果在”L”前加上数字,则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五” 7.W 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上置”15W”,表示离每月15号最近的那个工作日触发。如果15号正好是周六,则找最近的周五(14号)触发, 如果15号是周未,则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五),则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六,则将在3号下周一触发。(注,”W”前只能设置具体的数字,不允许区间”-“)。 8.序号(表示每月的第几个周几),例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六,则不会触发该配置(用在母亲节和父亲节再合适不过了) ;小提示:’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发;周字段的设置,若使用英文字母是不区分大小写的,即MON与mon相同。</p> <p>示例:</p> <pre><code>每隔5秒执行一次:*/5 * * * * ? 每隔1分钟执行一次:0 */1 * * * ? 每天23点执行一次:0 0 23 * * ? 每天凌晨1点执行一次:0 0 1 * * ? 每月1号凌晨1点执行一次:0 0 1 1 * ? 每月最后一天23点执行一次:0 0 23 L * ? 每周星期天凌晨1点实行一次:0 0 1 ? * L 在26分、29分、33分执行一次:0 26,29,33 * * * ? 每天的0点、13点、18点、21点都执行一次:0 0 0,13,18,21 * * ?</code></pre> <p>cron表达式使用占位符</p> <p>另外,cron属性接收的cron表达式支持占位符。eg:</p> <p>配置文件:</p> <pre><code class="language-java">time: cron: */5 * * * * * interval: 5</code></pre> <p>注解使用范例:</p> <pre><code class="language-java">@Scheduled(cron="${time.cron}") @Scheduled(cron="*/${time.interval} * * * * *")</code></pre> <p>具体代码示例:</p> <pre><code class="language-java"> /** *每隔5秒钟执行一次 */ @Scheduled(cron = "*/5 * * * * *") public void cronWork(){ String format = sdf.format(new Date()); System.err.println("执行时间是:"+format); }</code></pre> <p>执行结果:</p> <pre><code class="language-java">执行时间是:2020-08-04 17:25:35 执行时间是:2020-08-04 17:25:40 执行时间是:2020-08-04 17:25:45 执行时间是:2020-08-04 17:25:50 执行时间是:2020-08-04 17:25:55</code></pre> <h4>2.zone参数详解:</h4> <p>时区,接收一个java.util.TimeZone#ID。cron表达式会基于该时区解析。默认是一个空字符串,即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai。该字段我们一般留空。</p> <h4>3.fixedDelay、fixedDelayString参数详解:</h4> <p>这两个参数意思是相同的,都是表示:上一次执行完毕时间点之后多长时间再执行,区别是:后者支持占位符。 用法如下:</p> <p>没有采用配置文件的注解使用范例:</p> <pre><code class="language-java">@Scheduled(fixedDelay = 1000) //上一次执行完毕时间点之后1秒再执行 @Scheduled(fixedDelayString = "1000") //上一次执行完毕时间点之后1秒再执行</code></pre> <p>具体代码示例:</p> <pre><code class="language-java"> /** * 上一次执行完毕时间点之后5秒再执行 */ @Scheduled(fixedDelay = 5000) public void fixedDelayWork(){ System.out.println("--------fixedDelayWork任务开始执行-------"); String format = sdf.format(new Date()); System.out.println("fixedDelayWork任务执行完毕时间是:"+format); }</code></pre> <p>执行结果:</p> <pre><code class="language-java">--------fixedDelayWork任务开始执行------- fixedDelayWork任务执行完毕时间是:2020-08-04 17:39:51 --------fixedDelayWork任务开始执行------- fixedDelayWork任务执行完毕时间是:2020-08-04 17:39:56 --------fixedDelayWork任务开始执行------- fixedDelayWork任务执行完毕时间是:2020-08-04 17:40:01 --------fixedDelayWork任务开始执行------- fixedDelayWork任务执行完毕时间是:2020-08-04 17:40:06</code></pre> <p>配置文件:</p> <pre><code class="language-java">time.fixedDelay=1000</code></pre> <p>引用配置的注解使用范例:</p> <pre><code class="language-java">@Scheduled(fixedDelayString = "${time.fixedDelay}")</code></pre> <h4>4.fixedRate、fixedRateString参数详解:</h4> <p>这两个参数意思是相同的,都是表示:上一次开始执行时间点之后多长时间再执行,区别是:后者支持占位符。 用法如下:</p> <p>没有引用配置的注解使用范例:</p> <pre><code class="language-java">@Scheduled(fixedRate = 1000) //上一次开始执行时间点之后1秒再执行 @Scheduled(fixedRateString = "1000") //上一次开始执行时间点之后1秒再执行</code></pre> <p>具体代码示例:</p> <pre><code class="language-java">/** * 上一次开始执行时间点之后5秒再执行 */ @Scheduled(fixedRate = 5000) public void fixedRateWork(){ String format = sdf.format(new Date()); System.out.println("--------fixedRateWork任务开始执行时间是-------"+format); }</code></pre> <p>执行结果:</p> <pre><code class="language-java">--------fixedRateWork任务开始执行时间是-------2020-08-04 17:45:23 --------fixedRateWork任务开始执行时间是-------2020-08-04 17:45:28 --------fixedRateWork任务开始执行时间是-------2020-08-04 17:45:33 --------fixedRateWork任务开始执行时间是-------2020-08-04 17:45:38</code></pre> <p>配置文件:</p> <pre><code class="language-java">time.fixedDelay=1000</code></pre> <p>引用配置的注解使用范例:</p> <pre><code class="language-java">@Scheduled(fixedRateString = "${time.fixedDelay}")</code></pre> <p>复制代码</p> <h4>5.initialDelay、initialDelayString参数详解:</h4> <p>这两个参数意思是相同的,都是表示:第一次延迟多长时间后再执行,区别是:后者支持占位符。 用法如下:</p> <p>引用配置的注解使用范例:</p> <pre><code class="language-java">@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行,之后按fixedRate的规则每5秒执行一次</code></pre> <p>详细代码如下:(查看执行结果,每个任务单独运行即可)</p> <pre><code class="language-java">import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component; import java.text.SimpleDateFormat; import java.util.Date; /** * Created by IntelliJ IDEA * 这是一个神奇的Class * * @author zhz * @date 2020/8/4 16:58 */ @Component public class ScheduleJob { private final SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); /** * 每隔5秒钟执行一次 */ @Scheduled(cron = "*/5 * * * * *") public void cronWork1(){ String format = sdf.format(new Date()); System.err.println("cronWork1-----执行时间是:"+format); } @Scheduled(cron = "${time.cron}") public void cronWork2(){ String format = sdf.format(new Date()); System.err.println("cronWork2-----执行时间是:"+format); } /** * 上一次执行完毕时间点之后5秒再执行 */ @Scheduled(fixedDelay = 5000) public void fixedDelayWork(){ System.out.println("--------fixedDelayWork任务开始执行-------"); String format = sdf.format(new Date()); System.err.println("fixedDelayWork任务执行完毕时间是:"+format); } @Scheduled(fixedDelayString = "${time.fixedDelay}") public void fixedDelayStringWork(){ System.out.println("--------fixedDelayStringWork任务开始执行-------"); String format = sdf.format(new Date()); System.err.println("fixedDelayStringWork任务执行完毕时间是:"+format); } /** * 上一次开始执行时间点之后5秒再执行 */ @Scheduled(fixedRate = 5000) public void fixedRateWork(){ String format = sdf.format(new Date()); System.out.println("--------fixedRateWork任务开始执行时间是-------"+format); } @Scheduled(fixedRateString = "${time.fixedDelay}") public void fixedRateStringWork(){ String format = sdf.format(new Date()); System.out.println("--------fixedRateStringWork任务开始执行时间是-------"+format); } }</code></pre> <p>配置文件代码:</p> <pre><code class="language-java">spring.application.name=scheduled-demo server.port=8888 time.cron=*/5 * * * * * time.fixedDelay=5000</code></pre> <p>参见:<a href="https://www.cnblogs.com/wdzhz/p/13306891.html">https://www.cnblogs.com/wdzhz/p/13306891.html</a></p>

页面列表

ITEM_HTML