如何在@Transactional SpringBootTest 测试用例中测试spring批处理作业？答案

【问题标题】：How to test spring batch job within @Transactional SpringBootTest test case?如何在@Transactional SpringBootTest 测试用例中测试spring批处理作业？
【发布时间】：2020-03-10 00:20:40
【问题描述】：

我今天好像赢不了……

有没有办法从 Spock SpringBootTest 集成测试中的OneToMany 关系中读取，而无需将测试注释为@Transactional 或添加不切实际的spring.jpa.properties.hibernate.enable_lazy_load_no_trans=true？
或者，有没有办法从 @Transactional 测试用例中启动 Spring-Batch 作业？

让我详细说明...

我正在尝试让一个简单的 Spring Boot 集成测试适用于我的 Spring Batch 报告流程，它从 DB2 表的复杂网络中读取数据，并为感兴趣的系统生成一系列更改消息。我正在使用 Groovy Spock 测试框架和一个 H2 内存数据库，其中填充了我的 DB2 表数据的代表性切片。

在测试开始时，我尝试使用给定表中的每个实体来在驱动我的消息传递的更改跟踪表中生成条目。

setup:
List allExistingTestPeople = peopleRepository.findAll()
Collections.shuffle(allExistingTestPeople)
allExistingTestPeople?.each { Person person ->
    Nickname nicknames = person.nicknames
    nicknames?.each { Nickname nickname ->
        changeTrackingRepository.save(new Change(personId: person.id, nicknameId: nickname.id, status: NEW))
    }
}

将这些作为我的 DB2 域类：

@Entity
@Table(name = "T_PERSON")
public class Person {

    @Id
    @Column(name = "P_ID")
    private Integer id;

    @Column(name = "P_NME")
    private String name;

    @OneToMany(targetEntity = Nickname.class, mappedBy = "person")
    private List<Nickname> nicknames;
}

@Entity
@Table(name = "T_NICKNAME")
public class Nickname{

    @EmbeddedId
    private PersonNicknamePK id;

    @Column(name = "N_NME")
    private String nickname;

    @ManyToOne(optional = false, targetEntity = Person.class)
    @JoinColumn(name = "P_ID", referencedColumnName="P_ID", insertable = false, updatable = false)
    private Person person;
}

@Embeddable
public class PersonNicknamePK implements Serializable {

    @Column(name="P_ID")
    private int personId;

    @Column(name="N_ID")
    private short nicknameId;
}

但我得到了这个 LazyInitializationException，即使我是在测试用例的上下文中读取 OneToMany 关系...

org.hibernate.LazyInitializationException: failed to lazily initialize a collection of role: com.my.package.db2.model.Person.nicknames, could not initialize proxy - no Session
at org.hibernate.collection.internal.AbstractPersistentCollection.throwLazyInitializationException(AbstractPersistentCollection.java:602)
at org.hibernate.collection.internal.AbstractPersistentCollection.withTemporarySessionIfNeeded(AbstractPersistentCollection.java:217)
at org.hibernate.collection.internal.AbstractPersistentCollection.readSize(AbstractPersistentCollection.java:161)
at org.hibernate.collection.internal.PersistentBag.size(PersistentBag.java:350)

我在网上看到了使用@Transactional 注释来注释我的测试用例的建议，这肯定让我更进一步，让我可以从OneToMany 关系中阅读。但是，当我尝试启动 Spring Batch Job 时，我想从我的 when 子句进行测试：

@Transactional
def "Happy path test to validate I can generate a report of changes"() {
    setup:
    //... See above

    when:
    service.launchBatchJob()

    then:
    //... Messages are generated
}

我遇到了一个异常，即 Spring Batch Job 无法从事务的上下文中启动！即使我通过ResourcelessTransactionManager 和MapJobRepositoryFactoryBean 使用内存中的作业管理器，因为这只是我正在编写的一个短暂的预定脚本......

java.lang.IllegalStateException: Existing transaction detected in JobRepository. Please fix this and try again (e.g. remove @Transactional annotations from client).
    at org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean$1.invoke(AbstractJobRepositoryFactoryBean.java:177)
    at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186)
    at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:212)
    at com.sun.proxy.$Proxy125.createJobExecution(Unknown Source)
    at org.springframework.batch.core.launch.support.SimpleJobLauncher.run(SimpleJobLauncher.java:134)
    at com.my.package.service.MyService.launchBatchJob(MyService.java:30)

目前看来唯一可行的是，如果我废弃 @Transactional 注释，而是将 spring.jpa.properties.hibernate.enable_lazy_load_no_trans=true 添加到我的 application-test.properties 文件中。但是，这似乎不是一个好主意，因为它不现实 - 如果我添加它，那么即使由于延迟初始化异常导致我的代码中存在错误，我也永远不会在测试中看到它.

