springboot quartz 怎样只执行一次_七节课带你学会SpringBoot，第六课

☞点击查看SpringBoot完整视频教程☜

Spring Boot整合Quartz

1. Scheduled简介

Scheduled是Spring3.0后内置的定时任务器。通过Scheduled可以完成周期的执行一些功能。存在于spring-conext-support.jar中。

在SpringBoot中使用Scheduled非常简单，只需要在对应的方法上添加@Scheduled注解在配置对应的参数就可以完成。

2. SpringBoot中Scheduled代码实现

新建Maven项目SpringQuartz。

2.1 添加依赖

由于spring-boot-starter-web并没有依赖spring-conext-support，所以需要单独添加此依赖。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.13.RELEASE</version>
</parent>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context-support</artifactId>
    </dependency>
</dependencies>

2.2 创建启动类

新建com.bjsxt.QuartzApplication启动类

@SpringBootApplication
@EnableScheduling
public class QuartzApplication {
    public static void main(String[] args) {
        SpringApplication.run(QuartzApplication.class,args);
    }
}

2.3 新建定时任务

新建com.bjsxt.scheduled.DemoScheduled类。

注意类上有@Component注解，启动项目就需要加载类及类中的@Scheduled注解。

@Component
public class DemoScheduled {
    @Scheduled(cron="0/2 * * * * *")
    public void testScheduled(){
        System.out.println("test scheduled");
    }
}

3. cron表达式

Cron表达式是一个字符串，分为6或7个域，每一个域代表一个含义

Cron有如下两种语法格式：

1. Seconds Minutes Hours Day Month Week Year
2. Seconds Minutes Hours Day Month Week

3.1 结构

corn从左到右（用空格隔开）：

秒 分 小时 月份中的日期 月份 星期中的日期 年份

3.2 各字段的含义

Cron表达式的时间字段除允许设置数值外，还可使用一些特殊的字符，提供列表、范围、通配符等功能，细说如下：

1. 星号(*)：可用在所有字段中，表示对应时间域的每一个时刻，例如，*在分钟字段时，表示“每分钟”；
2. 问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于占位符；
3. 减号(-)：表达一个范围，如在小时字段中使用“10-12”，则表示从10到12点，即10,11,12；
4. 逗号(,)：表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期五；
5. 斜杠(/)：x/y表达一个等步长序列，x为起始值，y为增量步长值。如在分钟字段中使用0/15，则表示为0,15,30和45秒，而5/15在分钟字段中表示5,20,35,50，你也可以使用*/y，它等同于0/y；
6. L：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L在日期字段中，表示这个月份的最后一天，如一月的31号，非闰年二月的28号；如果L用在星期中，则表示星期六，等同于7。但是，如果L出现在星期字段里，而且在前面有一个数值X，则表示“这个月的最后X天”，例如，6L表示该月的最后星期五；
7. W：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日，如果该月15号是星期六，则匹配14号星期五；如果15日是星期日，则匹配16号星期一；如果15号是星期二，那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月，如你指定1W，如果1号是星期六，结果匹配的是3号星期一，而非上个月最后的那天。W字符串只能指定单一日期，而不能指定日期范围；
8. LW组合：在日期字段可以组合使用LW，它的意思是当月的最后一个工作日；
9. 井号(#)：该字符只能在星期字段中使用，表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五，#3表示当前的第三个)，而4#5表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发；
10. C：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。

Cron表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。

例子:

@Scheduled(cron = "0 0 1 1 1 ?")//每年一月的一号的1:00:00 执行一次

@Scheduled(cron = "0 0 1 1 1,6 ?") //一月和六月的一号的1:00:00 执行一次

@Scheduled(cron = "0 0 1 1 1,4,7,10 ?") //每个季度的第一个月的一号的1:00:00 执行一次

@Scheduled(cron = "0 0 1 1 * ?")//每月一号 1:00:00 执行一次

@Scheduled(cron="0 0 1 * * *") //每天凌晨1点执行一次

// 每月 星期12356 8点 10分 15s

Cron = 15 10 8 ? * 1,2,3,5,6

4. Quartz

4.1 简介

官方解释

Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目。可以方便的继承在Java项目中完成任务调度功能。总体功能和java.util.Timer很像，但是要比Timer功能更加强大。且不像Scheduler执行一个固定的任务，在Quartz可以对任务进行操作，新增任务，删除任务等。

例如：

每天固定时间执行任务！

每隔2天执行一次任务！

这些都是任务调度。Quartz都可以轻松地完整这些事情。

4.2 核心

Quartz核心包含四个概念。

4.2.1 Job

表示一个工作，要执行的具体内容。

4.2.2 JobDetail--完成一件怎样的事情

表示一个具体的可执行的调度任务。JobDetail除了包含Job还包含了任务调度和策略。

4.2.3 Trigger--什么时候去调用

触发器。配置调度参数，定义什么时候去调用。

4.2.4 Scheduler--结合上面两者什么时间完成XX事情

表示调度容器。Scheduler可以包含多个JobDetail和Trigger。

4.3入门案例实现

【1】依赖引入

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

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

【2】Job工作定义

public class MyJob  implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("执行了我的任务--时间为:"+new Date().toLocaleString());
    }
}

