SpringBoot项目通过触发器调度实现定时任务


前言

项目中可能会遇到一些需要定时同步数据的业务场景,比如从多个数据库汇总数据形成结果,可以使用数据自带的定时任务去执行存储过程实现,也可以通过集成quartz来实现,


一、quartz是什么?

1、Quartz是一个功能强大且灵活的开源任务调度库,用于在Java应用程序中实现定时任务和作业调度。它允许你根据特定的时间表(比如每天凌晨执行一次,或者每隔一段时间执行一次)来调度任务的执行。Quartz提供了丰富的功能,包括支持CRON表达式、作业持久化、集群环境下的分布式调度、监听器支持等。
2、通过Quartz,可以创建各种类型的作业,例如简单作业(只需要执行一次)、重复作业(按照指定的时间间隔重复执行)、以及基于CRON表达式的作业(按照指定的时间规则执行)。

二、quartz中核心概念

1、任务 Job: Job 就是你想要实现的任务类,每一个 Job 必须实现org.quartz.job 接口,且只需实现接口定义的execute() 方法。
2、触发器 Trigger: Trigger 为你执行任务的触发器,Trigger将会设置3点执行该任务。 Trigger主要包含两种 SimplerTrigger 和 CronTrigger 两种。
3、调度器 Scheduler: Scheduler 为任务的调度器,它会将任务 Job 及触发器 Trigger 整合起来,负责基于Trigger 设定的时间来执行 Job。

三、集成步骤

1.引入依赖

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

2.demo样例

a.定义一个任务参数实体类

@Data
public class QuartzJobInfo {

    private String type;

    private Map<String, Object> params;

    private String jobName;

    private String cronj;

    private String orderId;
}

b.定义操作触发器、定时任务接口及实现

  1. 接口类
public interface IQuartzService {

    //1.添加定时任务
    void addTrigger(QuartzJobInfo jobInfo);

    //2.移除定时任务id
    void delTrigger(Long id);
    }
  1. 接口实现类
@Service
public class QuartzServiceImpl implements IQuartzService {

    @Autowired
    private SchedulerFactoryBean factoryBean;

    @Override
    public void addTrigger(QuartzJobInfo jobInfo) {
        //jobInfo转换为json
        String info = JSONObject.toJSONString(jobInfo);
        //获取调度器
        Scheduler scheduler = factoryBean.getScheduler();
        //调用 工具类设置定时任务
        QuartzUtils.addJob(scheduler, jobInfo.getJobName(), OrderJob.class, info, jobInfo.getCronj());
    }

    @Override
    public void delTrigger(Long id) {
        //获取Job的名字
        String jobName = "product_job" + id;
        //获取调度器
        Scheduler scheduler = factoryBean.getScheduler();
        QuartzUtils.removeJob(scheduler, jobName);
    }
    }
  1. 工具类
/**
 * Quartz调度管理器
 */
public class QuartzUtils {
    private static String JOB_GROUP_NAME = "JOB_GROUP_SYSTEM";
    private static String TRIGGER_GROUP_NAME = "TRIGGER_GROUP_SYSTEM";

