对于最新的稳定版本，请使用 spring-cloud-task 3.3.0！spring-doc.cadn.net.cn

开始

如果您刚刚开始使用 Spring Cloud Task，您应该阅读本节。在这里，我们回答基本的“什么”、“如何”和“为什么”问题。我们从温和地介绍 Spring Cloud Task。然后我们构建一个 Spring Cloud Task 应用程序，边走边讨论一些核心原则。spring-doc.cadn.net.cn

Spring Cloud Task 简介

Spring Cloud Task 可以轻松创建短期微服务。它提供了允许在生产中按需执行短期 JVM 流程的功能环境。spring-doc.cadn.net.cn

系统要求

您需要安装 Java（Java 17 或更高版本）。spring-doc.cadn.net.cn

数据库要求

Spring Cloud Task 使用关系数据库来存储已执行任务的结果。虽然您可以在没有数据库的情况下开始开发任务（任务的状态已记录作为任务存储库更新的一部分），对于生产环境，您希望使用受支持的数据库。Spring Cloud Task 目前支持以下数据库：spring-doc.cadn.net.cn

开发您的第一个 Spring Cloud 任务应用程序

一个好的起点是从一个简单的“Hello， World！”应用程序开始，因此我们创建了 Spring Cloud Task 等效，突出框架的特性。大多数 IDE 都有对 Apache Maven 的良好支持，因此我们将其用作该项目的构建工具。spring-doc.cadn.net.cn

spring.io 网站包含许多“Getting Started” 指南使用 Spring Boot 的。如果您需要解决特定问题，请先检查那里。您可以通过转到 Spring Initializr 并创建一个新项目来快捷执行以下步骤。这样做自动生成新的项目结构，以便您可以立即开始编码。我们建议尝试使用 Spring Initializr 来熟悉它。

使用 Spring Initializr 创建 Spring 任务项目

现在我们可以创建和测试一个打印Hello, World!到控制台。spring-doc.cadn.net.cn

为此，请执行以下作：spring-doc.cadn.net.cn

访问 Spring Initialzr 网站。spring-doc.cadn.net.cn
1. 创建一个组名称为io.spring.demo和 Artifact 名称helloworld.spring-doc.cadn.net.cn
2. 在依赖项文本框中，键入task，然后选择Task依赖于Spring Cloud标签。spring-doc.cadn.net.cn
3. 在依赖项文本框中，键入h2，然后选择H2依赖于SQL标签。spring-doc.cadn.net.cn
4. 单击“生成项目”按钮spring-doc.cadn.net.cn
解压缩 helloworld.zip 文件并将项目导入到您最喜欢的 IDE 中。spring-doc.cadn.net.cn

编写代码

要完成我们的应用程序，我们需要更新生成的HelloworldApplication替换为以下内容，以便启动任务。spring-doc.cadn.net.cn

import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.task.configuration.EnableTask;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
@EnableTask
public class HelloworldApplication {

	@Bean
	public ApplicationRunner applicationRunner() {
		return new HelloWorldApplicationRunner();
	}

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

	public static class HelloWorldApplicationRunner implements ApplicationRunner {

		@Override
		public void run(ApplicationArguments args) throws Exception {
			System.out.println("Hello, World!");

		}
	}
}

虽然它看起来很小，但正在发生相当多的事情。有关 Spring 的更多信息引导细节，请参阅 Spring Boot 参考文档。spring-doc.cadn.net.cn

现在我们可以打开application.properties文件输入src/main/resources. 我们需要在application.properties:spring-doc.cadn.net.cn

application.name：设置应用程序名称（转换为任务名称）spring-doc.cadn.net.cn
logging.level：将 Spring Cloud Task 的日志记录设置为DEBUG为了了解正在发生的事情。spring-doc.cadn.net.cn

以下示例演示了如何同时执行这两项作：spring-doc.cadn.net.cn

logging.level.org.springframework.cloud.task=DEBUG
spring.application.name=helloWorld

任务自动配置

当包含 Spring Cloud Task Starter 依赖项时，Task 会自动配置所有 bean 以引导其功能。此配置的一部分注册了TaskRepository以及使用它的基础设施。spring-doc.cadn.net.cn

在我们的演示中，TaskRepository使用嵌入式 H2 数据库记录结果任务的。此 H2 嵌入式数据库对于生产环境来说并不是一个实用的解决方案，因为任务结束后，H2 数据库就会消失。但是，为了快速入门经验，我们可以在示例中使用它，并将正在更新的内容回显到日志中在该存储库中。在“配置”部分（后面的文档），我们将介绍如何自定义由 Spring Cloud 任务。spring-doc.cadn.net.cn

当我们的示例应用程序运行时，Spring Boot 会启动我们的HelloWorldApplicationRunner并将我们的“Hello， World！”消息输出到标准输出。这TaskLifecycleListener在存储库中记录任务的开始和结束。spring-doc.cadn.net.cn

