SpringBoot 计划任务

SpringBoot 计划任务

本指南将引导您完成使用Spring计划任务的步骤。

 

你会建立什么

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

 

你需要什么

• 约15分钟

• 最喜欢的文本编辑器或IDE

• JDK 1.8或更高版本

• Gradle 4+或Maven 3.2+

• 您还可以将代码直接导入到IDE中：

  • 弹簧工具套件（STS）

  • IntelliJ IDEA

 

如何完成本指南

像大多数Spring 入门指南一样，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都可以使用工作代码。

要从头开始，请继续使用Gradle构建。

要跳过基础知识，请执行以下操作：

• 下载并解压缩本指南的源存储库，或使用Git对其进行克隆：git clone https://github.com/spring-guides/gs-scheduling-tasks.git

• 光盘进入 gs-scheduling-tasks/initial

• 跳至创建计划任务。

完成后，您可以根据中的代码检查结果gs-scheduling-tasks/complete。

 

用Gradle构建

首先，您设置一个基本的构建脚本。在使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但此处包含使用Gradle和Maven所需的代码。如果您都不熟悉，请参阅使用Gradle 构建Java项目或使用Maven构建Java项目。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如，mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

创建一个Gradle构建文件

以下是最初的Gradle构建文件。

build.gradle

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.2.1.RELEASE")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

bootJar {
    baseName = 'gs-scheduling-tasks'
    version =  '0.1.0'
}

repositories {
    mavenCentral()
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile("org.springframework.boot:spring-boot-starter")
    testCompile("junit:junit")
}

在春天的Gradle启动插件提供了许多便捷的功能：

• 它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。

• 它搜索public static void main()要标记为可运行类的方法。

• 它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

 

用Maven构建

首先，您设置一个基本的构建脚本。使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含了使用Maven所需的代码。如果您不熟悉Maven，请参阅使用Maven 构建Java项目。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如，mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

pom.xml

    4.0.0

    org.springframework
    gs-scheduling-tasks
    0.1.0

    
        org.springframework.boot
        spring-boot-starter-parent
        2.2.1.RELEASE
    

    
        1.8
    

    
        
            org.springframework.boot
            spring-boot-starter
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

在春季启动Maven插件提供了许多便捷的功能：

• 它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。

• 它搜索public static void main()要标记为可运行类的方法。

• 它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

 

使用您的IDE进行构建

• 阅读如何将本指南直接导入Spring Tool Suite中。

• 在IntelliJ IDEA中阅读如何使用本指南。

 

创建计划任务

现在，您已经设置了项目，您可以创建计划任务。

src/main/java/hello/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 hello;

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当特定的方法运行注解定义。注意：此示例使用fixedRate，它指定从每次调用的开始时间开始测量的方法调用之间的间隔。还有其他选项，例如fixedDelay，它指定从任务完成开始测量的两次调用之间的间隔。您还可以使用@Scheduled(cron=". . .")表达式进行更复杂的任务调度。

 

启用排程

尽管可以将预定任务嵌入Web应用程序和WAR文件中，但下面演示的更简单的方法可以创建一个独立的应用程序。您可以将所有内容打包到一个可执行的JAR文件中，该文件由一个很好的旧Java main()方法驱动。

src/main/java/hello/Application.java

package hello;

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

@SpringBootApplication
@EnableScheduling
public class Application {

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

@SpringBootApplication 是一个方便注释，它添加了以下所有内容：

• @Configuration：将类标记为应用程序上下文的Bean定义的源。

• @EnableAutoConfiguration：告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。例如，如果spring-webmvc在类路径上，则此注释将应用程序标记为Web应用程序并激活关键行为，例如设置DispatcherServlet。

• @ComponentScan：告诉Spring在包中寻找其他组件，配置和服务hello，让它找到控制器。

该main()方法使用Spring Boot的SpringApplication.run()方法来启动应用程序。您是否注意到没有一行XML？也没有web.xml文件。该Web应用程序是100％纯Java，因此您无需处理任何管道或基础结构。

@EnableScheduling确保创建了后台任务执行程序。没有它，什么都无法安排。

 

构建可执行的JAR

您可以使用Gradle或Maven从命令行运行该应用程序。您还可以构建一个包含所有必需的依赖项，类和资源的可执行JAR文件，然后运行该文件。构建可执行的jar使得在整个开发生命周期中，跨不同环境等等的情况下，可以轻松地将服务作为应用程序进行发行，版本化和部署。

如果使用Gradle，则可以使用运行应用程序./gradlew bootRun。或者，您可以使用来构建JAR文件./gradlew build，然后运行JAR文件，如下所示：

java -jar build/libs/gs-scheduling-tasks-0.1.0.jar

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

java -jar target/gs-scheduling-tasks-0.1.0.jar

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

显示日志记录输出，您可以从日志中看到它在后台线程中。您应该看到计划的任务每5秒触发一次：

[...]
2016-08-25 13:10:00.143  INFO 31565 --- [pool-1-thread-1] hello.ScheduledTasks : The time is now 13:10:00
2016-08-25 13:10:05.143  INFO 31565 --- [pool-1-thread-1] hello.ScheduledTasks : The time is now 13:10:05
2016-08-25 13:10:10.143  INFO 31565 --- [pool-1-thread-1] hello.ScheduledTasks : The time is now 13:10:10
2016-08-25 13:10:15.143  INFO 31565 --- [pool-1-thread-1] hello.ScheduledTasks : The time is now 13:10:15

 

摘要

恭喜你！您使用预定任务创建了一个应用程序。哎呀，实际的代码比构建文件短！该技术适用于任何类型的应用程序。

 

也可以看看

以下指南也可能会有所帮助：

• 使用Spring Boot构建应用程序

• 创建批处理服务

是否要编写新指南或为现有指南做出贡献？查看我们的贡献准则。

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创用CC许可证发布。