Spring系列——springboot整合quarter定时任务

Posted 2020-12-20

简介

本文主要介绍Spring系列Springboot整合quarter定时任务，大致分为三个部分：添加jar包、创建一个定时任务的配置类、创建具体执行的任务，希望看完本文后对大家有所帮助。

一、添加jar包

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

二、创建一个定时任务的配置类

可以理解为 这个类要去执行什么任务，什么时候去执行

package com.vale.info.server.quartz;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.vale.info.server.dao.CronDao;
import com.vale.info.server.entity.Cron;
import com.vale.info.server.global.RedisConstants;
import com.vale.info.server.util.InfoException;
import com.vale.info.server.util.RedisUtils;
import lombok.extern.slf4j.Slf4j;
import org.quartz.*;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;

/**
 * TODO
 *
 * @author wasin
 * @version 1.0
 * @date 2020/9/7 19:33
 */
@Component
@Slf4j
public class TaskFileScheduler {

    @Resource
    private SchedulerFactoryBean schedulerFactoryBean;

    private Integer taskId;

    public void setTaskId(Integer taskId){
        this.taskId=taskId;
    }

    @Resource
    private Scheduler scheduler;

    /**
     * 设置任务的执行时间
     * @param scheduler
     * RedisConstants. 相关的是我自己定义的静态变量 为这个定时任务添加任务的名称 和分组
     * 后期如果需要删除时则找到相关的名称去删除即可
     * @throws SchedulerException
     */
    private void setTaskExecuteDate(Scheduler scheduler) throws SchedulerException {
        log.info("设置任务的执行时间 taskId={},任务名称={}，分组名称={}",taskId,String.format(RedisConstants.QUARTER_JOB_NAME,taskId),String.format(RedisConstants.QUARTER_JOB_GROUP,taskId));
        JobDetail jobDetail = JobBuilder.newJob(TaskJob.class).withIdentity(String.format(RedisConstants.QUARTER_JOB_NAME,taskId), String.format(RedisConstants.QUARTER_JOB_GROUP,taskId)).build();
         //2020-9-18 18:18:18秒执行这个任务
        CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("18 18 18 18 9 ? 2020");
        JobDataMap jobDataMap=new JobDataMap();

        jobDataMap.put("taskId",this.taskId);
        CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity(String.format(RedisConstants.QUARTER_TRIGGER_NAME,taskId), String.format(RedisConstants.QUARTER_TRIGGER_GROUP,taskId))
                .usingJobData(jobDataMap).withSchedule(scheduleBuilder).build();
        scheduler.scheduleJob(jobDetail,cronTrigger);
    }

    //业务代码中掉用这个方法就可以添加这个定时任务
    public void scheduleJobs(Integer taskId) throws SchedulerException {
        if(taskId==null){
            throw new InfoException("定时任务id不可为空");
        }
        this.taskId=taskId;
        Scheduler scheduler = schedulerFactoryBean.getScheduler();
        setTaskExecuteDate(scheduler);
    }

    /**
     * 删除定时任务
     * @param croId  定时任务id
     * @param jobName 任务名称  就是任务id
     * @param jobGroup 任务分组 就是任务id
     */
    public void delJob(Integer croId,String jobName, String jobGroup) {
        try {
          log.info("删除定时任务 jobName={},jobGroup={}",jobName,jobGroup);
            this.taskId=Integer.valueOf(jobName);
            jobName=String.format(RedisConstants.QUARTER_TRIGGER_NAME,jobName);
            jobGroup=String.format(RedisConstants.QUARTER_TRIGGER_GROUP,jobGroup);
            // TriggerKey 定义了trigger的名称和组别 ，通过任务名和任务组名获取TriggerKey
            TriggerKey triggerKey = TriggerKey.triggerKey(jobName,jobGroup);
            if(triggerKey!=null){
                // 停止触发器
                scheduler.resumeTrigger(triggerKey);
                // 移除触发器
                scheduler.unscheduleJob(triggerKey);
                // 移除任务
                scheduler.deleteJob(JobKey.jobKey(jobName,jobGroup));
                log.info("定时任务删除成功");
            }
        } catch (SchedulerException e) {
            e.printStackTrace();
        }

    }

}

三、创建具体执行的任务

可以理解为 这个任务要去做什么 上面定义的是什么时候去做，谁去做

package com.vale.info.server.quartz;

import com.vale.info.server.dao.CronDao;
import com.vale.info.server.entity.Cron;
import com.vale.info.server.entity.Task;
import com.vale.info.server.global.UdpConstans;
import com.vale.info.server.util.ReadFile;
import com.vale.info.server.util.RedisUtils;
import com.vale.info.server.util.UdpFileClient;
import lombok.extern.slf4j.Slf4j;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.io.IOException;

/**
 * TODO
 * 定义一个需要去执行的任务
 * @author wasin
 * @version 1.0
 * @date 2020/9/7 19:25
 */
@Component
@Slf4j
public class TaskJob implements Job {

    //这些参数都可以在上面定义的类中传过来

    private Integer taskId;

    public void setTaskId(Integer taskId) {
        this.taskId = taskId;
    }
    @Override
    public void execute(JobExecutionContext jobExecutionContext) {
        log.info("定时任务执行 taskId={}",taskId);
        //执行具体的业务逻辑 

    }
}

结尾

感谢大家看到最后，都看到最后了，点个赞再走吧，有不对的地方还请多多指正。