主要方法

main 方法充当任何 java 应用程序的入口点。我们的主要方法委托给 Spring Boot 的 SpringApplication 类。spring-doc.cadn.net.cn

应用程序运行器

Spring 包含许多引导应用程序逻辑的方法。Spring Boot 提供一种通过其*Runner接口 (CommandLineRunner或ApplicationRunner).一个行为良好的任务可以引导任何逻辑，使用这两个运行器之一。spring-doc.cadn.net.cn

任务的生命周期从*Runner#run方法被执行等它们全部完成后。Spring Boot 允许应用程序使用多个*Runner实现，Spring Cloud Task 也是如此。spring-doc.cadn.net.cn

从除CommandLineRunner或ApplicationRunner（通过使用InitializingBean#afterPropertiesSet例如）不是由 Spring Cloud Task 录制。

运行示例

此时，我们的应用程序应该可以工作。由于此应用程序是基于 Spring Boot 的，我们可以使用$ ./mvnw spring-boot:run从根源如以下示例所示（及其输出）：spring-doc.cadn.net.cn

$ mvn clean spring-boot:run
....... . . .
....... . . . (Maven log output here)
....... . . .

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v3.2.1)

2024-01-04T10:07:01.102-06:00  INFO 18248 --- [helloWorld] [           main] i.s.d.helloworld.HelloworldApplication   : Starting HelloworldApplication using Java 21.0.1 with PID 18248 (/Users/dashaun/fun/dashaun/spring-cloud-task/helloworld/target/classes started by dashaun in /Users/dashaun/fun/dashaun/spring-cloud-task/helloworld)
2024-01-04T10:07:01.103-06:00  INFO 18248 --- [helloWorld] [           main] i.s.d.helloworld.HelloworldApplication   : No active profile set, falling back to 1 default profile: "default"
2024-01-04T10:07:01.526-06:00  INFO 18248 --- [helloWorld] [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
2024-01-04T10:07:01.626-06:00  INFO 18248 --- [helloWorld] [           main] com.zaxxer.hikari.pool.HikariPool        : HikariPool-1 - Added connection conn0: url=jdbc:h2:mem:3ad913f8-59ce-4785-bf8e-d6335dff6856 user=SA
2024-01-04T10:07:01.627-06:00  INFO 18248 --- [helloWorld] [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
2024-01-04T10:07:01.633-06:00 DEBUG 18248 --- [helloWorld] [           main] o.s.c.t.c.SimpleTaskAutoConfiguration    : Using org.springframework.cloud.task.configuration.DefaultTaskConfigurer TaskConfigurer
2024-01-04T10:07:01.633-06:00 DEBUG 18248 --- [helloWorld] [           main] o.s.c.t.c.DefaultTaskConfigurer          : No EntityManager was found, using DataSourceTransactionManager
2024-01-04T10:07:01.639-06:00 DEBUG 18248 --- [helloWorld] [           main] o.s.c.t.r.s.TaskRepositoryInitializer    : Initializing task schema for h2 database
2024-01-04T10:07:01.772-06:00 DEBUG 18248 --- [helloWorld] [           main] o.s.c.t.r.support.SimpleTaskRepository   : Creating: TaskExecution{executionId=0, parentExecutionId=null, exitCode=null, taskName='helloWorld', startTime=2024-01-04T10:07:01.757268, endTime=null, exitMessage='null', externalExecutionId='null', errorMessage='null', arguments=[]}
2024-01-04T10:07:01.785-06:00  INFO 18248 --- [helloWorld] [           main] i.s.d.helloworld.HelloworldApplication   : Started HelloworldApplication in 0.853 seconds (process running for 1.029)
Hello, World!
2024-01-04T10:07:01.794-06:00 DEBUG 18248 --- [helloWorld] [           main] o.s.c.t.r.support.SimpleTaskRepository   : Updating: TaskExecution with executionId=1 with the following {exitCode=0, endTime=2024-01-04T10:07:01.787112, exitMessage='null', errorMessage='null'}
2024-01-04T10:07:01.799-06:00  INFO 18248 --- [helloWorld] [ionShutdownHook] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Shutdown initiated...
2024-01-04T10:07:01.806-06:00  INFO 18248 --- [helloWorld] [ionShutdownHook] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Shutdown completed.

....... . . .
....... . . . (Maven log output here)
....... . . .

前面的输出有三行，我们在这里感兴趣：spring-doc.cadn.net.cn

SimpleTaskRepository在TaskRepository.spring-doc.cadn.net.cn
执行我们的ApplicationRunner，由“Hello， World！” 输出演示。spring-doc.cadn.net.cn
SimpleTaskRepository将任务的完成记录在TaskRepository.spring-doc.cadn.net.cn

可以在 Spring Cloud 的示例模块中找到一个简单的任务应用程序任务项目在这里。