Jpa审核的测试配置

时间:2019-05-26 21:04:49

标签: java spring spring-boot spring-data-jpa spring-test

我正在尝试在Spring Boot应用程序中使用Spring Data,Hibernate Envers和审核。我已经配置了AuditorAwareImpl

public class AuditorAwareImpl implements AuditorAware<String> {

    @Override
    public Optional<String> getCurrentAuditor() {
        return Optional.of("Default auditor");
    }
}

和它的配置类。

@Configuration
@EnableJpaAuditing(auditorAwareRef = "auditorProvider")
public class AuditingConfiguration {

    @Bean
    public AuditorAware<String> auditorProvider() {
        return new AuditorAwareImpl();
    }
}

现在,我想为我的集成测试创建AuditorAware。我已经与测试审核员一起创建了新的配置类

@Configuration
@Profile("test")
@EnableJpaAuditing(auditorAwareRef = "testAuditorProvider")
public class TestAuditingConfiguration {

    @Bean
    @Primary
    public AuditorAware<String> testAuditorProvider() {
        return () -> Optional.of("Test auditor");
    }

}

当我尝试这样编写集成测试时

@RunWith(SpringRunner.class)
@SpringBootTest
@ActiveProfiles("test")
public class AuditingApplicationTests {

    @Autowired
    private AuditorAware<String> auditorAware;

    @Autowired
    private MovieRepository movieRepository;

    @Test
    public void testCurrentAuditor() {
        String currentAuditor = auditorAware.getCurrentAuditor().get();
        assertEquals("Test auditor", currentAuditor);
    }

    @Test
    public void movieRepositoryTest() {
        Movie movie = new Movie("Movie");
        movieRepository.save(movie);

        List<Movie> movies = movieRepository.findAll();
        Movie result = movies.get(0);
        assertEquals("Test auditor", result.getCreatedBy());
    }
}

我收到此错误:

Caused by: org.springframework.beans.factory.support.BeanDefinitionOverrideException: Invalid bean definition with name 'jpaAuditingHandler' defined in null: Cannot register bean definition [Root bean: class [org.springframework.data.auditing.AuditingHandler]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null] for bean 'jpaAuditingHandler': There is already [Root bean: class [org.springframework.data.auditing.AuditingHandler]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null] bound.

当我从@EnableJpaAuditing中删除TestAuditingConfiguration时,它工作正常,但有一个例外-测试中自动连线的auditorAwareTestAuditingConfiguration的一个,但另一方面用于审计的是AuditingConfiguration,因此result.getCreatedBy()将返回Default auditor而不是Test auditor。我读到,对于数据库集成测试,应该使用@DataJpaTest批注,因此我进行了更改。现在在@EnableJpaAuditing上启用了TestAuditingConfiguration,我收到了:

org.springframework.beans.factory.UnsatisfiedDependencyException:  Unsatisfied dependency expressed through field 'auditorAware'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.springframework.data.domain.AuditorAware<java.lang.String>' available: expected at least 1 bean which qualifies as autowire candidate

但是在添加@Import(TestAuditingConfiguration.class)后,它可以按我期望的方式工作-result.getCreatedBy()返回Test auditor。所以最终我的测试类如下:

@RunWith(SpringRunner.class)
@DataJpaTest
@ActiveProfiles("test")
@Import(TestAuditingConfiguration.class)
public class AuditingApplicationTests {

    @Autowired
    private AuditorAware<String> auditorAware;

    @Autowired
    private MovieRepository movieRepository;

    @Test
    public void testCurrentAuditor() {
        String currentAuditor = auditorAware.getCurrentAuditor().get();
        assertEquals("Test auditor", currentAuditor);
    }

    @Test
    public void movieRepositoryTest() {
        Movie movie = new Movie("Movie");
        movieRepository.save(movie);

        List<Movie> movies = movieRepository.findAll();
        Movie result = movies.get(0);
        assertEquals("Test auditor", result.getCreatedBy());
    }

}

现在,我真的很困惑如何在特定配置文件中使用bean,以及@SpringBootTest@DataJpaTest的工作方式。为什么@Import@DataJpaTest很重要?谁能向我解释一下,什么是数据库测试的首选方法?

1 个答案:

答案 0 :(得分:0)

@DataJpaTest 只是一堆注释的快捷方式。见https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/test/autoconfigure/orm/jpa/DataJpaTest.html

它基本上创建了一个 ApplicationContext,其中只注册了与 JPA 和 Spring Data JPA 相关的那些 bean。

@SpringBootTest 使用应用程序中的所有内容创建一个完整的 ApplicationContext。它通过扫描带有 @Configuration 注释的类的类路径来找到其中的很多。

因此它将包含更多“东西”,在您的情况下包含两个 @AuditorAware bean。 Spring 内部的一些“魔法”试图从中创建一个 jpaAuditingHandler bean。由于有两个 AuditorAware bean,我们最终得到了两个同名 bean,这是不可接受的。见Spring boot 2.1 bean override vs. Primary。您可能可以启用 bean 覆盖,但不建议这样做。

使用 @DataJpaTest 找不到这些配置,最终您根本没有 AuditorAware bean。通过导入正确的配置,您可以准确获得测试所需的 bean,一切都很顺利。

哪种方法更好取决于您如何运行测试,并且最终可能主要是品味问题。

我更喜欢在真实系统中使用 @DataJpaTest,因为它限制了无关配置对数据库测试的影响。它的执行速度也可能稍快一些,尽管这对于大多数测试套件来说可能几乎不明显,因为在我使用的大多数应用程序中,大部分启动时间都被 Hibernate 占用了,这无论如何都是数据库测试所必需的,并且当您运行具有不同配置的多个测试时不同的测试会对缓存产生负面影响。

对于小型项目,我更喜欢 @SpringBootTest,因为至少在简单的情况下,它可以减少编写并且使事情变得更简单。