Spring Boot 定时任务

转载：https://blog.csdn.net/noaman_wgs/article/details/80984873

一、前言

在日常开发过程中，定时任务随处可见。例如，订火车票如果超过30分钟未支付，需要将订单改为取消支付；淘宝订单超过15天未确认收货需要自动更改状态。下面介绍两种定时任务的实现方式。一是SpringBoot自带的scheduled，二是Quartz

二、scheduled

第一种：scheduled

先搭建一套SpringBoot微服务，在启动类上添加@EnableScheduling，再配置一个定时任务配置类，方法在启动后，每三秒会执行一次。

package com.example.demo.task;
import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.util.Date;

/**
 * @Author helin
 * @Date 2021/8/13 14:24
 * @Description Springboot schedule
 */
@Component
@Slf4j
public class SbScheduleTask1 {
    @Scheduled(cron = "*/3 * * * * ?")
    public void task1() throws InterruptedException {
        log.error("我是Task，我的线程ID是 {},时间是 {}",
                Thread.currentThread().getId(),
                new Date()
        );
    }
}

如果想要两个定时任务异步并行执行，需要配置一个线程池

@Configuration
@Slf4j
publicclass ScheduleConfig implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.setScheduler(taskExecutor());    
    }
    @Bean
    public Executor taskExecutor(){
        return Executors.newScheduledThreadPool(10);
    }
}

三、Quartz

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

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

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"前只能设置具体的数字,不允许区间"-").
# 序号(表示每月的第几个周几)，例如在周字段上设置"6#3"表示在每月的第三个周六.注意如果指定"#5",正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了)

'L'和 'W'可以一组合使用。如果在日字段上设置"LW",则表示在本月的最后一个工作日触发（一般指发工资）
周字段的设置，若使用英文字母是不区分大小写的 MON 与mon相同

常用示例：

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分触发(光棍节)

3、SpringBoot整合Quartz框架

引入依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>

常见一个同步用户信息的Job类

package com.example.demo.quartz;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @Author helin
 * @Date 2021/8/17 17:51
 * @Description 同步用户信息Job
 */
public class SyncUserJob extends QuartzJobBean {

    @Override
    protected void executeInternal(JobExecutionContext context) {
        // 获取JobDetail中传递的参数
        String userName = (String) context.getJobDetail().getJobDataMap().get("userName");
        String blogUrl = (String) context.getJobDetail().getJobDataMap().get("blogUrl");
        String blogRemark = (String) context.getJobDetail().getJobDataMap().get("blogRemark");
        //获取当前时间
        Date date = new Date();
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

        //打印信息
        System.out.println("用户名称：" + userName);
        System.out.println("博客地址：" + blogUrl);
        System.out.println("博客信息：" + blogRemark);
        System.out.println("当前时间：" + dateFormat.format(date));
        System.out.println("----------------------------------------");
    }
}

配置定时任务

package com.example.demo.config;

import com.example.demo.quartz.SyncUserJob;
import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Author heLin
 * @Date 2021/8/18 16:09
 * @Description 配置定时任务
 */
@Configuration
public class QuartzConfig {
    private static final String JOB_GROUP_NAME = "PJB_JOB_GROUP_NAME";
    private static final String TRIGGER_GROUP_NAME = "PJB_TRIGGER_GROUP_NAME";

    /**
     * 定时任务1
     * 同步用户信息Job（任务详情）
     * @return JobDetail
     */
    @Bean
    public JobDetail syncUserJob(){
        return JobBuilder.newJob(SyncUserJob.class)
                .withIdentity("syncUserJobDetail",JOB_GROUP_NAME)
                .usingJobData("userName","小木的博客")
                .usingJobData("blogUrl","https://www.cnblogs.com/passex/")
                .usingJobData("blogRemark","欢迎访问小木的博客")
                .storeDurably() //即使没有Trigger关联时，也不需要删除该JobDetail
                .build();
    }

    /**
     * 定时任务1：
     * 同步用户信息Job（触发器）
     */
    @Bean
    public Trigger syncUserJobTrigger(){
        // 每五秒执行一次
        CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0/5 * * * * ?");
        // 创建触发器
        return TriggerBuilder.newTrigger()
                .forJob(syncUserJob())
                .withIdentity("syncUserJobTrigger",TRIGGER_GROUP_NAME)
                .withSchedule(cronScheduleBuilder)
                .build();
    }
}

