此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 spring-cloud-task 3.1.3！spring-doc.cadn.net.cn

特征

本节将更详细地介绍 Spring Cloud Task，包括如何使用它、如何 进行配置，并配置相应的扩展点。spring-doc.cadn.net.cn

Spring Cloud 任务的生命周期

在大多数情况下，现代云环境是围绕流程的执行而设计的 预计不会结束。如果它们确实结束了，它们通常会重新启动。虽然大多数 平台确实有一些方法可以运行在结束时不会重新启动的进程， 该运行的结果通常不会以可消耗的方式进行维护。Spring Cloud Task 提供了在环境中执行短期进程并记录 结果。这样做允许围绕短期进程构建微服务架构，例如 以及通过消息集成任务来运行时间更长的服务。spring-doc.cadn.net.cn

虽然此功能在云环境中很有用，但在 传统的部署模型也是如此。当使用 调度程序（例如 cron）中，能够监控 应用程序。spring-doc.cadn.net.cn

Spring Cloud Task 采用的方法是 Spring Boot 应用程序可以有一个 start 和 结束并且仍然成功。批处理应用程序是如何处理 预期会结束（而且通常是短暂的）可能会有所帮助。spring-doc.cadn.net.cn

Spring Cloud Task 记录给定任务的生命周期事件。运行时间最长 以大多数 Web 应用程序为代表的进程不保存其生命周期事件。这 作为 Spring Cloud Task 核心的任务。spring-doc.cadn.net.cn

生命周期由单个任务执行组成。这是 配置为任务的 Spring Boot 应用程序（即，它具有 Sprint Cloud 任务依赖项）。spring-doc.cadn.net.cn

在任务开始时，在任何CommandLineRunner或ApplicationRunnerimplementations 中，则TaskRepository记录开始 事件。此事件是通过SmartLifecycle#start被触发 由 Spring 框架。这向系统表明所有 bean 都已准备就绪，并且 在运行任何CommandLineRunner或ApplicationRunner实现 由 Spring Boot 提供。spring-doc.cadn.net.cn

任务的记录仅在成功引导ApplicationContext.如果上下文根本无法引导，则任务的运行不会 记录。

完成所有*Runner#run调用 Spring Boot 或ApplicationContext（由ApplicationFailedEvent），则任务执行为 在存储库中更新结果。spring-doc.cadn.net.cn

如果应用程序需要ApplicationContext以在 完成任务（全部*Runner#run方法，并且任务 repository has been updated），将属性spring.cloud.task.closecontextEnabled设置为 true。

The TaskExecution

存储在TaskRepository在TaskExecutionclass 和 包含以下信息：spring-doc.cadn.net.cn

田 描述

executionidspring-doc.cadn.net.cn

任务运行的唯一 ID。spring-doc.cadn.net.cn

exitCodespring-doc.cadn.net.cn

从ExitCodeExceptionMapper实现。如果没有 退出代码，但ApplicationFailedEvent，则设置 1。否则，它是 假定为 0。spring-doc.cadn.net.cn

taskNamespring-doc.cadn.net.cn

任务的名称，由配置的TaskNameResolver.spring-doc.cadn.net.cn

startTimespring-doc.cadn.net.cn

任务的启动时间，如SmartLifecycle#start叫。spring-doc.cadn.net.cn

endTimespring-doc.cadn.net.cn

任务完成的时间，如ApplicationReadyEvent.spring-doc.cadn.net.cn

exitMessagespring-doc.cadn.net.cn

退出时可获得的任何信息。这可以通过TaskExecutionListener.spring-doc.cadn.net.cn

errorMessagespring-doc.cadn.net.cn

如果异常是任务结束的原因（如ApplicationFailedEvent），则该异常的堆栈跟踪将存储在此处。spring-doc.cadn.net.cn

argumentsspring-doc.cadn.net.cn

一个List字符串命令行参数，因为它们被传递到可执行文件中 引导应用程序。spring-doc.cadn.net.cn

映射退出代码

任务完成后，它会尝试将退出代码返回给作系统。如果我们看一看 在原始示例中，我们可以看到 而不是控制我们应用程序的那个方面。因此，如果引发异常，JVM 返回一个代码，该代码在调试中可能对您有任何用处，也可能没有用处。spring-doc.cadn.net.cn

