如何配置springboot以在集成测试期间包装DataSource?

时间:2017-05-04 22:36:19

标签: spring spring-boot spring-jdbc

我的目标是进行集成测试,确保在查找期间不会发生太多数据库查询。 (这有助于我们捕获由于错误的JPA配置而导致的n + 1个查询)

我知道数据库连接是正确的,因为在测试运行期间没有配置问题,只要测试中不包含MyDataSourceWrapperConfiguration。但是,一旦添加,就会发生循环依赖。 (请参阅下面的错误)我认为{J}需要@Primary才能使JPA / JDBC代码使用正确的DataSource实例。

MyDataSourceWrapper是一个自定义类,用于跟踪给定事务发生的查询数,但它将实际数据库工作委托给通过构造函数传入的DataSource

错误:

The dependencies of some of the beans in the application context form a cycle:

   org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
┌─────┐
|  databaseQueryCounterProxyDataSource defined in me.testsupport.database.MyDataSourceWrapperConfiguration 
↑     ↓
|  dataSource defined in org.springframework.boot.autoconfigure.jdbc.DataSourceConfiguration$Tomcat
↑     ↓
|  dataSourceInitializer
└─────┘

我的配置:

@Configuration
public class MyDataSourceWrapperConfiguration {

    @Primary
    @Bean
    DataSource databaseQueryCounterProxyDataSource(final DataSource delegate) {
        return MyDataSourceWrapper(delegate);
    }
}

我的测试:

@ActiveProfiles({ "it" })
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration({ DatabaseConnectionConfiguration.class, DatabaseQueryCounterConfiguration.class })
@EnableAutoConfiguration
public class EngApplicationRepositoryIT {

    @Rule
    public MyDatabaseQueryCounter databaseQueryCounter = new MyDatabaseQueryCounter ();

    @Rule
    public ErrorCollector errorCollector = new ErrorCollector();

    @Autowired
    MyRepository repository;

    @Test
    public void test() {
        this.repository.loadData();
        this.errorCollector.checkThat(this.databaseQueryCounter.getSelectCounts(), is(lessThan(10)));
    }

}

更新:这个原始问题是针对springboot 1.5的。然而,接受的答案反映了@rajadilipkolli的回答适用于springboot 2.x

4 个答案:

答案 0 :(得分:5)

在您的情况下,您将获得2个DataSource个实例,这可能不是您想要的。而是使用BeanPostProcessor,这是为此实际设计的组件。另请参阅Spring Reference Guide

创建并注册执行换行的BeanPostProcessor

public class DataSourceWrapper implements BeanPostProcessor {

    public Object postProcessBeforeInitialization(Object bean, String beanName) {
        if (bean instanceof DataSource) {
             return new MyDataSourceWrapper((DataSource)bean);
        }
        return bean;
    }

    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
}

然后只需将其注册为@Bean,而不是MyDataSourceWrapper

提示:您可能对datasource-proxydatasource-assert已结合已有计数器等支持感兴趣而不是滚动您自己的包裹DataSource(保存您维护自己的组件)。

答案 1 :(得分:3)

从使用BeanPostProcessor的Spring boot 2.0.0.M3开始不会工作。

作为一种解决方法,创建自己的bean,如下所示

  @Bean
    public DataSource customDataSource(DataSourceProperties properties) {
        log.info("Inside Proxy Creation");

        final HikariDataSource dataSource = (HikariDataSource) properties
                .initializeDataSourceBuilder().type(HikariDataSource.class).build();
        if (properties.getName() != null) {
            dataSource.setPoolName(properties.getName());
        }
        return ProxyDataSourceBuilder.create(dataSource).countQuery().name("MyDS")
                .logSlowQueryToSysOut(1, TimeUnit.MINUTES).build();
    }

另一种方法是使用datasource-decorator starter

的数据源代理版本

答案 2 :(得分:0)

你实际上仍然可以在Spring Boot 2中使用BeanPostProcessor,但它需要返回正确的类型(声明的Bean的实际类型)。要做到这一点,你需要创建一个正确类型的代理,它将DataSource方法重定向到你的拦截器,并将所有其他方法重定向到原始bean。

例如代码请参阅https://github.com/spring-projects/spring-boot/issues/12592上的Spring Boot问题和讨论。

答案 3 :(得分:0)

以下解决方案适用于Spring Boot 2.0.6。

它使用显式绑定而不是注释@ConfigurationProperties(prefix = "spring.datasource.hikari")

@Configuration
public class DataSourceConfig {

    private final Environment env;

    @Autowired
    public DataSourceConfig(Environment env) {
        this.env = env;
    }

    @Primary
    @Bean
    public MyDataSourceWrapper primaryDataSource(DataSourceProperties properties) {
        DataSource dataSource = properties.initializeDataSourceBuilder().build();
        Binder binder = Binder.get(env);
        binder.bind("spring.datasource.hikari", Bindable.ofInstance(dataSource).withExistingValue(dataSource));
        return new MyDataSourceWrapper(dataSource);
    }

}