    /**
     * @param sched   调度器
     * @param jobName 任务名
     * @param cls     任务
     * @param params  任务参数
     * @param time    时间设置,参考quartz说明文档
     * @Description: 添加一个定时任务,使用默认的任务组名,触发器名,触发器组名
     * @Title: QuartzManager.java
     */
    public static void addJob(Scheduler sched, String jobName, @SuppressWarnings("rawtypes") Class cls, Object params,
                              String time) {
        try {
            JobKey jobKey = new JobKey(jobName, JOB_GROUP_NAME);// 任务名,任务组,任务执行类
            @SuppressWarnings("unchecked")

            JobDataMap jobDataMap = new JobDataMap();
            jobDataMap.put("params", params);
            JobDetail jobDetail = newJob(cls).withIdentity(jobKey).setJobData(jobDataMap).build();
            TriggerKey triggerKey = new TriggerKey(jobName, TRIGGER_GROUP_NAME);// 触发器
            System.out.println(time);
            Trigger trigger = newTrigger().withIdentity(triggerKey).withSchedule(cronSchedule(time)).build();// 触发器时间设定
            sched.scheduleJob(jobDetail, trigger);
            if (!sched.isShutdown()) {
                sched.start();// 启动
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched            调度器
     * @param jobName          任务名
     * @param jobGroupName     任务组名
     * @param triggerName      触发器名
     * @param triggerGroupName 触发器组名
     * @param jobClass         任务
     * @param params           任务参数
     * @param time             时间设置,参考quartz说明文档
     * @Description: 添加一个定时任务
     * @Title: QuartzManager.java
     */
    public static void addJob(Scheduler sched, String jobName, String jobGroupName, String triggerName,
                              String triggerGroupName, @SuppressWarnings("rawtypes") Class jobClass, Object params, String time) {
        try {
            JobKey jobKey = new JobKey(jobName, jobGroupName);
            JobDataMap jobDataMap = new JobDataMap();
            jobDataMap.put("params", params);
            @SuppressWarnings("unchecked")
            JobDetail jobDetail = newJob(jobClass).withIdentity(jobKey).setJobData(jobDataMap).build();
            // 触发器
            TriggerKey triggerKey = new TriggerKey(triggerName, triggerGroupName);
            Trigger trigger = newTrigger().withIdentity(triggerKey).withSchedule(cronSchedule(time)).build();
            sched.scheduleJob(jobDetail, trigger);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched   调度器
     * @param jobName
     * @param time
     * @Description: 修改一个任务的触发时间(使用默认的任务组名 , 触发器名 , 触发器组名)
     * @Title: QuartzManager.java
     */
    @SuppressWarnings("rawtypes")
    public static void modifyJobTime(Scheduler sched, String jobName, String time) {
        try {
            TriggerKey triggerKey = new TriggerKey(jobName, TRIGGER_GROUP_NAME);
            CronTrigger trigger = (CronTrigger) sched.getTrigger(triggerKey);
            if (trigger == null) {
                return;
            }
            String oldTime = trigger.getCronExpression();
            if (!oldTime.equalsIgnoreCase(time)) {
                JobKey jobKey = new JobKey(jobName, JOB_GROUP_NAME);
                JobDetail jobDetail = sched.getJobDetail(jobKey);
                Class objJobClass = jobDetail.getJobClass();
                Object params = jobDetail.getJobDataMap().get("params");
                removeJob(sched, jobName);
                System.out.println("修改任务:" + jobName);
                addJob(sched, jobName, objJobClass, params, time);
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched            调度器 *
     * @param sched            调度器
     * @param triggerName
     * @param triggerGroupName
     * @param time
     * @Description: 修改一个任务的触发时间
     * @Title: QuartzManager.java
     */
    public static void modifyJobTime(Scheduler sched, String triggerName, String triggerGroupName, String time) {
        try {
            TriggerKey triggerKey = new TriggerKey(triggerName, triggerGroupName);
            CronTrigger trigger = (CronTrigger) sched.getTrigger(triggerKey);
            if (trigger == null) {
                return;
            }
            String oldTime = trigger.getCronExpression();
            if (!oldTime.equalsIgnoreCase(time)) {
                // 修改时间
                trigger.getTriggerBuilder().withSchedule(cronSchedule(time));
                // 重启触发器
                sched.resumeTrigger(triggerKey);
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched   调度器
     * @param jobName
     * @Description: 移除一个任务(使用默认的任务组名 , 触发器名 , 触发器组名)
     * @Title: QuartzManager.java
     */
    public static void removeJob(Scheduler sched, String jobName) {
        try {
            TriggerKey triggerKey = new TriggerKey(jobName, TRIGGER_GROUP_NAME);
            sched.pauseTrigger(triggerKey);// 停止触发器
            sched.unscheduleJob(triggerKey);// 移除触发器
            JobKey jobKey = new JobKey(jobName, JOB_GROUP_NAME);
            sched.deleteJob(jobKey);// 删除任务
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched            调度器
     * @param jobName
     * @param jobGroupName
     * @param triggerName
     * @param triggerGroupName
     * @Description: 移除一个任务
     * @Title: QuartzManager.java
     */
    public static void removeJob(Scheduler sched, String jobName, String jobGroupName, String triggerName,
                                 String triggerGroupName) {
        try {
            TriggerKey triggerKey = new TriggerKey(triggerName, triggerGroupName);
            sched.pauseTrigger(triggerKey);// 停止触发器
            sched.unscheduleJob(triggerKey);// 移除触发器
            JobKey jobKey = new JobKey(jobName, jobGroupName);
            sched.deleteJob(jobKey);// 删除任务
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched 调度器
     * @Description:启动所有定时任务
     * @Title: QuartzManager.java
     */
    public static void startJobs(Scheduler sched) {
        try {
            sched.start();
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched 调度器
     * @Description:关闭所有定时任务
     */
    public static void shutdownJobs(Scheduler sched) {
        try {
            if (!sched.isShutdown()) {
                sched.shutdown();
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
}

c.作业实现

新增作业时,需要继承QuartzJobBean类,实现executeInternal方法。

@Component
public class OrderJob  extends QuartzJobBean implements CommandLineRunner {

    @Autowired
    IQuartzService iQuartzService;

    //遵循规范
    @Override
    public void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        String params = (String) jobExecutionContext.getJobDetail().getJobDataMap().get("params");
        QuartzJobInfo info = JSONObject.parseObject(params, QuartzJobInfo.class);
        String type = info.getType();
        Date now = new Date();
        switch (type) {
            case JobTypeConsts.WAIT_PRODUCT_ORDER_PAY_CANCEL_JOB:
                //执行逻辑1
                System.out.println("----------->>>>>>>>执行逻辑1,订单ID:" + info.getOrderId());
                break;
            case JobTypeConsts.WAIT_USERDEPOSIT_ORDER_PAY_CANCEL_JOB:
                //执行逻辑2
                System.out.println("----------->>>>>>>>执行逻辑2,订单ID:" + info.getOrderId());
                break;
            case JobTypeConsts.WAIT_REFUNDUSERDEPOSIT_ORDER_PAY_CANCEL_JOB:
                //执行逻辑3
                System.out.println("----------->>>>>>>>执行逻辑3,订单ID:" + info.getOrderId());
                break;
        }
    }
    @Override
    public void run(String... args) throws Exception {
        for (int i = 1; i < 4; i++) {
            QuartzJobInfo quartzJobInfo = new QuartzJobInfo();
            quartzJobInfo.setJobName("测试定时任务--->>>>." + i);
            quartzJobInfo.setCronj("0 0/1 * * * ?");
            quartzJobInfo.setType(String.valueOf(i));
            quartzJobInfo.setOrderId(String.valueOf(i));
            iQuartzService.addTrigger(quartzJobInfo);
        }
    }
}
  1. 实现CommandLineRunner接口的作用是,当项目启动时,会扫描到此接口,执行实现接口中的逻辑;
  2. 执行完run方法,然后根据Quartz 的调度触发机制,在适当的时间执行 execute 方法。

d.结果截图

0 0/1 * * * ?代表每分钟执行一次
在这里插入图片描述

四、其他

1.QuartzJobBean和Job区别

  1. 继承关系:QuartzJobBean 是一个 Spring 定制的 Quartz 作业类,是 Quartz 提供的 Job 接口的一个实现类。因此,QuartzJobBean 继承自 Spring 的 QuartzJobBean 类和实现了 Quartz 的 Job 接口。

  2. 扩展性:通过继承 QuartzJobBean 类,您可以利用 Spring 框架提供的依赖注入和生命周期管理等功能,更容易地将 Quartz 作业集成到 Spring 应用中。而直接实现 Quartz 的 Job 接口则是一种更传统的方式,不具备 Spring 相关的特性。

  3. 依赖注入:使用 QuartzJobBean 可以方便地利用 Spring 的依赖注入机制,从 Spring 容器中获取其他 Bean,并在作业中使用这些 Bean,例如使用使用@Autowired方式。而直接实现 Job 接口时,无法直接获得 Spring 托管的 Bean,需要手动从 Spring 上下文中获取。

  4. 配置方式:QuartzJobBean 更适合在 Spring 应用中使用,可以通过 Spring 的配置文件或注解的方式来配置和管理定时任务。而直接实现 Job 接口通常需要通过 Quartz 的配置文件或 API 来进行配置。

2.注意事项

  1. 调度作业在在继承QuartzJobBean类后,需要加@Component注解,确保Spring Boot 应用程序能正确扫描到。

3.作业(Job)和触发器(Trigger)参数解析

a.JobDetail 参数解析
  1. Job Class(作业类):指定实现了Job接口的类,该类定义了要执行的作业逻辑。
  2. Job Name(作业名称):作业的名称,用于在调度器中标识该作业。
  3. Job Group(作业组):作业所属的分组,用于对作业进行分类管理。
  4. Job Data Map(作业数据):可以传递一些作业执行时需要的数据,以键值对的形式存储在JobDataMap中。

例:

 JobDetail jobDetail = newJob(cls).withIdentity(jobKey).setJobData(jobDataMap).build();
a.Trigger 参数解析
  1. Trigger Name(触发器名称):触发器的名称,用于在调度器中标识该触发器。
  2. Trigger Group(触发器组):触发器所属的分组,用于对触发器进行分类管理。
  3. Trigger Start Time(触发器开始时间):指定触发器首次触发的时间点。
  4. Trigger End Time(触发器结束时间):可选参数,指定触发器的结束时间,超过该时间后触发器不再生效。
  5. Repeat Interval(重复间隔时间):指定触发器重复执行的间隔时间。

例:

//创建触发器的唯一标识 TriggerKey 对象
 TriggerKey triggerKey = new TriggerKey(jobName, TRIGGER_GROUP_NAME);
//withSchedule() 方法用于设置触发器的调度规则
//cronSchedule(time) 表示使用 CRON 表达式来指定触发规则
//time 是一个表示 CRON 表达式的字符串,用于定义触发器的执行时间规则         
 Trigger trigger = newTrigger().withIdentity(triggerKey).withSchedule(cronSchedule(time)).build();
  • 15
    点赞
  • 29
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
首先,需要在 Spring Boot 中集成 Quartz。可以通过添加以下依赖来实现: ```xml <!-- Quartz --> <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.3.0</version> </dependency> ``` 然后,在 Spring Boot 中配置 Quartz。可以创建一个 `SchedulerFactoryBean` 实例,并设置相关属性,例如线程池大小、任务调度器等等。可以在 `application.properties` 文件中设置相关属性: ```properties # Quartz Scheduler spring.quartz.job-store-type=jdbc spring.quartz.jdbc.initialize-schema=always spring.quartz.properties.org.quartz.scheduler.instanceName=QuartzScheduler spring.quartz.properties.org.quartz.scheduler.instanceId=AUTO spring.quartz.properties.org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX spring.quartz.properties.org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate spring.quartz.properties.org.quartz.jobStore.useProperties=true spring.quartz.properties.org.quartz.jobStore.dataSource=myDataSource spring.quartz.properties.org.quartz.jobStore.tablePrefix=QRTZ_ spring.quartz.properties.org.quartz.dataSource.myDataSource.driverClassName=com.mysql.jdbc.Driver spring.quartz.properties.org.quartz.dataSource.myDataSource.URL=jdbc:mysql://localhost:3306/quartz spring.quartz.properties.org.quartz.dataSource.myDataSource.user=root spring.quartz.properties.org.quartz.dataSource.myDataSource.password=root spring.quartz.properties.org.quartz.threadPool.class=org.quartz.simpl.SimpleThreadPool spring.quartz.properties.org.quartz.threadPool.threadCount=10 spring.quartz.properties.org.quartz.threadPool.threadPriority=5 spring.quartz.properties.org.quartz.jobStore.isClustered=true spring.quartz.properties.org.quartz.jobStore.clusterCheckinInterval=20000 spring.quartz.properties.org.quartz.jobStore.maxMisfiresToHandleAtATime=1 ``` 然后,需要创建一个 `Job` 类来执行具体的任务。例如: ```java public class MyJob implements Job { @Override public void execute(JobExecutionContext context) throws JobExecutionException { // 执行具体的任务逻辑 System.out.println("Hello Quartz!"); } } ``` 最后,需要创建一个 `CronTriggerFactoryBean` 实例,并设置相关属性。例如: ```java @Configuration public class QuartzConfig { @Bean public JobDetailFactoryBean myJobDetail() { JobDetailFactoryBean factory = new JobDetailFactoryBean(); factory.setJobClass(MyJob.class); factory.setDurability(true); // 任务持久化 return factory; } @Bean public CronTriggerFactoryBean myCronTrigger(@Qualifier("myJobDetail") JobDetail jobDetail) { CronTriggerFactoryBean factory = new CronTriggerFactoryBean(); factory.setJobDetail(jobDetail); factory.setCronExpression("0/5 * * * * ?"); // 每隔 5 秒触发一次 return factory; } @Bean public SchedulerFactoryBean schedulerFactoryBean(@Qualifier("myCronTrigger") CronTrigger cronTrigger) { SchedulerFactoryBean factory = new SchedulerFactoryBean(); factory.setTriggers(cronTrigger); return factory; } } ``` 这里的 `myJobDetail` 方法返回一个 `JobDetailFactoryBean` 实例,它指定了具体的任务类。`myCronTrigger` 方法返回一个 `CronTriggerFactoryBean` 实例,它指定了触发器的具体规则。`schedulerFactoryBean` 方法返回一个 `SchedulerFactoryBean` 实例,它将任务和触发器关联起来,并返回一个 `Scheduler` 实例,可以通过它来启动和停止任务调度器。 最后,在 Vue 中实现调用后端接口来启动和停止任务调度器。可以使用 Axios 进行 HTTP 请求。例如: ```javascript import axios from 'axios' // 启动任务调度器 export function startScheduler () { return axios.post('/scheduler/start') } // 停止任务调度器 export function stopScheduler () { return axios.post('/scheduler/stop') } ``` 这里的 `/scheduler/start` 和 `/scheduler/stop` 是后端接口的 URL。可以在后端使用 Spring Boot 的 MVC 模块来实现这两个接口,例如: ```java @RestController @RequestMapping("/scheduler") public class SchedulerController { @Autowired private Scheduler scheduler; @PostMapping("/start") public void start() throws SchedulerException { scheduler.start(); } @PostMapping("/stop") public void stop() throws SchedulerException { scheduler.shutdown(); } } ``` 这里的 `scheduler` 是通过 `SchedulerFactoryBean` 创建的 `Scheduler` 实例,可以通过 `start()` 和 `shutdown()` 方法来启动和停止任务调度器。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值