因此，Spring Boot 提供了一个接口，ExitCodeExceptionMapper，这样您就可以 将未捕获的异常映射到退出代码。这样做可以让您在 exit 级别进行指示 代码，出了什么问题。此外，通过以这种方式映射退出代码， Spring Cloud Task 记录返回的退出代码。spring-doc.cadn.net.cn

如果任务以 SIG-INT 或 SIG-TERM 终止，则退出代码为零，除非 在代码中另有说明。spring-doc.cadn.net.cn

在任务运行时，退出代码将作为 null 存储在存储库中。 任务完成后，将根据所描述的准则存储相应的退出代码 在本节的前面部分。

配置

Spring Cloud Task 提供了一个现成的配置，如DefaultTaskConfigurer和SimpleTaskConfiguration类。本节将介绍 默认值以及如何根据您的需要自定义 Spring Cloud Task。spring-doc.cadn.net.cn

数据源

Spring Cloud Task 使用数据源来存储任务执行的结果。由 default，我们提供了一个 H2 的内存实例来提供一个简单的 引导开发。但是，在生产环境中，您可能希望 配置您自己的DataSource.spring-doc.cadn.net.cn

如果您的应用程序仅使用单个DataSource这既是您的业务 schema 和 task 存储库，您需要做的就是提供任何DataSource（ 最简单的方法是通过 Spring Boot 的配置约定）。这DataSource由 Spring Cloud Task 自动用于存储库。spring-doc.cadn.net.cn

如果您的应用程序使用多个DataSource，您需要配置任务 repository 替换为适当的DataSource.此自定义可以通过 实现TaskConfigurer.spring-doc.cadn.net.cn

表前缀

的一个可修改属性TaskRepository是任务表的表前缀。由 default，它们都以TASK_.TASK_EXECUTION和TASK_EXECUTION_PARAMS是两个例子。但是，有一些可能的原因需要修改此前缀。如果 schema name 需要在表名前面加上，或者如果有多组任务 表，则必须更改表前缀。您可以这样做 通过设置spring.cloud.task.tablePrefix添加到所需的前缀，如下所示：spring-doc.cadn.net.cn

spring.cloud.task.tablePrefix=yourPrefixspring-doc.cadn.net.cn

通过使用spring.cloud.task.tablePrefix，用户承担 创建同时满足 Task Table 架构条件但 Task Table Table 以及用户业务需求所需的修改。 在创建自己的任务 DDL 时，您可以使用 Spring Cloud 任务架构 DDL 作为指南，如下所示。spring-doc.cadn.net.cn

启用/禁用表初始化

如果您正在创建任务表，并且不希望 Spring Cloud Task 创建它们时，将spring.cloud.task.initialize-enabledproperty 设置为false如下：spring-doc.cadn.net.cn

spring.cloud.task.initialize-enabled=falsespring-doc.cadn.net.cn

它默认为true.spring-doc.cadn.net.cn

物业spring.cloud.task.initialize.enable已弃用。

外部生成的任务 ID

在某些情况下，您可能希望允许任务 请求以及基础设施实际启动它的时间。Spring Cloud Task 允许您 创建一个TaskExecution请求任务时。然后传递 生成TaskExecution添加到任务中，以便它可以更新TaskExecution通过 任务的生命周期。spring-doc.cadn.net.cn

一个TaskExecution可以通过调用createTaskExecution方法在 实现TaskRepository引用保存 这TaskExecution对象。spring-doc.cadn.net.cn

为了将您的任务配置为使用生成的TaskExecutionId，请添加 以下属性：spring-doc.cadn.net.cn

spring.cloud.task.executionid=yourtaskIdspring-doc.cadn.net.cn

外部任务 ID

Spring Cloud Task 允许您为每个TaskExecution.为了将您的任务配置为使用生成的TaskExecutionId，请添加 以下属性：spring-doc.cadn.net.cn

spring.cloud.task.external-execution-id=<externalTaskId>spring-doc.cadn.net.cn

父任务 ID

Spring Cloud Task 允许您为每个TaskExecution.一个例子 这将是一个执行另一个任务或多个任务的任务，并且您想要记录哪个任务 启动了每个子任务。为了配置您的任务以设置父级TaskExecutionId在子任务上添加以下属性：spring-doc.cadn.net.cn

spring.cloud.task.parent-execution-id=<parentExecutionTaskId>spring-doc.cadn.net.cn

TaskConfigurer

