很高兴地宣布 Spring Batch 4.1.0.RELEASE 现已可用。

Spring Batch 4.1 GA 新特性概览

本次发布增加了以下功能

• 新的 @SpringBatchTest 注解，简化了批处理组件的测试
• 新的 @EnableBatchIntegration 注解，简化了远程分块和分区配置
• 支持以 JSON 格式读写数据
• 支持使用 Bean Validation API 验证项
• 支持 JSR-305 注解
• 对 FlatFileItemWriterBuilder API 的增强

@SpringBatchTest 注解

Spring Batch 提供了一些实用的工具类（例如 JobLauncherTestUtils 和 JobRepositoryTestUtils）以及测试执行监听器（StepScopeTestExecutionListener 和 JobScopeTestExecutionListener）来测试批处理组件。然而，为了使用这些工具，您必须显式地配置它们。本次发布引入了一个名为 @SpringBatchTest 的新注解，它可以自动将工具 bean 和监听器添加到测试上下文中，并使它们可供自动装配，如下例所示

@RunWith(SpringRunner.class)
@SpringBatchTest
@ContextConfiguration(classes = {JobConfiguration.class})
public class JobTest {

   @Autowired
   private JobLauncherTestUtils jobLauncherTestUtils;

   @Autowired
   private JobRepositoryTestUtils jobRepositoryTestUtils;


   @Before
   public void clearMetadata() {
      jobRepositoryTestUtils.removeJobExecutions();
   }

   @Test
   public void testJob() throws Exception {
      // given
      JobParameters jobParameters =
            jobLauncherTestUtils.getUniqueJobParameters();

      // when
      JobExecution jobExecution =
            jobLauncherTestUtils.launchJob(jobParameters);

      // then
      Assert.assertEquals(ExitStatus.COMPLETED,
                          jobExecution.getExitStatus());
   }

}

@EnableBatchIntegration 注解

设置一个远程分块作业需要定义一系列 bean

• 用于从消息中间件（JMS、AMQP 等）获取连接的连接工厂
• 用于从主节点向工作节点发送请求并返回的 MessagingTemplate
• 用于 Spring Integration 从消息中间件接收消息的输入通道和输出通道
• 主节点侧的一个特殊项写入器（ChunkMessageChannelItemWriter），它知道如何将数据块发送给工作节点进行处理和写入
• 工作节点侧的一个消息监听器（ChunkProcessorChunkHandler），用于接收来自主节点的数据

乍一看这可能有点吓人。本次发布引入了一个名为 @EnableBatchIntegration 的新注解，以及新的 API（RemoteChunkingMasterStepBuilder 和 RemoteChunkingWorkerBuilder）来简化配置。下面的示例展示了如何使用新注解和 API

@Configuration
@EnableBatchProcessing
@EnableBatchIntegration
public class RemoteChunkingAppConfig {

   @Autowired
   private RemoteChunkingMasterStepBuilderFactory masterStepBuilderFactory;

   @Autowired
   private RemoteChunkingWorkerBuilder workerBuilder;

   @Bean
   public TaskletStep masterStep() {
         return this.masterStepBuilderFactory
         	        .get("masterStep")
         	        .chunk(100)
         	        .reader(itemReader())
         	        .outputChannel(outgoingRequestsToWorkers())
         	        .inputChannel(incomingRepliesFromWorkers())
         	        .build();
   }

   @Bean
   public IntegrationFlow worker() {
         return this.workerBuilder
         	        .itemProcessor(itemProcessor())
         	        .itemWriter(itemWriter())
         	        .inputChannel(incomingRequestsFromMaster())
         	        .outputChannel(outgoingRepliesToMaster())
         	        .build();
   }

   // Middleware beans setup omitted
}

这个新注解和新的构建器负责配置基础设施 bean 的繁重工作。您现在可以轻松地为主节点步骤以及工作节点侧的 Spring Integration 流配置。

就像远程分块配置的简化一样，此版本还引入了新的 API 来简化远程分区设置：RemotePartitioningMasterStepBuilder 和 RemotePartitioningWorkerStepBuilder。如果存在 @EnableBatchIntegration，您可以在配置类中自动装配它们，如以下示例所示

@Configuration
@EnableBatchProcessing
@EnableBatchIntegration
public class RemotePartitioningAppConfig {

   @Autowired
   private RemotePartitioningMasterStepBuilderFactory masterStepBuilderFactory;

   @Autowired
   private RemotePartitioningWorkerStepBuilderFactory workerStepBuilderFactory;

   @Bean
   public Step masterStep() {
            return this.masterStepBuilderFactory
               .get("masterStep")
               .partitioner("workerStep", partitioner())
               .gridSize(10)
               .outputChannel(outgoingRequestsToWorkers())
               .inputChannel(incomingRepliesFromWorkers())
               .build();
   }

