Springboot集成quartz

本文介绍如何在SpringBoot项目中使用Quartz实现定时任务,包括配置、启动、暂停、恢复及修改定时任务的方法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1.0需要jar包

<!-- 定时器任务 quartz需要导入的坐标 -->
<dependency>
  <groupId>org.quartz-scheduler</groupId>
  <artifactId>quartz</artifactId>
  <version>2.2.1</version>
 </dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-context-support</artifactId>
</dependency>

2.0SpringBoot自带定时

    @Scheduled 定时规则

@Configuration
@EnableScheduling
@Component
public class ScheduleTest {
    @Scheduled(fixedRate = 5000)
    public void scheduleUpdateCronTrigger() throws SchedulerException {
        System.out.println("5s运行一次,测试用的");
    }
}

3.1集成Quartz:添加job,写两个类,模拟定时任务

3.1.1:ScheduledJob类 

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class ScheduledJob implements Job{ 
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException { 
        System.out.println("第一个定时任务" + new Date()); 
    }
}
3.1.2:ScheduledJob2类
只需要将ScheduledJob类名改成3.1.1:ScheduledJob2


3.2写一个配置类

实现对于定时任务的启动、暂停、修改、恢复启动。其中两个定时分别为15分钟执行一次和2小时执行一次,如果测试,可以缩短周期
import cn.dankal.lc.quartz.job.ScheduledJob;
import cn.dankal.lc.quartz.job.ScheduledJob2;
import org.quartz.CronScheduleBuilder;
import org.quartz.CronTrigger;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.TriggerBuilder;
import org.quartz.TriggerKey;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import org.springframework.stereotype.Component;


@Component
public class MyScheduler {

   @Autowired
   SchedulerFactoryBean schedulerFactoryBean;

   static Scheduler scheduler;

   public void scheduleJobs() throws SchedulerException {
      scheduler = schedulerFactoryBean.getScheduler();
      startJob1(); // 每15分钟执行一次
      startJob2(); // 每两小时执行一次
   }

   public static void startJob1() throws SchedulerException {
      JobDetail jobDetail = JobBuilder.newJob(ScheduledJob.class).withIdentity("job1", "group1").build();
      CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0 0/15 * * * ?");
      CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
            .withSchedule(scheduleBuilder).build();
      scheduler.scheduleJob(jobDetail, cronTrigger);
   }
   public static void modifyJob1(String cron) throws SchedulerException {
      TriggerKey triggerKey = TriggerKey.triggerKey("trigger1", "group1");
      CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cron);
      CronTrigger newTrigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
            .withSchedule(scheduleBuilder).build();
      scheduler.rescheduleJob(triggerKey, newTrigger);
   }
   public static String getJob1Status() throws SchedulerException {
      TriggerKey triggerKey = TriggerKey.triggerKey("trigger1", "group1");
      return scheduler.getTriggerState(triggerKey).name();
   }
   public static void pauseJob1() throws SchedulerException {
      scheduler.pauseJob(JobKey.jobKey("job1", "group1"));
   }
   public static void resumeJob1() throws SchedulerException {
      scheduler.resumeJob(JobKey.jobKey("job1", "group1"));
   }

   private void startJob2() throws SchedulerException {
      JobDetail jobDetail = JobBuilder.newJob(ScheduledJob2.class).withIdentity("job2", "group1").build();
      CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0 0 0/2 * * ?");
      CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("trigger2", "group1")
            .withSchedule(scheduleBuilder).build();
      scheduler.scheduleJob(jobDetail, cronTrigger);
   }
   public static void modifyJob2(String cron) throws SchedulerException {
      TriggerKey triggerKey = TriggerKey.triggerKey("trigger2", "group1");
      CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cron);
      CronTrigger newTrigger = TriggerBuilder.newTrigger().withIdentity("trigger2", "group1")
            .withSchedule(scheduleBuilder).build();
      scheduler.rescheduleJob(triggerKey, newTrigger);
   }
   public static String getJob2Status() throws SchedulerException {
      TriggerKey triggerKey = TriggerKey.triggerKey("trigger2", "group1");
      return scheduler.getTriggerState(triggerKey).name();
   }
   public static void pauseJob2() throws SchedulerException {
      scheduler.pauseJob(JobKey.jobKey("job2", "group1"));
   }
   public static void resumeJob2() throws SchedulerException {
      scheduler.resumeJob(JobKey.jobKey("job2", "group1"));
   }

}