这TaskConfigurer是一个策略界面，可让您自定义 Spring Cloud Task 的默认情况下，我们提供DefaultTaskConfigurer那 提供逻辑默认值：Map-based in-memory 组件（如果没有，则对开发很有用DataSource）和基于 JDBC 的组件（如果存在DataSourceavailable） 的 Vue。spring-doc.cadn.net.cn

这TaskConfigurer允许您配置三个主要组件：spring-doc.cadn.net.cn

元件 描述 Default（由DefaultTaskConfigurer)

TaskRepositoryspring-doc.cadn.net.cn

的TaskRepository以供使用。spring-doc.cadn.net.cn

SimpleTaskRepositoryspring-doc.cadn.net.cn

TaskExplorerspring-doc.cadn.net.cn

的TaskExplorer（用于对任务进行只读访问的组件 repository） 以供使用。spring-doc.cadn.net.cn

SimpleTaskExplorerspring-doc.cadn.net.cn

PlatformTransactionManagerspring-doc.cadn.net.cn

运行任务更新时使用的事务管理器。spring-doc.cadn.net.cn

JdbcTransactionManager如果DataSource被使用。ResourcelessTransactionManager如果不是。spring-doc.cadn.net.cn

您可以通过创建 自定义实现TaskConfigurer接口。通常，扩展DefaultTaskConfigurer（如果TaskConfigurer未找到）和 覆盖所需的 getter 就足够了。但是，从头开始实施您自己的 可能需要。spring-doc.cadn.net.cn

用户不应直接使用TaskConfigurer径直 除非他们使用它来提供要作为 Spring Beans 公开的实现。

任务执行侦听器

TaskExecutionListener允许您为期间发生的特定事件注册侦听器 任务生命周期。为此，请创建一个实现TaskExecutionListener接口。实现TaskExecutionListenerinterface 收到以下事件的通知：spring-doc.cadn.net.cn

Spring Cloud Task 还允许您添加TaskExecutionBean 中方法的侦听器 使用以下方法注释：spring-doc.cadn.net.cn

以下示例显示了正在使用的三个注释：spring-doc.cadn.net.cn

 public class MyBean {

	@BeforeTask
	public void methodA(TaskExecution taskExecution) {
	}

	@AfterTask
	public void methodB(TaskExecution taskExecution) {
	}

	@FailedTask
	public void methodC(TaskExecution taskExecution, Throwable throwable) {
	}
}
插入ApplicationListener在链中早于TaskLifecycleListenerexists 可能会导致意外效果。

Task Execution Listener 引发的异常

如果TaskExecutionListener事件处理程序、所有侦听器 该事件处理程序的处理将停止。例如，如果三个onTaskStartup听众 已启动，第一个onTaskStartup事件处理程序抛出异常，则另一个 二onTaskStartup方法。但是，其他事件处理程序 （onTaskEnd和onTaskFailed） 的TaskExecutionListeners被调用。spring-doc.cadn.net.cn

当TaskExecutionListenerevent handler 是 ExitCodeEvent 报告的退出代码。 如果没有ExitCodeEvent时，会评估抛出的 Exception 以查看 如果它是 ExitCodeGenerator 类型。 如果是这样，它将返回ExitCodeGenerator.否则1返回。spring-doc.cadn.net.cn

如果在onTaskStartup方法，则应用程序的退出代码将为1. 如果在onTaskEnd或onTaskFailed方法，则应用程序的退出代码将是使用上面列举的规则建立的代码。spring-doc.cadn.net.cn

如果在onTaskStartup,onTaskEnd或onTaskFailed您不能使用ExitCodeExceptionMapper.

退出消息

您可以使用TaskExecutionListener.这是通过设置TaskExecution’s exitMessage, 然后将其传递到TaskExecutionListener.以下示例显示了 一个带有@AfterTask ExecutionListener:spring-doc.cadn.net.cn

@AfterTask
public void afterMe(TaskExecution taskExecution) {
    taskExecution.setExitMessage("AFTER EXIT MESSAGE");
}

一ExitMessage可以在任何侦听器事件 （onTaskStartup,onTaskFailed和onTaskEnd).三个侦听器的优先顺序如下：spring-doc.cadn.net.cn

  1. onTaskEndspring-doc.cadn.net.cn

  2. onTaskFailedspring-doc.cadn.net.cn

  3. onTaskStartupspring-doc.cadn.net.cn

