Spring Batch

Spring Batch是一个轻量级、全面的批处理框架，旨在支持开发对企业系统日常运营至关重要的强大批处理应用程序。Spring Batch建立在人们所熟知的Spring Framework的生产力、基于POJO的开发方法和一般易用性功能之上，同时让开发人员能够在需要时轻松访问和利用更高级的企业服务。

如果您正在寻找批处理应用程序的运行时编排工具，或需要查看当前和历史执行的管理控制台，请查看Spring Cloud Data Flow。它是一个用于部署和执行基于数据集成的微服务（包括Spring Batch应用程序）的编排工具。

入门指南

两分钟教程

这个快速教程向您展示了如何设置一个最小项目来使用Spring Batch运行一个简单的批处理作业。

在您喜欢的IDE中，创建一个新的基于Maven的Java 17+项目，并添加以下依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.batch</groupId>
        <artifactId>spring-batch-core</artifactId>
        <version>${LATEST_VERSION}</version>
    </dependency>
    <dependency>
        <groupId>org.hsqldb</groupId>
        <artifactId>hsqldb</artifactId>
        <version>${LATEST_VERSION}</version>
        <scope>runtime</scope>
    </dependency>
</dependencies>

然后，创建一个配置类来定义作业存储库将使用的数据源和事务管理器：

import javax.sql.DataSource;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.support.JdbcTransactionManager;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;

@Configuration
public class DataSourceConfiguration {

    @Bean
    public DataSource dataSource() {
        return new EmbeddedDatabaseBuilder()
            .addScript("/org/springframework/batch/core/schema-hsqldb.sql")
            .build();
    }

    @Bean
    public JdbcTransactionManager transactionManager(DataSource dataSource) {
        return new JdbcTransactionManager(dataSource);
    }

}

在本教程中，创建了一个嵌入式HSQLDB数据库，并使用Spring Batch的元数据表进行初始化。

最后，创建一个类来定义批处理作业：

import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.batch.core.job.builder.JobBuilder;
import org.springframework.batch.core.launch.JobLauncher;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.step.builder.StepBuilder;
import org.springframework.batch.repeat.RepeatStatus;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.jdbc.support.JdbcTransactionManager;

@Configuration
@EnableBatchProcessing
@Import(DataSourceConfiguration.class)
public class HelloWorldJobConfiguration {

    @Bean
    public Step step(JobRepository jobRepository, JdbcTransactionManager transactionManager) {
        return new StepBuilder("step", jobRepository).tasklet((contribution, chunkContext) -> {
            System.out.println("Hello world!");
            return RepeatStatus.FINISHED;
        }, transactionManager).build();
    }

    @Bean
    public Job job(JobRepository jobRepository, Step step) {
        return new JobBuilder("job", jobRepository).start(step).build();
    }

    public static void main(String[] args) throws Exception {
        ApplicationContext context = new AnnotationConfigApplicationContext(HelloWorldJobConfiguration.class);
        JobLauncher jobLauncher = context.getBean(JobLauncher.class);
        Job job = context.getBean(Job.class);
        jobLauncher.run(job, new JobParameters());
    }

}

本教程中的作业由一个单独的步骤组成，该步骤将"Hello world!"打印到标准输出。

现在您可以运行HelloWorldJobConfiguration类的main方法来启动作业。输出应类似于以下内容：

INFO: Finished Spring Batch infrastructure beans configuration in 8 ms.
INFO: Starting embedded database: url='jdbc:hsqldb:mem:testdb', username='sa'
INFO: No database type set, using meta data indicating: HSQL
INFO: No Micrometer observation registry found, defaulting to ObservationRegistry.NOOP
INFO: No TaskExecutor has been set, defaulting to synchronous executor.
INFO: Job: [SimpleJob: [name=job]] launched with the following parameters: [{}]
INFO: Executing step: [step]
Hello world!
INFO: Step: [step] executed in 10ms
INFO: Job: [SimpleJob: [name=job]] completed with the following parameters: [{}] and the following status: [COMPLETED] in 25ms

入门指南

这个指南是一个更现实的教程，展示了一个典型的ETL批处理作业，从平面文件读取数据，转换数据并将其写入关系数据库。 这是一个基于Spring Boot的Spring Batch项目。您可以在这里找到入门指南：创建批处理服务。

示例

您可以在这里找到几个可以尝试的示例：Spring Batch示例。

获取帮助

如果您有问题或需要支持，请在GitHub讨论上开启新的讨论 或在StackOverflow上提问。

请不要在问题跟踪器上创建问题或支持请求。 我们希望将问题跟踪器专门用于错误报告和功能请求。

报告问题

Spring Batch使用GitHub Issues来记录错误和功能请求。如果您想提出问题，请遵循以下建议：

• 在您打开问题之前，请搜索问题跟踪器，看看是否有人已经报告了该问题。如果问题尚不存在，请创建一个新问题。
• 请按照问题报告模板在问题报告中提供尽可能多的信息。
• 如果您需要粘贴代码或包含堆栈跟踪，请在文本前后使用Markdown转义（```）。

对于非简单的错误，请创建一个复现问题的测试用例或项目，并将其附加到问题上，详见问题报告指南。

报告安全漏洞

请查看我们的安全政策。

从源代码构建

使用命令行

使用GitHub主页上的URL克隆git仓库：

$ git clone git@github.com:spring-projects/spring-batch.git
$ cd spring-batch

Maven是Spring Batch使用的构建工具。您可以使用以下命令构建项目：

$ ./mvnw package

如果您想执行包含所有集成测试的完整构建，请运行：

$ ./mvnw verify

请注意，一些集成测试基于Docker，所以在运行完整构建之前，请确保Docker已启动并运行。

要生成参考文档，请运行以下命令：

$ cd spring-batch-docs
$ ../mvnw antora:antora

参考文档可以在spring-batch-docs/target/anotra/site中找到。

使用Docker

如果您想在Docker容器中构建项目，可以按以下步骤进行：

$> docker run -it --mount type=bind,source="$(pwd)",target=/spring-batch maven:3-openjdk-17 bash
#> cd spring-batch
#> ./mvnw package

这将把您之前在主机上克隆的源代码挂载到容器内部。 如果您想在容器内使用源代码的副本（对主机没有副作用）， 可以按以下步骤进行：

$> docker run -it maven:3-openjdk-17 bash
#> git clone https://github.com/spring-projects/spring-batch.git
#> cd spring-batch
#> ./mvnw package

为Spring Batch做贡献

我们欢迎任何形式的贡献！以下是一些您可以为项目做出贡献的方式：

• 通过回答问题和参与讨论，在Twitter、GitHub讨论和StackOverflow上参与Spring Batch社区。
• 为错误和新功能创建问题，或对您感兴趣的问题进行评论和投票。
• 通过遵循问题报告指南，帮助我们重现标记为状态：需要帮助重现的问题。
• GitHub是用于社交编码的：如果您想编写代码，我们鼓励通过拉取请求进行贡献。如果您想以这种方式贡献代码，请熟悉这里概述的流程：贡献者指南。
• 关注spring.io上与Spring Batch相关的文章。

在我们接受拉取请求之前，我们需要您签署贡献者协议。签署贡献者协议并不会授予任何人对主仓库的提交权限，但这意味着我们可以接受您的贡献，如果我们这样做，您将获得作者署名。活跃的贡献者可能会被邀请加入核心团队，并被授予合并拉取请求的能力。

行为准则

请查看我们的行为准则。

许可证

Spring Batch是在Apache 2.0许可证下发布的开源软件。