对小说感到抱歉，希望有人能指出我正确的方向:(

编辑：

这也是我的 In-memory Spring-Batch 配置，我在其中尝试关闭事务验证。不幸的是，虽然这让我更进一步，但 Spring Batch 分区器的自动装配 EntityManager 突然无法在 H2 数据库中运行查询。

@Configuration
@EnableBatchProcessing
public class InMemoryBatchManagementConfig {

    @Bean
    public ResourcelessTransactionManager resourceslessTransactionManager() {
        ResourcelessTransactionManager resourcelessTransactionManager = new ResourcelessTransactionManager();
        resourcelessTransactionManager.setNestedTransactionAllowed(true);
        resourcelessTransactionManager.setValidateExistingTransaction(false);
        return resourcelessTransactionManager;
    }

    @Bean
    public MapJobRepositoryFactoryBean mapJobRepositoryFactory(ResourcelessTransactionManager txManager)
            throws Exception {
        MapJobRepositoryFactoryBean factory = new MapJobRepositoryFactoryBean(txManager);
        factory.setValidateTransactionState(false);
        factory.afterPropertiesSet();
        return factory;
    }

    @Bean
    public JobRepository jobRepository(MapJobRepositoryFactoryBean factory) throws Exception {
        return factory.getObject();
    }

    @Bean
    public SimpleJobLauncher jobLauncher(JobRepository jobRepository) throws Exception {
        SimpleJobLauncher launcher = new SimpleJobLauncher();
        launcher.setJobRepository(jobRepository);
        launcher.afterPropertiesSet();
        return launcher;
    }

    @Bean
    public JobExplorer jobExplorer(MapJobRepositoryFactoryBean factory) {
        return new SimpleJobExplorer(factory.getJobInstanceDao(), factory.getJobExecutionDao(),
                factory.getStepExecutionDao(), factory.getExecutionContextDao());
    }

    @Bean
    public BatchConfigurer batchConfigurer(MapJobRepositoryFactoryBean mapJobRepositoryFactory,
                                           ResourcelessTransactionManager resourceslessTransactionManager,
                                           SimpleJobLauncher jobLauncher,
                                           JobExplorer jobExplorer) {
        return new BatchConfigurer() {
            @Override
            public JobRepository getJobRepository() throws Exception {
                return mapJobRepositoryFactory.getObject();
            }

            @Override
            public PlatformTransactionManager getTransactionManager() throws Exception {
                return resourceslessTransactionManager;
            }

            @Override
            public JobLauncher getJobLauncher() throws Exception {
                return jobLauncher;
            }

            @Override
            public JobExplorer getJobExplorer() throws Exception {
                return jobExplorer;
            }
        };
    }
}

【问题讨论】：

这是一个不了解 Spring Batch 的人的评论，仅关于测试：当我看到您将测试方法设置为事务性的那一刻，我闻到了一些不好的味道。无论实施测试的最佳方式是什么，我认为都不是。如果您无法以更简洁的方式测试您的代码，则可能是您遇到了设计问题。抱歉说得这么不具体，我希望我从不同角度思考这个测试的建议能帮助你找到更好的解决方案。
@SnoopDougg 我是否正确理解您希望“设置”在事务中（这样您就可以在没有 LIE 的情况下读取数据源）但其余的应该没有它？
@Josef 没错！如果在 Spock 中这是可能的，将 setup 子句放入它自己的小事务中，那就太棒了
而且@kriegaex 我相信 SpringBootTest 集成测试通常包含在事务中，不是吗？因此，如果您碰巧找不到与模拟数据库等效的内存中的数据库，则可以在测试结束时回滚对数据库的任何更改。
这样做通常并不意味着这样做是正确的。人们经常互相复制和粘贴。 --- “一个观点被广泛接受的事实并不能证明它不是完全荒谬的；事实上，鉴于大多数人的愚蠢，一个广泛传播的信念比明智的。”伯特兰·罗素

标签： java spring-data spring-batch spock lazy-initialization

【解决方案1】：

发生此错误是因为您的代码已经在 Spring Batch 驱动的事务中执行。所以在事务范围内运行作业是不正确的。但是，如果您仍想禁用作业存储库完成的事务验证，可以将validateTransactionState 设置为 false，请参阅AbstractJobRepositoryFactoryBean#setValidateTransactionState。

也就是说，在事务中运行作业并不是修复org.hibernate.LazyInitializationException 的方法。属性spring.jpa.properties.hibernate.enable_lazy_load_no_trans=true 的存在是有原因的，如果它对你有用，我相信它是比在事务中运行整个作业更好的方法（顺便说一句，如果我不得不为此使用事务，我会缩小它的范围最小（例如步骤）而不是整个工作）。

【讨论】：

谢谢！这让我更进一步，我尝试使用setValidateTransactionState(false)，现在我不再看到“无法在事务中运行作业”错误了。但是由于某种原因，我自动连接到我的 Partioner 的 EntityManagerFactory 不能再在数据库中运行查询。我一直返回 0 的计数。也许是因为我的测试设置的早期部分实际上还没有提交......我会继续修补尝试看看发生了什么

【解决方案2】：

您可以使用TransactionTemplate 以编程方式执行事务，以仅在事务中运行“设置”（而不是在@Transactional 中包含所有内容）。不幸的是，这样事务将被提交，您将需要进行一些手动清理。

它可以像任何其他 bean 一样自动装配：

    @Autowired
    private TransactionTemplate transactionTemplate;

...它是这样使用的：

        transactionTemplate.execute((transactionStatus) -> {
            // ...setup...
            return null; // alternatively you can return some data out of the callback
        });

【讨论】：