springboot学习之十八(定时任务Quartz)

1、Quartz简介
Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目，它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的程序。Jobs可以做成标准的Java组件或 EJBs。

1.1 Quartz的三大核心组件
调度器：Scheduler。
任务：JobDetail。
触发器：Trigger，包括 SimpleTrigger 和 CronTrigger。

（1）Job（任务）：是一个接口，有一个方法 void execute(JobExecutionContext context) ，可以通过实现该接口来定义需要执行的任务（具体的逻辑代码）。

JobDetail：Quartz每次执行Job时，都重新创建一个Job实例，会接收一个Job实现类，以便运行的时候通过newInstance()的反射调用机制去实例化Job。JobDetail是用来描述Job实现类以及相关静态信息，比如任务在scheduler中的组名等信息。

（2）Trigger（触发器）：描述触发Job执行的时间触发规则实现类SimpleTrigger和CronTrigger可以通过crom表达式定义出各种复杂的调度方案。

Calendar：是一些日历特定时间的集合。一个Trigger可以和多个 calendar关联，比如每周一早上10:00执行任务，法定假日不执行，则可以通过calendar进行定点排除。

（3）Scheduler（调度器）：代表一个Quartz的独立运行容器。Trigger和JobDetail可以注册到Scheduler中。Scheduler可以将Trigger绑定到某一JobDetail上，这样当Trigger被触发时，对应的Job就会执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job。

1.2 CronTrigger配置格式
格式：[秒] [分] [时] [日] [月] [周] [年]

序号	说明	是否必填	允许写的值	允许写的通配符
1	秒	是	0-59	- * /
2	分	是	0-59	- * /
3	时	是	0-23	- * /
4	日	是	1-31	- * ? / L W
5	月	是	1-12 or JAN-DEC	- * /
6	周	是	1-7 or SUN-SAT	- * ? / L #
7	年	否	empty 或 1970-2099	- * /

通配符说明:

* 表示所有值. 例如:在分的字段上设置 "*",表示每一分钟都会触发。

? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为"?" 具体设置为 0 0 0 10 * ?

- 表示区间。例如在小时上设置 "10-12",表示 10,11,12点都会触发。

, 表示指定多个值，例如在周字段上设置 "MON,WED,FRI" 表示周一，周三和周五触发

/ 用于递增触发。如在秒上面设置"5/15" 表示从5秒开始，每增15秒触发(5,20,35,50)。在月字段上设置'1/3'所示每月1号开始，每隔三天触发一次。

L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六，相当于"7"或"SAT"。如果在"L"前加上数字，则表示该数据的最后一个。例如在周字段上设置"6L"这样的格式,则表示“本月最后一个星期五"

W 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上设置"15W"，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 "1W",它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，"W"前只能设置具体的数字,不允许区间"-").

小提示：'L'和 'W'可以一组合使用。如果在日字段上设置"LW",则表示在本月的最后一个工作日触发（一般指发工资）。

# 序号(表示每月的第几个周几)，例如在周字段上设置"6#3"表示在每月的第三个周六.注意如果指定"#5",正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了)

小提示：周字段的设置，若使用英文字母是不区分大小写的 MON 与mon相同。

可通过在线生成Cron表达式的工具：http://cron.qqe2.com/ 来生成自己想要的表达式。

常用示例：

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分每分触发
0 0/5 14 * * ?   每天下午的 2点到2点59分(整点开始，每隔5分触发)
0 0/5 14,18 * * ?   每天下午的 2点到2点59分(整点开始，每隔5分触发)每天下午的 18点到18点59分(整点开始，每隔5分触发)
0 0-5 14 * * ?   每天下午的 2点到2点05分每分触发
0 10,44 14 ? 3 WED   3月分每周三下午的 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   每月的第三周的星期五开始触发
0 0 12 1/5 * ?   每月的第一个中午开始每隔5天触发一次
0 11 11 11 11 ?   每年的11月11号 11点11分触发(光棍节)

2. 简单的例子

2.1.依赖

        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
        </dependency>

2.2.实现任务接口（任务要处理的业务）

public class HelloJob  implements Job {
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("定时要处理的业务");
    }
}

2.3.然后写一个入口函数，用JobDetail包装一下Job实现类，写一个Trigger触发器(触发规则)，在用调度器Scheduler把任务和触发条件关联到一块，启动任务即可.

    public static void main(String[] args) throws SchedulerException {
        //1.调度器Scheduler
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

        //2.1 触发器Trigger
        Trigger trigger_sim = TriggerBuilder.newTrigger().withIdentity("trigger1","group1")
                .startNow() //触发开始时间
                //触发的详细规则：5秒钟执行一次，共执行10次
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5).withRepeatCount(10))
                .endAt(new GregorianCalendar(2023,07,26,16,11,11).getTime()) //结束时间
                .build();

        //2.2 触发器 cron表达式
        Trigger trigger_crom = TriggerBuilder.newTrigger().withIdentity("trigger1","group1")
                //cron表达式 (秒 分 时  日 月 周 年): 7月26号每两秒处理一次
                .withSchedule(CronScheduleBuilder.cronSchedule("*/2 * * 26 7 ?"))
                .build();


        //3.JobDetail
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job1","group1").build();

        //4.将JobDetail和Trigger增加到调度器中
        scheduler.scheduleJob(jobDetail,trigger_sim);

        //5.启动，调度器开始工作
        scheduler.start();

    }

其实结果会执行11次，最开始一次，再加任务10次.

三. SpringBoot整合Quartz框架

3.1依赖

<!-- SpringBoot 整合 Quartz 定时任务 -->
 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-quartz</artifactId>
 </dependency>

3.2 在启动类上添加注解：@EnableScheduling

3.3设置执行时间

定义两个任务，分别设置执行时间，在方法上添加注解：@Scheduled

@EnableScheduling
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    //@Scheduled(fixedRate=5*1000)//每5秒执行一次(单位毫秒)
    @Scheduled(cron="0 0/30 9-22/4 * *?")//设置9点到22点，每个30分钟执行一次
    public void job1(){
        System.out.println("job1---"+ DateFormat.getDateTimeInstance().format(new Date()));
    }

    //@Scheduled(fixedRate=5*1000)
    @Scheduled(cron="0 0 9-22/4 * *?")//设置9点到22点，每个4小时执行一次
    public void job2(){
        System.out.println("job2---"+ DateFormat.getDateTimeInstance().format(new Date()));
    }

}

4.异步多线程实现

上面通过两步编码实现了Spring定时任务，但是，默认是单线程的定时任务，如果任务持续时间较长，或者定时间隔时间较短，可能会将后续定时任务拖延，从而导致丢失任务。

异步多线程实现步骤：

开启异步注解
设置异步执行

总结

通过@EnableScheduling：开启定时任务（定义在启动类上）
通过@Scheduled：设置执行任务时间（定义在任务执行方法上）
通过@EnableAsync：开启异步执行（定义在启动类上）
通过@Async：设置异步执行（定义在异步执行方法上）

转：

https://blog.csdn.net/weixin_44768683/article/details/125702724

https://blog.51cto.com/chengzheng183/6413684

https://www.bilibili.com/video/BV1zz4y1X71Z?p=1

posted @ 2023-07-26 16:44 与f 阅读(289) 评论(0) 编辑收藏举报

刷新页面返回顶部

与f

springboot学习之十八(定时任务Quartz)

总结

公告