创建批处理服务 - springboot guide中文文档

本指南将引导您完成创建一个基本批处理驱动解决方案的过程。

你将构建什么

您将构建一个服务，该服务从 CSV 电子表格中导入数据，使用自定义代码进行转换，并将最终结果存储在数据库中。

所需内容

大约15分钟
一个喜欢的文本编辑器或集成开发环境
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您还可以直接将代码导入到您的 IDE 中：

如何完成本指南

与大多数 Spring 入门指南一样，您可以从头开始并完成每个步骤，也可以跳过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会得到可运行的代码。

要从头开始，请继续阅读从 Spring Initializr 开始。

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

下载并解压缩本指南的源代码仓库，或使用 Git 克隆它：git clone https://github.com/spring-guides/gs-batch-processing.git
进入 gs-batch-processing/initial 目录
跳转到业务数据。

完成后，您可以将您的结果与 gs-batch-processing/complete 中的代码进行对比。

从 Spring Initializr 开始

您可以使用这个预初始化项目并点击生成以下载ZIP文件。该项目已配置为适合本教程中的示例。

要手动初始化项目：

访问 https://start.spring.io。该服务会拉取应用程序所需的所有依赖项，并为您完成大部分设置工作。
选择 Gradle 或 Maven 以及您想要使用的语言。本指南假设您选择了 Java。
点击 Dependencies，然后选择 Spring Batch 和 HyperSQL Database。
点击 Generate。
下载生成的 ZIP 文件，这是一个根据您选择的配置生成的应用程序存档。

如果您的 IDE 集成了 Spring Initializr，您可以直接在 IDE 中完成此过程。

您也可以从 GitHub 上 fork 该项目，并在您的 IDE 或其他编辑器中打开它。

业务数据

通常情况下，您的客户或业务分析师会提供一个电子表格。在这个简单的示例中，您可以在 src/main/resources/sample-data.csv 中找到一些虚构的数据：

Jill,Doe
Joe,Doe
Justin,Doe
Jane,Doe
John,Doe

此电子表格的每一行包含一个名字和一个姓氏，用逗号分隔。这是一个相当常见的模式，Spring 无需自定义即可处理。

接下来，您需要编写一个 SQL 脚本来创建用于存储数据的表。您可以在 src/main/resources/schema-all.sql 中找到此类脚本：

DROP TABLE people IF EXISTS;

CREATE TABLE people  (
    person_id BIGINT IDENTITY NOT NULL PRIMARY KEY,
    first_name VARCHAR(20),
    last_name VARCHAR(20)
);

Spring Boot 在启动时会自动运行 schema-@@platform@@.sql 文件。-all 是所有平台的默认选项。

创建业务类

现在您已经了解了数据输入和输出的格式，您可以编写代码来表示一行数据，如下例所示（来自 src/main/java/com/example/batchprocessing/Person.java）：

package com.example.batchprocessing;

public record Person(String firstName, String lastName) {

}

您可以通过构造函数使用名字和姓氏实例化 Person 记录。

创建中间处理器

批处理中的一个常见范式是：先接收数据，然后对其进行转换，最后将数据输出到其他地方。在这里，您需要编写一个简单的转换器，将名称转换为大写。以下代码片段（来自 src/main/java/com/example/batchprocessing/PersonItemProcessor.java）展示了如何实现这一功能：

package com.example.batchprocessing;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.springframework.batch.item.ItemProcessor;

public class PersonItemProcessor implements ItemProcessor<Person, Person> {

  private static final Logger log = LoggerFactory.getLogger(PersonItemProcessor.class);

  @Override
  public Person process(final Person person) {
    final String firstName = person.firstName().toUpperCase();
    final String lastName = person.lastName().toUpperCase();

    final Person transformedPerson = new Person(firstName, lastName);

    log.info("Converting ({}) into ({})", person, transformedPerson);

    return transformedPerson;
  }

}

PersonItemProcessor 实现了 Spring Batch 的 ItemProcessor 接口。这使得可以轻松地将代码集成到您将在本指南稍后定义的批处理作业中。根据该接口，您会接收到一个传入的 Person 对象，然后将其转换为大写的 Person。

