单元测试

与其他应用程序样式一样，对作为批处理作业一部分编写的任何代码进行单元测试都极其重要。Spring 核心文档详细介绍了如何使用 Spring 进行单元测试和集成测试，因此此处不再赘述。但是，重要的是要考虑如何对批处理作业进行“端到端”测试，这就是本章介绍的内容。spring-batch-test 项目包含一些类，这些类有助于这种端到端测试方法。

创建单元测试类

为了使单元测试能够运行批处理作业，框架必须加载作业的ApplicationContext。使用两个注解来触发此行为

  • @SpringJUnitConfig指示该类应使用 Spring 的 JUnit 功能

  • @SpringBatchTest在测试上下文中注入 Spring Batch 测试实用程序（例如JobLauncherTestUtils和JobRepositoryTestUtils）

如果测试上下文包含单个Job bean 定义，则此 bean 将自动注入到JobLauncherTestUtils中。否则，应该在JobLauncherTestUtils上手动设置被测试的作业。

  • Java

  • XML

下面的 Java 示例显示了正在使用的注解

使用 Java 配置
@SpringBatchTest
@SpringJUnitConfig(SkipSampleConfiguration.class)
public class SkipSampleFunctionalTests { ... }

下面的 XML 示例显示了正在使用的注解

使用 XML 配置
@SpringBatchTest
@SpringJUnitConfig(locations = { "/simple-job-launcher-context.xml",
                                    "/jobs/skipSampleJob.xml" })
public class SkipSampleFunctionalTests { ... }

批处理作业的端到端测试

“端到端”测试可以定义为从头到尾测试批处理作业的完整运行。这允许进行设置测试条件、执行作业和验证最终结果的测试。

考虑一个从数据库读取并写入平面文件的批处理作业的示例。测试方法首先使用测试数据设置数据库。它清除CUSTOMER表，然后插入 10 条新记录。然后，测试使用launchJob()方法启动Job。launchJob()方法由JobLauncherTestUtils类提供。JobLauncherTestUtils类还提供launchJob(JobParameters)方法，该方法允许测试提供特定参数。launchJob()方法返回JobExecution对象，该对象可用于断言有关Job运行的特定信息。在本例中，测试验证Job是否以COMPLETED状态结束。

  • Java

  • XML

以下清单显示了使用 Java 配置样式的 JUnit 5 的示例

基于 Java 的配置
@SpringBatchTest
@SpringJUnitConfig(SkipSampleConfiguration.class)
public class SkipSampleFunctionalTests {

    @Autowired
    private JobLauncherTestUtils jobLauncherTestUtils;

    private JdbcTemplate jdbcTemplate;

    @Autowired
    public void setDataSource(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    @Test
    public void testJob(@Autowired Job job) throws Exception {
        this.jobLauncherTestUtils.setJob(job);
        this.jdbcTemplate.update("delete from CUSTOMER");
        for (int i = 1; i <= 10; i++) {
            this.jdbcTemplate.update("insert into CUSTOMER values (?, 0, ?, 100000)",
                                      i, "customer" + i);
        }

        JobExecution jobExecution = jobLauncherTestUtils.launchJob();


        Assert.assertEquals("COMPLETED", jobExecution.getExitStatus().getExitCode());
    }
}

以下清单显示了使用 XML 配置样式的 JUnit 5 的示例

基于 XML 的配置
@SpringBatchTest
@SpringJUnitConfig(locations = { "/simple-job-launcher-context.xml",
                                    "/jobs/skipSampleJob.xml" })
public class SkipSampleFunctionalTests {

    @Autowired
    private JobLauncherTestUtils jobLauncherTestUtils;

    private JdbcTemplate jdbcTemplate;

    @Autowired
    public void setDataSource(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    @Test
    public void testJob(@Autowired Job job) throws Exception {
        this.jobLauncherTestUtils.setJob(job);
        this.jdbcTemplate.update("delete from CUSTOMER");
        for (int i = 1; i <= 10; i++) {
            this.jdbcTemplate.update("insert into CUSTOMER values (?, 0, ?, 100000)",
                                      i, "customer" + i);
        }

        JobExecution jobExecution = jobLauncherTestUtils.launchJob();


        Assert.assertEquals("COMPLETED", jobExecution.getExitStatus().getExitCode());
    }
}

测试单个步骤

对于复杂的批处理作业，端到端测试方法中的测试用例可能会变得难以管理。在这些情况下，拥有测试用例来单独测试单个步骤可能更有用。JobLauncherTestUtils类包含一个名为launchStep的方法，该方法接受步骤名称并仅运行该特定Step。这种方法允许进行更具针对性的测试，让测试仅为该步骤设置数据并直接验证其结果。以下示例显示了如何使用launchStep方法按名称加载Step

JobExecution jobExecution = jobLauncherTestUtils.launchStep("loadFileStep");

测试步骤范围内的组件

通常，在运行时为步骤配置的组件使用步骤范围和后期绑定来注入来自步骤或作业执行的上下文。除非您有办法像在步骤执行中一样设置上下文，否则这些组件很难作为独立组件进行测试。这是 Spring Batch 中两个组件的目标：StepScopeTestExecutionListener和StepScopeTestUtils。

侦听器是在类级别声明的，其作用是为每个测试方法创建一个步骤执行上下文，如下例所示

@SpringJUnitConfig
@TestExecutionListeners( { DependencyInjectionTestExecutionListener.class,
    StepScopeTestExecutionListener.class })
public class StepScopeTestExecutionListenerIntegrationTests {

