Spring调度任务

郭顺发2023-06-282025-03-13

什么是调度任务

@Scheduled将构建一个应用程序，通过使用 Spring 的注释每五秒打印一次当前时间。

前提要求

最喜欢的文本编辑器或 IDE
JDK 1.8或更高版本
Gradle 4+或Maven 3.2+

如何完成调度任务

与大多数 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 开始

您可以使用这个预初始化的项目并单击生成以下载 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，请添加以下依赖项：

<dependency>
  <groupId>org.awaitility</groupId>
  <artifactId>awaitility</artifactId>
  <version>3.1.2</version>
  <scope>test</scope>
</dependency>

以下清单显示了完成的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.7.1</version>
        <relativePath/> <!-- lookup parent from repository -->    </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文件：

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）显示了如何执行此操作：

/* * Copyright 2012-2015 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * *    https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */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;@Componentpublic 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注释定义特定方法何时运行。

	此示例使用`fixedRate`，它指定方法调用之间的间隔，从每次调用的开始时间开始计算。还有其他选项，例如`fixedDelay`，它指定从任务完成开始计算的调用间隔。您还可以使用`@Scheduled(cron=". . .")`表达式进行更复杂的任务调度。

启用调度

尽管计划任务可以嵌入到 Web 应用程序和 WAR 文件中，但更简单的方法（在下一个清单中显示）创建一个独立的应用程序。为此，将所有内容打包到一个可执行的 JAR 文件中，由一个很好的旧 Javamain()方法驱动。以下清单（来自src/main/java/com/example/schedulingtasks/SchedulingTasksApplication.java）显示了应用程序类：

package com.example.schedulingtasks;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.scheduling.annotation.EnableScheduling;@SpringBootApplication@EnableSchedulingpublic 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	java -jar build/libs/gs-scheduling-tasks-0.1.0.jar

如果您使用 Maven，则可以使用./mvnw spring-boot:run. 或者，您可以构建 JAR 文件，./mvnw clean package然后运行 JAR 文件，如下所示：

1	java -jar 目标/gs-scheduling-tasks-0.1.0.jar

	此处描述的步骤创建了一个可运行的 JAR。您还可以构建经典的 WAR 文件。

显示日志输出，从日志可以看出是在后台线程上。您应该会看到您的计划任务每五秒触发一次。以下清单显示了典型的输出：

...
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
...