【3】定义实现执行过程

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = SchedApplication.class)
public class JobTest {
    @Test
    public void testAdd() {
        //[A]创建job对象--完成一样怎样的事情
        JobDetail jobDetail = JobBuilder.newJob(MyJob.class).build();
        //[B]创建触发器对象 --什么时间去做这件事情
         //每秒执行一次 永远执行
        Trigger   trigger=TriggerBuilder.newTrigger().withSchedule(SimpleScheduleBuilder.repeatSecondlyForever()).build();
        //[C]Scheduler 对象  相当于结合在什么时间做什么事情
        try {
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
            scheduler.scheduleJob(jobDetail,trigger);
            //启动
            scheduler.start();
        } catch (SchedulerException e) {
            e.printStackTrace();
        }
        //为了看到执行过程所以加上了睡眠
        try {
            Thread.sleep(20000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        } }}

5. SpringBoot整合Quartz引入数据库实现

新建Maven项目SpringQuartz

5.1 新建数据库导入数据

在MySQL中新建数据库quartz。

运行quartz.sql文件，导入数据文件（在当前版本中使用数据库初始化文件属性always不生效。）

5.2 添加依赖

<dependencies>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.11</version>
    </dependency>

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

5.3 配置配置文件

新建application.yml，并配置数据源

spring:
datasource:
  username: root
  driver-class-name: com.mysql.cj.jdbc.Driver
  password: root
  url: jdbc:mysql://127.0.0.1:3306/maven?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2B8
quartz:
  jdbc:
    initialize-schema: never
  job-store-type: jdbc

5.4 新建静态类

新建com.bjsxt.statics.QuartzStatic。为了记录每次执行Job的时间，定义一个静态常量。

public class QuartzStatic {
    public static long preTime=0L;
}

5.5 新建Job

新建com.bjsxt.job.MyJob定义Job的内容。

public class MyJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        long currTime = System.currentTimeMillis();
        if(QuartzStatic.preTime==0L){
            QuartzStatic.preTime = currTime;
        }
        System.out.println("execute执行-- MyJob"+(currTime- QuartzStatic.preTime));
        QuartzStatic.preTime = currTime;
    }
}

5.6 新建启动类

新建com.bjsxt.QuartzApplication

@SpringBootApplication
public class QuartzApplication {
    public static void main(String[] args) {
        SpringApplication.run(QuartzApplication.class,args);
    }
}

5.7 新建测试类

新建测试类com.bjsxt.MyTest。

在测试类中测试Quartz中新增、修改、删除、暂停、恢复、查询等功能。在每个功能执行完成后要注意数据库中数据的变化。

@Autowired
  private   Scheduler  scheduler;

//添加定时器任务
@Test
public    void     add(){
     //引入目前的job
     JobDetail jobDetais = JobBuilder.newJob(MyJob.class).withIdentity("job1", "jobgroup1").build();
     jobDetais.getJobDataMap().put("data-key","data-value");

     //新建触发器
     Trigger trigger = TriggerBuilder.newTrigger()
                        .withSchedule(CronScheduleBuilder.cronSchedule("0/2 * * * * ?"))
                        .withIdentity("trigger1", "triggergroup1")
                        .build();
     try {
          //使用scheduler对象把job 和 trigger 进行关联
          Date date = scheduler.scheduleJob(jobDetais, trigger);
          scheduler.start();
     } catch (SchedulerException e) {
          e.printStackTrace();
     }}
//修改操作
@Test
public void update(){
     try {
          TriggerKey triggerKey = TriggerKey.triggerKey("trigger1", "triggergroup1");

          CronTrigger trigger = (CronTrigger)scheduler.getTrigger(triggerKey);
          trigger= trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?")).build();

          scheduler.rescheduleJob(triggerKey,trigger);
     } catch (SchedulerException e) {
          e.printStackTrace();
     }
}

//删除实现
public void testDeleteJob(){
     try {
          boolean result = scheduler.deleteJob(new JobKey("job-name", "job-group"));
          System.out.println("执行结果："+result);
     } catch (SchedulerException e) {
          e.printStackTrace();
     }
}

@Test
public void testQueryJobs(){
     try {
          GroupMatcher<JobKey> groupMatcher = GroupMatcher.anyJobGroup();
          Set<JobKey> jobKeySet = scheduler.getJobKeys(groupMatcher);
          for(JobKey jobKey : jobKeySet){
               List<? extends Trigger> listTriggers = scheduler.getTriggersOfJob(jobKey);
               System.out.println("=========================================");
               for(Trigger trigger : listTriggers){
                    System.out.println(jobKey.getName());
                    System.out.println(jobKey.getGroup());
                    System.out.println(scheduler.getTriggerState(trigger.getKey()));
                    System.out.println(((CronTrigger) trigger).getCronExpression());
               }
               System.out.println("==========================================");
          }
     } catch (SchedulerException e) {
          e.printStackTrace();
     }

}

//暂停工作
 public void testPauseJob(){
      try {
           JobKey jobKey = new JobKey("job-name", "job-group");
           scheduler.pauseJob(jobKey);
      } catch (SchedulerException e) {
           e.printStackTrace();
      }
 }
 //启动工作
 @Test
 public void testResumeJob(){
      try {
           JobKey jobKey = new JobKey("job-name", "job-group");
           scheduler.resumeJob(jobKey);
      } catch (SchedulerException e) {
           e.printStackTrace();
      }
 }