什么是调度任务 @Scheduled
将构建一个应用程序,通过使用 Spring 的注释每五秒打印一次当前时间。
前提要求
如何完成调度任务 与大多数 Spring入门指南 一样,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,您最终都会得到有效的代码。
要从头开始 ,请转到从 Spring Initializr 开始 。
要跳过基础知识 ,请执行以下操作:
下载 并解压缩本指南的源存储库,或使用Git 克隆它:git clone https://github.com/spring-guides/gs-scheduling-tasks.git
光盘进入gs-scheduling-tasks/initial
跳到创建计划任务 。
完成后 ,您可以根据 中的代码检查结果gs-scheduling-tasks/complete
。
从 Spring Initializr 开始 您可以使用这个[预初始化的项目](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.5.5&packaging=jar&jvmVersion=11&groupId=com.example&artifactId=scheduling-tasks&name=scheduling-tasks&description=Demo project for Spring Boot&packageName=com.example.scheduling-tasks)并单击生成以下载 ZIP 文件。该项目配置为适合本教程中的示例。
手动初始化项目:
导航到https://start.spring.io 。该服务会引入应用程序所需的所有依赖项,并为您完成大部分设置。
选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
单击生成 。
下载生成的 ZIP 文件,它是根据您的选择配置的 Web 应用程序的存档。
如果您的 IDE 集成了 Spring Initializr,您可以从 IDE 中完成此过程。
您还可以从 Github 中 fork 项目并在您的 IDE 或其他编辑器中打开它。
添加awaitility
依赖项(可不添加) 中的测试complete/src/test/java/com/example/schedulingtasks/ScheduledTasksTest.java
需要awaitility
库。
库的更高版本awaitility
不适用于此测试,因此您必须指定版本 3.1.2。
要将awaitility
库添加到 Maven,请添加以下依赖项:
1 2 3 4 5 6 <dependency > <groupId > org.awaitility</groupId > <artifactId > awaitility</artifactId > <version > 3.1.2</version > <scope > test</scope > </dependency >
以下清单显示了完成的pom.xml
文件:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 <?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.7.1</version > <relativePath /> </parent > <groupId > com.example</groupId > <artifactId > scheduling-tasks-complete</artifactId > <version > 0.0.1-SNAPSHOT</version > <name > scheduling-tasks-complete</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.awaitility</groupId > <artifactId > awaitility</artifactId > <version > 3.1.2</version > <scope > test</scope > </dependency > <dependency > <groupId > org.springframework.boot</groupId > <artifactId > spring-boot-starter-test</artifactId > <scope > test</scope > </dependency > </dependencies > <build > <plugins > <plugin > <groupId > org.springframework.boot</groupId > <artifactId > spring-boot-maven-plugin</artifactId > </plugin > </plugins > </build > </project >
要将awaitility
库添加到 Gradle,请添加以下依赖项:
1 testImplementation 'org.awaitility:awaitility:3.1.2'
以下清单显示了完成的build.gradle
文件:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 plugins { id 'org.springframework.boot' version '2.7.1' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter' testImplementation 'org.awaitility:awaitility:3.1.2' testImplementation('org.springframework.boot:spring-boot-starter-test' ) } test { useJUnitPlatform() }
创建计划任务 现在您已经设置了您的项目,您可以创建计划任务。以下清单(来自src/main/java/com/example/schedulingtasks/ScheduledTasks.java
)显示了如何执行此操作:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 package com.example.schedulingtasks;import java.text.SimpleDateFormat;import java.util.Date;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Component public class ScheduledTasks { private static final Logger log = LoggerFactory.getLogger(ScheduledTasks.class); private static final SimpleDateFormat dateFormat = new SimpleDateFormat ("HH:mm:ss" ); @Scheduled(fixedRate = 5000) public void reportCurrentTime () { log.info("The time is now {}" , dateFormat.format(new Date ())); } }
Scheduled
注释定义特定方法何时运行。
启用调度 尽管计划任务可以嵌入到 Web 应用程序和 WAR 文件中,但更简单的方法(在下一个清单中显示)创建一个独立的应用程序。为此,将所有内容打包到一个可执行的 JAR 文件中,由一个很好的旧 Javamain()
方法驱动。以下清单(来自src/main/java/com/example/schedulingtasks/SchedulingTasksApplication.java
)显示了应用程序类:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 package com.example.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); } }
@SpringBootApplication
是一个方便的注解,它添加了以下所有内容:
@Configuration
:将类标记为应用程序上下文的 bean 定义源。
@EnableAutoConfiguration
:告诉 Spring Boot 开始添加基于类路径设置、其他 bean 和各种属性设置的 bean。例如,如果spring-webmvc
在类路径上,此注释将应用程序标记为 Web 应用程序并激活关键行为,例如设置DispatcherServlet
.
@ComponentScan
:告诉 Spring 在包中寻找其他组件、配置和服务com/example
,让它找到控制器。
该main()
方法使用 Spring Boot 的SpringApplication.run()
方法来启动应用程序。您是否注意到没有一行 XML?也没有web.xml
文件。此 Web 应用程序是 100% 纯 Java,您无需处理任何管道或基础设施的配置。
@EnableScheduling
注释确保创建后台任务执行器。没有它,什么都无法安排。
构建可执行 JAR 您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必要依赖项、类和资源的可执行 JAR 文件并运行它。构建可执行 jar 可以轻松地将服务作为应用程序在整个开发生命周期中跨不同环境等进行发布、版本控制和部署。
如果您使用 Gradle,则可以使用./gradlew bootRun
. 或者,您可以使用 构建 JAR 文件./gradlew build
,然后运行 JAR 文件,如下所示:
1 oracle-java -jar build/libs/gs-scheduling-tasks-0.1.0.jar
如果您使用 Maven,则可以使用./mvnw spring-boot:run
. 或者,您可以构建 JAR 文件,./mvnw clean package
然后运行 JAR 文件,如下所示:
1 oracle-java -jar 目标/gs-scheduling-tasks-0.1.0.jar
显示日志输出,从日志可以看出是在后台线程上。您应该会看到您的计划任务每五秒触发一次。以下清单显示了典型的输出:
1 2 3 4 5 6 ... 2019-10-02 12:07:35.659 INFO 28617 --- [ scheduling-1] c.e.schedulingtasks.ScheduledTasks : The time is now 12:07:35 2019-10-02 12:07:40.659 INFO 28617 --- [ scheduling-1] c.e.schedulingtasks.ScheduledTasks : The time is now 12:07:40 2019-10-02 12:07:45.659 INFO 28617 --- [ scheduling-1] c.e.schedulingtasks.ScheduledTasks : The time is now 12:07:45 2019-10-02 12:07:50.657 INFO 28617 --- [ scheduling-1] c.e.schedulingtasks.ScheduledTasks : The time is now 12:07:50 ...
参考文档