springboot定时任务详解

  • Z时代
  • 2024-01-10
  • 分类：综合

在我们开发项目过程中，经常需要定时任务来帮助我们来做一些内容， Spring Boot 默认已经帮我们实行了，只需要添加相应的注解就可以实现

一、基于注解（静态）

1、pom 包配置

pom 包里面只需要引入 Spring Boot Starter 包即可

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

2、创建定时任务实现类

定时任务1：

@Configuration
@EnableScheduling
public class SchedulerTask {
  private int count=0;
  @Scheduled(cron="*/6 * * * * ?")
  private void process(){
    System.out.println("this is scheduler task runing "+(count++));
  }
}

定时任务2：

@Configuration
@EnableScheduling
public class Scheduler2Task {
  private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
  @Scheduled(fixedRate = 6000)
  public void reportCurrentTime() {
    System.out.println("现在时间：" + dateFormat.format(new Date()));
  }
}

结果如下：

this is scheduler task runing 0
现在时间：09:44:17
this is scheduler task runing 1
现在时间：09:44:23
this is scheduler task runing 2
现在时间：09:44:29
this is scheduler task runing 3
现在时间：09:44:35

参数说明

@Configuration用于标记配置类，兼备Component的效果。

@EnableScheduling表示开启定时任务

@Scheduled 参数可以接受两种定时的设置，一种是我们常用的cron="*/6 * * * * ?",一种是 fixedRate = 6000，两种都表示每隔六秒打印一下内容。

fixedRate 说明

@Scheduled(fixedRate = 6000) ：上一次开始执行时间点之后6秒再执行

@Scheduled(fixedDelay = 6000) ：上一次执行完毕时间点之后6秒再执行

@Scheduled(initialDelay=1000, fixedRate=6000) ：第一次延迟1秒后执行，之后按 fixedRate 的规则每6秒执行一次

cron属性，通过表达式形式指定任务执行规则，同样也是从上一次任务执行完毕开始计时。表达式规则如下：

每个位置的规则如下：

备注：

  • 星号(*)：可用在所有字段中，表示对应时间域的每一个时刻，例如，*在分钟字段时，表示“每分钟”。

  • 问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于占位符。

  • 减号(-)：表达一个范围，如在小时字段中使用“10-12”，则表示从10到12点，即10,11,12。

  • 逗号(,)：表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期五。

  • 斜杠(/)：x/y表达一个等步长序列，x为起始值，y为增量步长值。如在秒数字段中使用0/15，则表示为0,15,30和45秒，而5/15在分钟字段中表示5,20,35,50，你也可以使用*/y，它等同于0/y。

  • L：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L在日期字段中，表示这个月份的最后一天，如一月的31号，非闰年二月的28号；如果L用在星期中，则表示星期六，等同于7。但是，如果L出现在星期字段里，而且在前面有一个数值X，则表示“这个月的最后X天”，例如，6L表示该月的最后星期五。

  • W：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日，如果该月15号是星期六，则匹配14号星期五；如果15日是星期日，则匹配16号星期一；如果15号是星期二，那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月，如你指定1W，如果1号是星期六，结果匹配的是3号星期一，而非上个月最后的那天。W字符串只能指定单一日期，而不能指定日期范围。

  • LW组合：在日期字段可以组合使用LW，它的意思是当月的最后一个工作日。

  • 井号(#)：该字符只能在星期字段中使用，表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五，#3表示当前的第三个)，而4#5表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发。

  • C：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。

  • cron表达式对大小写不敏感。

二、基于接口（动态）

1、pom包配置

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>1.3.1</version>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
</dependency>

2、添加数据库记录：

开启本地数据库mysql，随便打开查询窗口，然后执行脚本内容，如下：

DROP DATABASE IF EXISTS `socks`;
CREATE DATABASE `socks`;
USE `SOCKS`;
DROP TABLE IF EXISTS `cron`;
CREATE TABLE `cron` (
 `cron_id` varchar(30) NOT NULL PRIMARY KEY,
 `cron` varchar(30) NOT NULL 
);
INSERT INTO `cron` VALUES ('1', '0/5 * * * * ?');

然后在application.properties文件添加数据源

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/socks?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

3、创建定时器

数据库准备好数据之后，我们编写定时任务，注意这里添加的是TriggerTask，目的是循环读取我们在数据库设置好的执行周期，以及执行相关定时任务的内容。 具体代码如下：

package com.cn.service;
import com.cn.dao.CronMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.util.StringUtils;
import java.time.LocalDateTime;
@Configuration   //1.主要用于标记配置类，兼备Component的效果。
@EnableScheduling  // 2.开启定时任务
public class DynamicScheduleTask implements SchedulingConfigurer {
  @Autowired
  private CronMapper cronMapper;
  /**
   * 执行定时任务.
   */
  @Override
  public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
    taskRegistrar.addTriggerTask(
        //1.添加任务内容(Runnable)
        () -> System.out.println("执行动态定时任务: " + LocalDateTime.now().toLocalTime()),
        //2.设置执行周期(Trigger)
        triggerContext -> {
          //2.1 从数据库获取执行周期
          String cron = cronMapper.selectByPrimaryKey("1").getCron();
          //2.2 合法性校验.
          if (StringUtils.isEmpty(cron)) {
            // Omitted Code ..
          }
          //2.3 返回执行周期(Date)
          return new CronTrigger(cron).nextExecutionTime(triggerContext);
        }
    );
  }
}

4、启动测试

然后打开Navicat ，将执行周期修改为每10秒执行一次，查看控制台，发现执行周期已经改变，并且不需要我们重启应用，十分方便。如图：

三、Quartz

Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目，它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的程序。

1.添加依赖

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

2、编写任务类

package com.cn.service;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.quartz.QuartzJobBean;
public class MyQuartz extends QuartzJobBean {
  private final Logger log = LoggerFactory.getLogger(MyQuartz.class);
  @Override
  protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
    log.info("hello quartz");
  }
}

3、编写配置类

package com.cn.config;
import com.cn.service.MyQuartz;
import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class QuartzConfig {
  @Bean
  public JobDetail myQuartz() {
    return JobBuilder.newJob(MyQuartz.class).withIdentity("MyQuartz").storeDurably().build();
  }
  @Bean
  public Trigger studentRankQuartzTrigger() {
    return TriggerBuilder.newTrigger().forJob(myQuartz())
        .withIdentity("MyQuartz")
        .withSchedule(DailyTimeIntervalScheduleBuilder.dailyTimeIntervalSchedule().withInterval(5,		
         DateBuilder.IntervalUnit.SECOND))
        .build();
  }
}

4、启动项目

每隔5秒打印一次"hello quartz"

以上是 springboot定时任务详解 的全部内容， 来源链接： utcz.com/z/335740.html

回到顶部