SpringBoot集成Quartz实现定时任务

Spring Boot offers several conveniences for working with the Quartz scheduler, including thespring-boot-starter-quartz “Starter”. If Quartz is available, a Scheduler is auto-configured (through the SchedulerFactoryBean abstraction).Beans of the following types are automatically picked up and associated with the Scheduler:• JobDetail: defines a particular Job. JobDetail instances can be built with the JobBuilder API.• Calendar.• Trigger: defines when a particular job is triggered.

SpringBoot提供了一些便捷的方法来和Quartz协同工作，这些方法里面包括`spring-boot-starter-quartz`这个启动器。如果Quartz可用，Scheduler会通过SchedulerFactoryBean这个工厂bean自动配置到SpringBoot里。JobDetail、Calendar、Trigger这些类型的bean会被自动采集并关联到Scheduler上。

Jobs can define setters to inject data map properties. Regular beans can also be injected in a similar manner.

Job可以定义setter(也就是set方法)来注入配置信息。也可以用同样的方法注入普通的bean。

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

# spring的datasource等配置未贴出spring:  quartz:      # 将任务等保存化到数据库      job-store-type: jdbc      # 程序结束时会等待quartz相关的内容结束      wait-for-jobs-to-complete-on-shutdown: true      # QuartzScheduler启动时更新己存在的Job,这样就不用每次修改targetObject后删除qrtz_job_details表对应记录      overwrite-existing-jobs: true      # 这里居然是个map，搞得智能提示都没有，佛了      properties:        org:          quartz:              # scheduler相关            scheduler:              # scheduler的实例名              instanceName: scheduler              instanceId: AUTO            # 持久化相关            jobStore:              class: org.quartz.impl.jdbcjobstore.JobStoreTX              driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate              # 表示数据库中相关表是QRTZ_开头的              tablePrefix: QRTZ_              useProperties: false            # 线程池相关            threadPool:              class: org.quartz.simpl.SimpleThreadPool              # 线程数              threadCount: 10              # 线程优先级              threadPriority: 5              threadsInheritContextClassLoaderOfInitializingThread: true

/** * Quartz的相关配置，注册JobDetail和Trigger * 注意JobDetail和Trigger是org.quartz包下的，不是spring包下的，不要导入错误 */@Configurationpublic class QuartzConfig {    @Bean    public JobDetail jobDetail() {        JobDetail jobDetail = JobBuilder.newJob(StartOfDayJob.class)                .withIdentity("start_of_day", "start_of_day")                .storeDurably()                .build();        return jobDetail;    }    @Bean    public Trigger trigger() {        Trigger trigger = TriggerBuilder.newTrigger()                .forJob(jobDetail())                .withIdentity("start_of_day", "start_of_day")                .startNow()                // 每天0点执行                .withSchedule(CronScheduleBuilder.cronSchedule("0 0 0 * * ?"))                .build();        return trigger;    }}

@Componentpublic class StartOfDayJob extends QuartzJobBean {    private StudentService studentService;    @Autowired    public StartOfDayJob(StudentService studentService) {        this.studentService = studentService;    }    @Override    protected void executeInternal(JobExecutionContext jobExecutionContext)            throws JobExecutionException {        // 任务的具体逻辑    }}

public class LeaveApplication {    @TableId(type = IdType.AUTO)    private Integer id;    private Long proposerUsername;    @JsonFormat( pattern = "yyyy-MM-dd HH:mm",timezone="GMT+8")    private LocalDateTime startTime;    @JsonFormat( pattern = "yyyy-MM-dd HH:mm",timezone="GMT+8")    private LocalDateTime endTime;    private String reason;    private String state;    private String disapprovedReason;    private Long checkerUsername;    private LocalDateTime checkTime;    // 省略getter、setter}

@Servicepublic class LeaveApplicationServiceImpl implements LeaveApplicationService {    @Autowired    private Scheduler scheduler;        // 省略其他方法与其他依赖    /**     * 添加job和trigger到scheduler     */    private void addJobAndTrigger(LeaveApplication leaveApplication) {        Long proposerUsername = leaveApplication.getProposerUsername();        // 创建请假开始Job        LocalDateTime startTime = leaveApplication.getStartTime();        JobDetail startJobDetail = JobBuilder.newJob(LeaveStartJob.class)                // 指定任务组名和任务名                .withIdentity(leaveApplication.getStartTime().toString(),                        proposerUsername + "_start")                // 添加一些参数，执行的时候用                .usingJobData("username", proposerUsername)                .usingJobData("time", startTime.toString())                .build();        // 创建请假开始任务的触发器        // 创建cron表达式指定任务执行的时间，由于请假时间是确定的，所以年月日时分秒都是确定的，这也符合任务只执行一次的要求。        String startCron = String.format("%d %d %d %d %d ? %d",                startTime.getSecond(),                startTime.getMinute(),                startTime.getHour(),                startTime.getDayOfMonth(),                startTime.getMonth().getValue(),                startTime.getYear());        CronTrigger startCronTrigger = TriggerBuilder.newTrigger()                // 指定触发器组名和触发器名                .withIdentity(leaveApplication.getStartTime().toString(),                        proposerUsername + "_start")                .withSchedule(CronScheduleBuilder.cronSchedule(startCron))                .build();        // 将job和trigger添加到scheduler里        try {            scheduler.scheduleJob(startJobDetail, startCronTrigger);        } catch (SchedulerException e) {            e.printStackTrace();            throw new CustomizedException("添加请假任务失败");        }    }}

@Componentpublic class LeaveStartJob extends QuartzJobBean {    private Scheduler scheduler;    private SystemUserMapperPlus systemUserMapperPlus;    @Autowired    public LeaveStartJob(Scheduler scheduler,                         SystemUserMapperPlus systemUserMapperPlus) {        this.scheduler = scheduler;        this.systemUserMapperPlus = systemUserMapperPlus;    }    @Override    protected void executeInternal(JobExecutionContext jobExecutionContext)            throws JobExecutionException {        Trigger trigger = jobExecutionContext.getTrigger();        JobDetail jobDetail = jobExecutionContext.getJobDetail();        JobDataMap jobDataMap = jobDetail.getJobDataMap();        // 将添加任务的时候存进去的数据拿出来        long username = jobDataMap.getLongValue("username");        LocalDateTime time = LocalDateTime.parse(jobDataMap.getString("time"));        // 编写任务的逻辑        // 执行之后删除任务        try {            // 暂停触发器的计时            scheduler.pauseTrigger(trigger.getKey());            // 移除触发器中的任务            scheduler.unscheduleJob(trigger.getKey());            // 删除任务            scheduler.deleteJob(jobDetail.getKey());        } catch (SchedulerException e) {            e.printStackTrace();        }    }}