4、Quartz框架核心讲解

下面就程序中出现的几个参数，看一下Quartz框架中的几个重要参数：

Job和JobDetail
JobExecutionContext
JobDataMap
Trigger、SimpleTrigger、CronTrigger

1、Job和JobDetail

Job是Quartz的一个接口，这个接口仅有一个execute方法，在这个方法里面可以写业务逻辑，我们可以实现这个Job类，重写execute方法。源码如下：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//

package org.quartz;

public interface Job {
    void execute(JobExecutionContext var1) throws JobExecutionException;
}

JobDetail是用来绑定Job的，为Job提供了许多属性：

name
group
JobClass
JobDataMap

JobDetail绑定指定的Job，每次Scheduler调度执行一个Job的时候，首先会拿到对应的Job，然后创建该实例，再去执行Job中的execute方法的内容，任务执行完成后，关联的Job对象会被释放，且会被JVM GC回收。

为什么设计成JobDetail + Job，而不是直接用Job？

JobDetail定义的是任务数据，而真正的执行逻辑是在Job中。
这是因为任务是有可能并发执行，如果Scheduler直接使用Job，就会存在对同一个Job实例并发访问的问题。而JobDetail & Job 方式，Sheduler每次执行，都会根据JobDetail创建一个新的Job实例，这样就可以规避并发访问的问题。

2、JobExecutionContext

JobExecutionContext中包含了Quartz运行时的环境以及Job本身的详细数据信息。当Scheduler调度执行一个Job的时候，就会将JobExecutionContext传递给该Job的execute中，Job就可以根据JobExecutionContext获取信息。主要信息有：

3、JobDataMap

JobDataMap实现了JDK的Map接口，可以以Key-Value的形式存储数据，JobDetail、Trigger都可以通过JobDataMap来设置一些参数信息。

4、Trigger、SimpleTrigger、CronTrigger

Trigger

Trigger是Quartz的触发器，会通知Scheduler什么时候去执行Job

new Trigger().startAt():表示触发器首次被触发的时间;
new Trigger().endAt():表示触发器结束触发的时间;

SimpleTrigger

SimpleTrigger可以实现一个在指定时间段内执行一次任务或者一个时间段内执行多个任务。

CronTrigger

CronTrigger的功能十分强大，是基于日历的任务调度，而SimpleTrigger是精准时间间隔，CronTrigger是基于Cron表达式的，又七个表达式组成，又俗称为七子表达式。格式如上图所示。

下面的代码就实现了每周一到周五上午10:30执行定时任务

/**
 * Created by wanggenshen
 * Date: on 2018/7/7 20:06.
 * Description: XXX
 */
public class MyScheduler2 {
    public static void main(String[] args) throws SchedulerException, InterruptedException {
        // 1、创建调度器Scheduler
        SchedulerFactory schedulerFactory = new StdSchedulerFactory();
        Scheduler scheduler = schedulerFactory.getScheduler();
        // 2、创建JobDetail实例，并与PrintWordsJob类绑定(Job执行内容)
        JobDetail jobDetail = JobBuilder.newJob(PrintWordsJob.class)
                .usingJobData("jobDetail1", "这个Job用来测试的")
                .withIdentity("job1", "group1").build();
        // 3、构建Trigger实例,每隔1s执行一次
        Date startDate = new Date();
        startDate.setTime(startDate.getTime() + 5000);

        Date endDate = new Date();
        endDate.setTime(startDate.getTime() + 5000);

        CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "triggerGroup1")
                .usingJobData("trigger1", "这是jobDetail1的trigger")
                .startNow()//立即生效
                .startAt(startDate)
                .endAt(endDate)
                .withSchedule(CronScheduleBuilder.cronSchedule("* 30 10 ? * 1/5 2018"))
                .build();

        //4、执行
        scheduler.scheduleJob(jobDetail, cronTrigger);
        System.out.println("--------scheduler start ! ------------");
        scheduler.start();
        System.out.println("--------scheduler shutdown ! ------------");

    }
}

暂时写这么多，以后用的时候再去深入探索

posted @ 2021-08-13 17:46 passex 阅读(258) 评论(0) 收藏举报

刷新页面返回顶部

小木