3.3写一个SchedulerListene

import org.quartz.SchedulerException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;

@Configuration
public class SchedulerListener implements ApplicationListener<ContextRefreshedEvent> {

   @Autowired
   public MyScheduler myScheduler;

   @Override
   public void onApplicationEvent(ContextRefreshedEvent event) {
      try {
         myScheduler.scheduleJobs();
      } catch (SchedulerException e) {
         e.printStackTrace();
      }
   }

   @Bean
   public SchedulerFactoryBean schedulerFactoryBean() {
      SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean();
      return schedulerFactoryBean;
   }
}

3.4控制层

import cn.dankal.lc.quartz.config.MyScheduler;
import org.quartz.SchedulerException;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ScheduleController {
     //务1会修改成1秒钟执行一次
    @RequestMapping("/modify")
    public @ResponseBody String modify() throws SchedulerException {
        MyScheduler.modifyJob1("0/1 * * * * ?");
        return "1";
    }
     //可以查看运行状态
    @RequestMapping("/status")
    public @ResponseBody String status() throws SchedulerException {
        return MyScheduler.getJob1Status();
    }
     //任务会暂停
    @RequestMapping("/pause")
    public @ResponseBody String pause() throws SchedulerException {
        MyScheduler.pauseJob1();
        return "1";
    }
    //任务会重新运行
    @RequestMapping("/resume")
    public @ResponseBody String resume() throws SchedulerException {
        MyScheduler.resumeJob1();
        return "1";
    }
}

注:定时任务有固定表达式


                
### 集成 Quartz 实现定时任务调度 为了在 Spring Boot 项目中集成 Quartz 来实现定时任务调度,开发者可以通过引入相应的依赖来简化这一过程。每当向 Spring Boot 项目添加新的依赖项时,Spring Boot 自动配置会自动尝试根据该依赖项配置 bean[^4]。 #### 添加 Maven 或 Gradle 依赖 首先,在 `pom.xml` 文件中加入 Quartz 和其相关组件的支持: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-quartz</artifactId> </dependency> ``` 对于使用 Gradle 构建系统的项目,则应在 build.gradle 中添加如下内容: ```groovy implementation 'org.springframework.boot:spring-boot-starter-quartz' ``` #### 创建 Job 类 定义具体的作业类继承自 QuartzJobBean 并重写 executeInternal 方法完成业务逻辑处理工作: ```java import org.quartzDisallowConcurrentExecution; import org.quartz.PersistJobDataAfterExecution; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.springframework.scheduling.quartz.QuartzJobBean; @PersistJobDataAfterExecution @DisallowConcurrentExecution public class SampleJob extends QuartzJobBean { @Override protected void executeInternal(JobExecutionContext context) throws JobExecutionException { System.out.println("Executing job at " + new Date()); } } ``` 上述代码片段展示了创建一个简单的 Quartz 调度器实例的方法[^1]。 #### 定义 Scheduler Bean 通过 Java Config 方式注册 CronTriggerFactoryBean 及 MethodInvokingJobDetailFactoryBean 对象用于触发指定方法执行周期性的操作: ```java @Configuration @EnableScheduling public class QuartzConfig { @Autowired private ApplicationContext applicationContext; @Bean public JobDetail sampleJobDetail() { return JobBuilder.newJob(SampleJob.class).withIdentity("sampleJob").build(); } @Bean public Trigger sampleJobTrigger(@Qualifier("sampleJobDetail") JobDetail jobDetail) { return TriggerBuilder.newTrigger() .forJob(jobDetail) .withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?")) .build(); } } ``` 这段配置说明了如何设置每五秒运行一次的任务计划表[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值