输入和输出类型不一定相同。事实上，在读取一个数据源后，应用程序的数据流有时需要不同的数据类型。

构建一个批处理任务

现在您需要组装实际的批处理作业。Spring Batch 提供了许多实用类，可以减少编写自定义代码的需求。相反，您可以专注于业务逻辑。

为了配置您的作业，您首先需要创建一个 Spring @Configuration 类，如 src/main/java/com/example/batchprocessing/BatchConfiguration.java 中的以下示例所示。该示例使用基于内存的数据库，这意味着当作业完成后，数据将消失。现在，将以下 bean 添加到您的 BatchConfiguration 类中，以定义一个读取器、一个处理器和一个写入器：

@Bean
public FlatFileItemReader<Person> reader() {
  return new FlatFileItemReaderBuilder<Person>()
    .name("personItemReader")
    .resource(new ClassPathResource("sample-data.csv"))
    .delimited()
    .names("firstName", "lastName")
    .targetType(Person.class)
    .build();
}

@Bean
public PersonItemProcessor processor() {
  return new PersonItemProcessor();
}

@Bean
public JdbcBatchItemWriter<Person> writer(DataSource dataSource) {
  return new JdbcBatchItemWriterBuilder<Person>()
    .sql("INSERT INTO people (first_name, last_name) VALUES (:firstName, :lastName)")
    .dataSource(dataSource)
    .beanMapped()
    .build();
}

第一段代码定义了输入、处理器和输出。

reader() 创建一个 ItemReader。它会查找名为 sample-data.csv 的文件，并解析每一行数据，以将其转换为 Person 对象。
processor() 创建您之前定义的 PersonItemProcessor 实例，用于将数据转换为大写。
writer(DataSource) 创建一个 ItemWriter。这个 ItemWriter 面向 JDBC 目标，并自动获取由 Spring Boot 创建的 DataSource。它包含插入单个 Person 所需的 SQL 语句，由 Java 记录组件驱动。

最后一部分代码（来自 src/main/java/com/example/batchprocessing/BatchConfiguration.java）展示了实际的任务配置：

@Bean
public Job importUserJob(JobRepository jobRepository, Step step1, JobCompletionNotificationListener listener) {
  return new JobBuilder("importUserJob", jobRepository)
    .listener(listener)
    .start(step1)
    .build();
}

@Bean
public Step step1(JobRepository jobRepository, DataSourceTransactionManager transactionManager,
          FlatFileItemReader<Person> reader, PersonItemProcessor processor, JdbcBatchItemWriter<Person> writer) {
  return new StepBuilder("step1", jobRepository)
    .<Person, Person>chunk(3, transactionManager)
    .reader(reader)
    .processor(processor)
    .writer(writer)
    .build();
}

第一个方法定义了作业，第二个方法定义了一个步骤。作业由步骤构成，每个步骤可以包含一个读取器、一个处理器和一个写入器。

然后您列出每个步骤（尽管这个作业只有一个步骤）。作业结束，Java API 生成一个完美配置的作业。

在步骤定义中，您定义了每次要写入多少数据。在本例中，它每次最多写入三条记录。接下来，您使用之前注入的 bean 来配置读取器、处理器和写入器。

chunk() 被前缀 <Person,Person> 标识，因为它是一个泛型方法。这表示每个处理“块”的输入和输出类型，并与 ItemReader<Person> 和 ItemWriter<Person> 保持一致。

批处理配置的最后一部分是作业完成时获取通知的方式。以下示例（来自 src/main/java/com/example/batchprocessing/JobCompletionNotificationListener.java）展示了这样一个类：

package com.example.batchprocessing;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.springframework.batch.core.BatchStatus;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobExecutionListener;
import org.springframework.jdbc.core.DataClassRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;

@Component
public class JobCompletionNotificationListener implements JobExecutionListener {

  private static final Logger log = LoggerFactory.getLogger(JobCompletionNotificationListener.class);