   @Bean
   public Step workerStep() {
            return this.workerStepBuilderFactory
               .get("workerStep")
               .inputChannel(incomingRequestsFromMaster())
               .outputChannel(outgoingRepliesToMaster())
               .chunk(100)
               .reader(itemReader())
               .processor(itemProcessor())
               .writer(itemWriter())
               .build();
   }

   // Middleware beans setup omitted
}

JSON 支持

本次发布引入了一个新的项读取器（JsonItemReader），它可以按以下格式读取 JSON 资源

[
  {
    "isin": "123",
    "quantity": 1,
    "price": 1.2,
    "customer": "foo"
  },
  {
    "isin": "456",
    "quantity": 2,
    "price": 1.4,
    "customer": "bar"
  }
]

与 XML 的 StaxEventItemReader 类似，新的 JsonItemReader 使用流式 API 分块读取 JSON 对象。Spring Batch 支持两种库

• Jackson
• Gson

要添加其他实现，您可以实现 JsonObjectReader 接口。通过 JsonFileItemWriter 也支持写入 JSON 数据。

Bean Validation API 支持

本次发布带来了新的 ValidatingItemProcessor 实现，名为 BeanValidatingItemProcessor，它允许您验证用 Bean Validation API (JSR-303) 注解注释的项。例如，考虑以下 Person 类型

class Person {

    @NotEmpty
    private String name;

    public Person(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

您可以通过在应用程序上下文中声明一个 BeanValidatingItemProcessor bean，并将其注册为块式步骤中的处理器来验证项，如以下示例所示

@Bean
public BeanValidatingItemProcessor<Person> beanValidatingItemProcessor()
   throws Exception {
	BeanValidatingItemProcessor<Person> beanValidatingItemProcessor 
                    = new BeanValidatingItemProcessor<>();
	beanValidatingItemProcessor.setFilter(true);

	return beanValidatingItemProcessor;
}

JSR-305 支持

本次发布增加了对 JSR-305 注解的支持。它使用了 Spring Framework 的 Null-safety 注解，并将其添加到 Spring Batch 的所有公共 API 上。

这些注解不仅在使用 Spring Batch API 时强制执行 null-safety，还可以被 IDE 用于提供有关可空性的有用信息。例如，如果用户想实现 ItemReader 接口，任何支持 JSR-305 注解的 IDE 都应该生成类似于以下内容的代码

public class MyItemReader implements ItemReader<String> {

	@Nullable
	public String read() throws Exception {
		return null;
	}

}

@Nullable 注解出现在 read 方法上，清楚地表明该方法的约定是它可能返回 null。这强化了其 Javadoc 中的说法，即当数据源耗尽时，read 方法应返回 null。

FlatFileItemWriterBuilder 增强

本次发布中的另一个小功能是简化了平面文件的写入配置。具体来说，这些更新简化了分隔文件和固定宽度文件的配置。下面的示例展示了更改前后的对比。

// Before
@Bean
public FlatFileItemWriter<Item> itemWriter(Resource resource) {
	BeanWrapperFieldExtractor<Item> fieldExtractor =
            new BeanWrapperFieldExtractor<Item>();
	fieldExtractor.setNames(new String[] {"field1", "field2", "field3"});
	fieldExtractor.afterPropertiesSet();

	DelimitedLineAggregator aggregator = new DelimitedLineAggregator();
	aggregator.setFieldExtractor(fieldExtractor);
	aggregator.setDelimiter(";");

	return new FlatFileItemWriterBuilder<Item>()
			.name("itemWriter")
			.resource(resource)
			.lineAggregator(aggregator)
			.build();
}

// After
@Bean
public FlatFileItemWriter<Item> itemWriter(Resource resource) {
	return new FlatFileItemWriterBuilder<Item>()
			.name("itemWriter")
			.resource(resource)
			.delimited()
			.delimiter(";")
			.names(new String[] {"field1", "field2", "field3"})
			.build();
}

其他改进

除了所有这些新功能之外，本次发布还修复了相当多的 bug，并整合了社区通过 Github Pull Requests 提交的大量增强。我们要感谢所有贡献者报告问题、提出功能建议和贡献代码，使得本次发布得以实现！此版本的完整变更日志可以在 这里找到。

反馈

您可以随着即将发布的 Spring Boot 2.1 GA 一起使用 Spring Batch 4.1 GA。我们期待您在 StackOverflow、Gitter 或 JIRA 上的反馈。欢迎在 Twitter 上 @michaelminella 或 @benas。

Spring Batch 主页 | GitHub 源码 | 参考文档