Spring Boot使用Quartz定时任务

转载

mb63e0703549da8 2023-02-06 16:38:03 博主文章分类：java

文章标签 spring java maven 文章分类 spring boot 后端开发

一、采用内存方式使用Quartz

1、新建一个简单的Spring Boot项目

pom.xml内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.songguoliang</groupId>
    <artifactId>spring-boot-quartz</artifactId>
    <version>1.0-SNAPSHOT</version>

    <name>spring-boot-quartz</name>
    <description>Spring Boot教程(二十一)：Spring Boot使用Quartz定时任务</description>

    <!-- Spring Boot启动器父类 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- Spring Boot web启动器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- quartz -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2、创建任务

这里为了展示固定间隔和cron表达式，创建了两个任务

TestTask1内容如下：

package com.songguoliang.springboot.quartz;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @Description
 * @Author sgl
 * @Date 2018-06-26 16:43
 */
public class TestTask1 extends QuartzJobBean{

    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println("TestQuartz01----" + sdf.format(new Date()));
    }
}

TestTask2内容如下：

package com.songguoliang.springboot.quartz;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @Description
 * @Author sgl
 * @Date 2018-06-26 16:52
 */
public class TestTask2 extends QuartzJobBean{
    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println("TestQuartz02----" + sdf.format(new Date()));
    }
}

3、配置定时任务
创建一个QuartzConfig类，并添加@Configuration注解，内容如下：

package com.songguoliang.springboot.quartz;

import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Description
 * @Author sgl
 * @Date 2018-06-26 16:45
 */
@Configuration
public class QuartzConfig {

    @Bean
    public JobDetail testQuartz1() {
        return JobBuilder.newJob(TestTask1.class).withIdentity("testTask1").storeDurably().build();
    }

    @Bean
    public Trigger testQuartzTrigger1() {
        //5秒执行一次
        SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
                .withIntervalInSeconds(5)
                .repeatForever();
        return TriggerBuilder.newTrigger().forJob(testQuartz1())
                .withIdentity("testTask1")
                .withSchedule(scheduleBuilder)
                .build();
    }

    @Bean
    public JobDetail testQuartz2() {
        return JobBuilder.newJob(TestTask2.class).withIdentity("testTask2").storeDurably().build();
    }

    @Bean
    public Trigger testQuartzTrigger2() {
        //cron方式，每隔5秒执行一次
        return TriggerBuilder.newTrigger().forJob(testQuartz2())
                .withIdentity("testTask2")
                .withSchedule(CronScheduleBuilder.cronSchedule("*/5 * * * * ?"))
                .build();
    }


}

testTask1使用的固定间隔方式，testTask2使用的是cron表达式方式。

4、测试

启动服务，控制台打印出如下信息：

Spring Boot使用Quartz定时任务_maven

Quartz Cron表达式每周、每月执行一次

下面为每周一上午10点15分执行任务
0 15 10 ? * MON

每月10号9点15分钟执行任务
0 15 9 10 * ?

其它规则附录表

表示式	说明
"0 0 12 * * ? "	每天12点运行
“0 15 10 ? * *”	每天10:15运行
“0 15 10 * * ?”	每天10:15运行
“0 15 10 * * ? *”	每天10:15运行
“0 15 10 * * ? 2008”	在2008年的每天10：15运行
“0 * 14 * * ?”	每天14点到15点之间每分钟运行一次，开始于14:00，结束于14:59。
“0 0/5 14 * * ?”	每天14点到15点每5分钟运行一次，开始于14:00，结束于14:55。
“0 0/5 14,18 * * ?”	每天14点到15点每5分钟运行一次，此外每天18点到19点每5钟也运行一次。
“0 0-5 14 * * ?”	每天14:00点到14:05，每分钟运行一次。
“0 10,44 14 ? 3 WED”	3月每周三的14:10分到14:44，每分钟运行一次。
“0 15 10 ? * MON-FRI”	每周一，二，三，四，五的10:15分运行。
“0 15 10 15 * ?”	每月15日10:15分运行。
“0 15 10 L * ?”	每月最后一天10:15分运行。
“0 15 10 ? * 6L”	每月最后一个星期五10:15分运行。
“0 15 10 ? * 6L 2007-2009”	在2007,2008,2009年每个月的最后一个星期五的10:15分运行。
“0 15 10 ? * 6#3”	每月第三个星期五的10:15分运行。