开始
如果您刚开始使用 Spring Cloud Task,您应该阅读本节。在这里,我们将回答基本的“是什么?”、“如何做?”和“为什么?”等问题。我们首先对 Spring Cloud Task 进行简单介绍。然后,我们构建一个 Spring Cloud Task 应用程序,并在过程中讨论一些核心原则。
开发您的第一个 Spring Cloud Task 应用程序
一个好的起点是一个简单的“Hello, World!”应用程序,因此我们创建 Spring Cloud Task 等效应用程序以突出框架的功能。大多数 IDE 对 Apache Maven 都有很好的支持,因此我们将其用作此项目的构建工具。
spring.io 网站包含许多使用 Spring Boot 的“入门”指南。如果您需要解决特定问题,请先在那里查看。您可以通过访问 Spring Initializr 并创建一个新项目来简化以下步骤。这样做会自动生成新的项目结构,以便您可以立即开始编写代码。我们建议尝试使用 Spring Initializr 来熟悉它。 |
使用 Spring Initializr 创建 Spring Task 项目
现在我们可以创建并测试一个在控制台打印 Hello, World! 的应用程序。
为此:
-
访问 Spring Initializr 网站。
-
创建一个新的 Maven 项目,Group 名称为
io.spring.demo,Artifact 名称为helloworld。 -
在 Dependencies 文本框中,输入
task,然后选择带有Spring Cloud标签的Task依赖项。 -
在 Dependencies 文本框中,输入
h2,然后选择带有SQL标签的H2依赖项。 -
点击 Generate Project 按钮
-
-
解压 helloworld.zip 文件,并将项目导入您喜欢的 IDE。
编写代码
为了完成我们的应用程序,我们需要用以下内容更新生成的 HelloworldApplication,以便它启动一个任务。
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 Boot 的具体细节,请参阅 Spring Boot 参考文档。
现在我们可以打开 src/main/resources 中的 application.properties 文件。我们需要在 application.properties 中配置两个属性:
-
application.name:设置应用程序名称(它被转换为任务名称) -
logging.level:将 Spring Cloud Task 的日志记录设置为DEBUG,以便查看正在发生的事情。
以下示例展示了如何同时执行这两项操作
logging.level.org.springframework.cloud.task=DEBUG
spring.application.name=helloWorld
任务自动配置
当包含 Spring Cloud Task Starter 依赖项时,Task 会自动配置所有 bean 以启动其功能。此配置的一部分注册了 TaskRepository 及其基础设施。
在我们的演示中,TaskRepository 使用嵌入式 H2 数据库来记录任务的结果。这个 H2 嵌入式数据库对于生产环境来说不是一个实用的解决方案,因为任务结束后 H2 DB 就会消失。然而,对于快速入门体验,我们可以在示例中使用它,并将其更新到日志中,以显示该仓库中正在更新的内容。在配置部分(本文档稍后),我们将介绍如何自定义 Spring Cloud Task 提供的组件的配置。
当我们的示例应用程序运行时,Spring Boot 会启动我们的 HelloWorldApplicationRunner 并将“Hello, World!”消息输出到标准输出。TaskLifecycleListener 在存储库中记录任务的开始和结束。
主方法
main 方法作为任何 Java 应用程序的入口点。我们的 main 方法委托给 Spring Boot 的 SpringApplication 类。
ApplicationRunner
Spring 包含多种引导应用程序逻辑的方法。Spring Boot 通过其 *Runner 接口(CommandLineRunner 或 ApplicationRunner)提供了一种方便且有组织的方法。一个行为良好的任务可以通过使用这些运行器中的一个来引导任何逻辑。
任务的生命周期被认为是:在 *Runner#run 方法执行之前开始,直到所有方法都完成。Spring Boot 允许应用程序使用多个 *Runner 实现,Spring Cloud Task 也是如此。
通过 CommandLineRunner 或 ApplicationRunner 以外的机制(例如,使用 InitializingBean#afterPropertiesSet)引导的任何处理都不会被 Spring Cloud Task 记录。 |
运行示例
至此,我们的应用程序应该可以工作了。由于此应用程序是基于 Spring Boot 的,我们可以从应用程序根目录使用 $ ./mvnw spring-boot:run 从命令行运行它,如以下示例所示(及其输出):
$ mvn clean spring-boot:run
....... . . .
....... . . . (Maven log output here)
....... . . .
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v3.3.0)
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)
....... . . .
前面的输出中有三行是我们感兴趣的:
-
SimpleTaskRepository记录了TaskRepository中条目的创建。 -
我们的
ApplicationRunner的执行,由“Hello, World!”输出演示。 -
SimpleTaskRepository记录了TaskRepository中任务的完成。
| 一个简单的任务应用程序可以在 Spring Cloud Task 项目的 samples 模块中找到这里。 |