    // This component is defined step-scoped, so it cannot be injected unless
    // a step is active...
    @Autowired
    private ItemReader<String> reader;

    public StepExecution getStepExecution() {
        StepExecution execution = MetaDataInstanceFactory.createStepExecution();
        execution.getExecutionContext().putString("input.data", "foo,bar,spam");
        return execution;
    }

    @Test
    public void testReader() {
        // The reader is initialized and bound to the input data
        assertNotNull(reader.read());
    }

}

有两个TestExecutionListeners。一个是常规的 Spring 测试框架，它处理来自配置的应用程序上下文的依赖注入以注入读取器。另一个是 Spring Batch StepScopeTestExecutionListener。它的工作原理是查找测试用例中StepExecution的工厂方法，将其用作测试方法的上下文，就像该执行在运行时在Step中处于活动状态一样。工厂方法由其签名检测（它必须返回StepExecution）。如果没有提供工厂方法，则会创建一个默认的StepExecution。

从 v4.1 开始，如果测试类使用@SpringBatchTest进行注释，则会将StepScopeTestExecutionListener和JobScopeTestExecutionListener导入为测试执行侦听器。前面的测试示例可以配置如下：

@SpringBatchTest
@SpringJUnitConfig
public class StepScopeTestExecutionListenerIntegrationTests {

    // This component is defined step-scoped, so it cannot be injected unless
    // a step is active...
    @Autowired
    private ItemReader<String> reader;

    public StepExecution getStepExecution() {
        StepExecution execution = MetaDataInstanceFactory.createStepExecution();
        execution.getExecutionContext().putString("input.data", "foo,bar,spam");
        return execution;
    }

    @Test
    public void testReader() {
        // The reader is initialized and bound to the input data
        assertNotNull(reader.read());
    }

}

如果您希望步骤范围的持续时间为测试方法的执行，则侦听器方法很方便。对于更灵活但更具侵入性的方法，您可以使用StepScopeTestUtils。以下示例计算前面示例中显示的读取器中可用项目的数量

int count = StepScopeTestUtils.doInStepScope(stepExecution,
    new Callable<Integer>() {
      public Integer call() throws Exception {

        int count = 0;

        while (reader.read() != null) {
           count++;
        }
        return count;
    }
});

验证输出文件

当批处理作业写入数据库时，很容易查询数据库以验证输出是否符合预期。但是，如果批处理作业写入文件，则同样重要的是验证输出。Spring Batch 提供了一个名为AssertFile的类来方便输出文件的验证。名为assertFileEquals的方法接受两个File对象（或两个Resource对象），并逐行断言这两个文件具有相同的内容。因此，可以创建一个包含预期输出的文件，并将其与实际结果进行比较，如下例所示。

private static final String EXPECTED_FILE = "src/main/resources/data/input.txt";
private static final String OUTPUT_FILE = "target/test-outputs/output.txt";

AssertFile.assertFileEquals(new FileSystemResource(EXPECTED_FILE),
                            new FileSystemResource(OUTPUT_FILE));

模拟领域对象

在为 Spring Batch 组件编写单元和集成测试时，另一个常见的难题是如何模拟领域对象。一个很好的例子是StepExecutionListener，如下面的代码片段所示。

public class NoWorkFoundStepExecutionListener extends StepExecutionListenerSupport {

    public ExitStatus afterStep(StepExecution stepExecution) {
        if (stepExecution.getReadCount() == 0) {
            return ExitStatus.FAILED;
        }
        return null;
    }
}

框架提供了上述监听器示例，并检查StepExecution的读取计数是否为空，从而表示没有执行任何工作。虽然此示例相当简单，但它说明了在尝试单元测试实现需要 Spring Batch 领域对象的接口的类时可能会遇到的问题类型。考虑以下对前面示例中监听器的单元测试。

private NoWorkFoundStepExecutionListener tested = new NoWorkFoundStepExecutionListener();

@Test
public void noWork() {
    StepExecution stepExecution = new StepExecution("NoProcessingStep",
                new JobExecution(new JobInstance(1L, new JobParameters(),
                                 "NoProcessingJob")));

    stepExecution.setExitStatus(ExitStatus.COMPLETED);
    stepExecution.setReadCount(0);

    ExitStatus exitStatus = tested.afterStep(stepExecution);
    assertEquals(ExitStatus.FAILED.getExitCode(), exitStatus.getExitCode());
}

由于 Spring Batch 领域模型遵循良好的面向对象原则，因此StepExecution需要一个JobExecution，而JobExecution需要一个JobInstance和JobParameters才能创建一个有效的StepExecution。虽然这在可靠的领域模型中是好的，但这确实使为单元测试创建存根对象变得冗长。为了解决这个问题，Spring Batch 测试模块包含一个用于创建领域对象的工厂：MetaDataInstanceFactory。有了这个工厂，单元测试可以更新得更简洁，如下例所示。

private NoWorkFoundStepExecutionListener tested = new NoWorkFoundStepExecutionListener();

@Test
public void testAfterStep() {
    StepExecution stepExecution = MetaDataInstanceFactory.createStepExecution();

    stepExecution.setExitStatus(ExitStatus.COMPLETED);
    stepExecution.setReadCount(0);

    ExitStatus exitStatus = tested.afterStep(stepExecution);
    assertEquals(ExitStatus.FAILED.getExitCode(), exitStatus.getExitCode());
}

前面创建简单StepExecution的方法只是工厂中提供的众多便捷方法之一。您可以在其Javadoc中找到完整的的方法列表。