springboot任务调度 springboot 调度

转载

墨舞天涯 2024-02-21 14:17:34

文章标签 springboot任务调度 spring boot spring maven java 文章分类 架构后端开发

本章带你用Spring一步一步的实现调度任务。

本文目标

用Spring Boot构建一个应用，使用@Scheduled注解，实现每五秒钟打印一次当前时间。

你需要

15分钟左右
IntelliJ IDEA
JDK 1.8+
Maven 3.2+

用Spring Initializr生成项目代码

对于所有的Spring应用，你都可以使用Spring Initializr生成基本的项目代码。Initializr提供了一个快速的方式去引入所有你需要的依赖，并且为你做了很多设置。当前例子不需要其他Spring依赖。Spring Boot自身提供本例所需的全部Spring库。具体设置如下图：

springboot任务调度 springboot 调度_spring boot

如上图所示，我们选择了Maven作为编译工具。你也可以选择Gradle来进行编译。然后我们分别把Group和Artifact设置为“com.hansy”和“scheduling-tasks”。

生成的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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.3.1.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.hansy</groupId>
	<artifactId>scheduling-tasks</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>scheduling-tasks</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<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>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
	</dependencies>

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

</project>

创建调度任务

你已经设置好了项目，现在你可以创建调度任务了。代码如下：

package com.hansy.schedulingtasks;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

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

@Component
public class ScheduledTasks {

    private static final Logger logger = LoggerFactory.getLogger(ScheduledTasks.class);

    private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");

    @Scheduled(fixedRate = 5000)
    public void reportCurrentTime() {
        logger.info("This time is now {}", dateFormat.format(new Date()));
    }
}

Scheduled注解定义了函数的运行方式。

这个例子使用了fixedRate属性，这个属性指定了函数调用的时间间隔，从每个调用的开始时间开始计时。还有其他的属性，比如说fixedDelay。fixedDelay也是指定函数调用的时间间隔，不过是从每个调用的完成时间开始计时。你也可以使用@Scheduled(cron=". . .") 语句来配置更复杂的执行周期。

开启调度

尽管调度任务可以内置到Web应用和WAR文件里面，但是最简单的实现方式（下面列出的）还是创建一个独立运行的应用程序。把所有东西都打包到一个可执行的JAR文件里，入口是一个Java的maIn()函数。代码如下所示：

package com.hansy.schedulingtasks;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class SchedulingTasksApplication {

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

}

添加@EnableScheduling注解之后，会创建一个后台任务调度器，按计划执行调度任务。

测试结果

运行程序，可以看到日志输出。可以看到调度任务运行在一个后台线程，每五秒钟显示一次当前时间。结果如下所示：

.......
2020-07-10 15:06:32.636  INFO 23496 --- [   scheduling-1] c.hansy.schedulingtasks.ScheduledTasks   : This time is now 15:06:32
2020-07-10 15:06:37.633  INFO 23496 --- [   scheduling-1] c.hansy.schedulingtasks.ScheduledTasks   : This time is now 15:06:37
2020-07-10 15:06:42.632  INFO 23496 --- [   scheduling-1] c.hansy.schedulingtasks.ScheduledTasks   : This time is now 15:06:42
2020-07-10 15:06:47.633  INFO 23496 --- [   scheduling-1] c.hansy.schedulingtasks.ScheduledTasks   : This time is now 15:06:47
.......