java - Jpa审计的测试配置

Question

我正在尝试在 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它工作正常，但有一个异常(exception) - Autowiring auditorAware测试中的一个来自 TestAuditingConfiguration但另一方面用于审计来自 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 很重要?谁能向我解释一下，什么是数据库测试的首选方法？

Answer 1

@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 beans 我们最终得到两个同名的 bean，这是 Not Acceptable 。见 Spring boot 2.1 bean override vs. Primary .您可能可以启用 bean 覆盖，但不建议这样做。
与 @DataJpaTest找不到这些配置，您最终没有 AuditorAware bean 。通过导入正确的配置，您可以准确地获得测试所需的 bean，一切都很顺利。
哪种方法更好取决于您如何运行测试，最终可能主要是品味问题。
我更喜欢使用 @DataJpaTest对于真实系统，因为它限制了无关配置对数据库测试的影响。它的执行速度也可能稍快一些，尽管这对于大多数测试套件来说可能几乎不明显，因为在我使用的大多数应用程序中，大部分启动时间都被 Hibernate 占用了，这无论如何都是数据库测试所必需的，并且当您运行具有不同配置的多个测试时不同的测试会对缓存产生负面影响。
对于小型项目，我更喜欢 @SpringBootTest因为至少在简单的情况下，编写起来更少并且使事情变得更简单。