例如，如果您将exitMessage对于onTaskStartup和onTaskFailedlisteners 的 intent 和 Bug 的exitMessage从onTaskStartup存储在存储库中。否则，如果发生故障，则exitMessage从 这onTaskFailed被存储。此外，如果您将exitMessage替换为onTaskEndlistener 中，exitMessage从onTaskEnd取代 来自onTaskStartup和onTaskFailed.spring-doc.cadn.net.cn

限制 Spring Cloud 任务实例

Spring Cloud Task 允许您确定只能运行一个具有给定任务名称的任务 一次。为此，您需要建立任务名称并将spring.cloud.task.single-instance-enabled=true对于每个任务执行。虽然第一个 任务执行正在运行，其他任何一次您尝试运行具有相同任务名称的任务，并且spring.cloud.task.single-instance-enabled=true这 任务失败，并显示以下错误消息：Task with name "application" is already running.的默认值spring.cloud.task.single-instance-enabled是false.这 以下示例演示如何设置spring.cloud.task.single-instance-enabled自true:spring-doc.cadn.net.cn

spring.cloud.task.single-instance-enabled=true or falsespring-doc.cadn.net.cn

要使用此功能，您必须将以下 Spring 集成依赖项添加到您的 应用：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-core</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-jdbc</artifactId>
</dependency>
如果任务失败，应用程序的退出代码将为 1，因为此功能 已启用，并且另一个任务正在以相同的任务名称运行。

Spring AOT 和本机编译的单实例使用

要在创建本机编译的应用程序时使用 Spring Cloud Task 的单实例功能，您需要在构建时启用该功能。 为此，请添加 process-aot 执行并将spring.cloud.task.single-step-instance-enabled=true作为 JVM 参数，如下所示：spring-doc.cadn.net.cn

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>process-aot</id>
            <goals>
                <goal>process-aot</goal>
            </goals>
            <configuration>
                <jvmArguments>
                    -Dspring.cloud.task.single-instance-enabled=true
                </jvmArguments>
            </configuration>
        </execution>
    </executions>
</plugin>

为 ApplicationRunner 和 CommandLineRunner 启用观察

为 启用 Task ObservationsApplicationRunner或CommandLineRunner设置spring.cloud.task.observation.enabled设置为 true。spring-doc.cadn.net.cn

包含观察项的示例任务应用程序允许使用SimpleMeterRegistry可以在这里找到。spring-doc.cadn.net.cn

禁用 Spring Cloud 任务自动配置

如果不应为实现自动配置 Spring Cloud Task，则可以禁用 Task 的自动配置。 这可以通过向 Task 应用程序添加以下注释来完成：spring-doc.cadn.net.cn

@EnableAutoConfiguration(exclude={SimpleTaskAutoConfiguration.class})

您还可以通过设置spring.cloud.task.autoconfiguration.enabledproperty 设置为false.spring-doc.cadn.net.cn

关闭上下文

如果应用程序需要ApplicationContext以在 完成任务（全部*Runner#run方法，并且任务 repository has been updated），将属性spring.cloud.task.closecontextEnabled自true.spring-doc.cadn.net.cn

关闭上下文的另一种情况是 Task Execution 完成，但应用程序不会终止。 在这些情况下，上下文保持打开状态，因为已分配线程 （例如：如果您使用的是 TaskExecutor）。在这些情况下 将spring.cloud.task.closecontextEnabledproperty 设置为true启动任务时。 这将在任务完成后关闭应用程序的上下文。 从而允许应用程序终止。spring-doc.cadn.net.cn

启用任务指标

Spring Cloud Task 与 Micrometer 集成，并为其执行的 Task 创建观察结果。 要启用 Task Observability 集成，您必须添加spring-boot-starter-actuator、首选注册表实施（如果要发布指标）和千分尺跟踪（如果要发布跟踪数据）到任务应用程序。 使用 Influx 启用任务可观察性和指标的 maven 依赖项集示例为：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-influx</artifactId>
    <scope>runtime</scope>
</dependency>

Spring Task 和 Spring Cloud Task 属性

术语task是业内常用的词。在一个这样的示例中，Spring Boot 提供了spring.task而 Spring Cloud Task 则提供spring.cloud.task性能。 这在过去引起了一些混淆，即这两组属性是直接相关的。但是，它们代表了 Spring 生态系统中提供的 2 组不同的功能。spring-doc.cadn.net.cn