  private final JdbcTemplate jdbcTemplate;

  public JobCompletionNotificationListener(JdbcTemplate jdbcTemplate) {
    this.jdbcTemplate = jdbcTemplate;
  }

  @Override
  public void afterJob(JobExecution jobExecution) {
    if (jobExecution.getStatus() == BatchStatus.COMPLETED) {
      log.info("!!! JOB FINISHED! Time to verify the results");

      jdbcTemplate
          .query("SELECT first_name, last_name FROM people", new DataClassRowMapper<>(Person.class))
          .forEach(person -> log.info("Found <{}> in the database.", person));
    }
  }
}

JobCompletionNotificationListener 监听作业何时达到 BatchStatus.COMPLETED 状态，然后使用 JdbcTemplate 来检查结果。

使应用程序可执行

尽管批处理可以嵌入到 Web 应用程序和 WAR 文件中，但下面演示的更简单的方法是创建一个独立的应用程序。您将所有内容打包在一个可执行的 JAR 文件中，由经典的 Java main() 方法驱动。

Spring Initializr 为您创建了一个应用程序类。对于这个简单的示例，它无需进一步修改即可运行。以下代码清单（来自 src/main/java/com/example/batchprocessing/BatchProcessingApplication.java）展示了应用程序类：

package com.example.batchprocessing;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class BatchProcessingApplication {

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

@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 的，您不需要处理任何配置或基础设施。

请注意，SpringApplication.exit() 和 System.exit() 确保作业完成后 JVM 退出。更多详细信息，请参阅 Spring Boot 参考文档中的应用程序退出部分。

为了演示目的，这里有一段代码用于注入 JdbcTemplate，查询数据库，并打印出批量作业插入的人员姓名。

请注意，该应用程序并未使用 @EnableBatchProcessing 注解。以前，@EnableBatchProcessing 可用于启用 Spring Boot 对 Spring Batch 的自动配置。现在，可以定义一个使用 @EnableBatchProcessing 注解或继承 Spring Batch 的 DefaultBatchConfiguration 的 bean，以告知自动配置退出，从而让应用程序完全控制 Spring Batch 的配置。

构建可执行的 JAR 文件

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必要依赖项、类和资源的可执行 JAR 文件并运行它。构建可执行的 JAR 文件使得在整个开发生命周期、跨不同环境等场景下，能够轻松地发布、版本控制和部署该服务。

如果您使用 Gradle，可以通过 ./gradlew bootRun 来运行应用程序。或者，您可以使用 ./gradlew build 构建 JAR 文件，然后按如下方式运行该 JAR 文件：

java -jar build/libs/gs-batch-processing-0.1.0.jar

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

java -jar target/gs-batch-processing-0.1.0.jar

这里描述的步骤创建了一个可运行的 JAR 文件。您也可以构建一个经典的 WAR 文件。

作业会为每个被转换的人打印一行信息。作业运行后，您还可以看到查询数据库的输出。它应该类似于以下输出：

Converting (Person[firstName=Jill, lastName=Doe]) into (Person[firstName=JILL, lastName=DOE])
Converting (Person[firstName=Joe, lastName=Doe]) into (Person[firstName=JOE, lastName=DOE])
Converting (Person[firstName=Justin, lastName=Doe]) into (Person[firstName=JUSTIN, lastName=DOE])
Converting (Person[firstName=Jane, lastName=Doe]) into (Person[firstName=JANE, lastName=DOE])
Converting (Person[firstName=John, lastName=Doe]) into (Person[firstName=JOHN, lastName=DOE])
Found <Person[firstName=JILL, lastName=DOE]> in the database.
Found <Person[firstName=JOE, lastName=DOE]> in the database.
Found <Person[firstName=JUSTIN, lastName=DOE]> in the database.
Found <Person[firstName=JANE, lastName=DOE]> in the database.
Found <Person[firstName=JOHN, lastName=DOE]> in the database.

总结

恭喜！您构建了一个批处理作业，它从电子表格中提取数据，进行处理，并将其写入数据库。

另请参阅

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