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它可以正常工作，但有一个例外 -auditorAware测试中的自动装配是一个 fromTestAuditingConfiguration但另一方面用于审计的是 fromAuditingConfiguration所以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());
    }

}

现在我真的很困惑豆如何在特定的配置文件，以及如何使用@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豆子。Spring 内部的一些“魔法”试图jpaAuditingHandler从中创建一个 bean。由于有两个AuditorAwarebean，我们最终得到两个同名的 bean，这是不可接受的。请参阅Spring boot 2.1 bean override 与 Primary。您可能可以启用 bean 覆盖，但不建议这样做。

由于@DataJpaTest找不到这些配置，因此您最终根本没有任何AuditorAwarebean。通过导入正确的配置，您将获得测试所需的 Bean，一切都很顺利。

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

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

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