Spring-Boot之多数据源报错：surefire-reports for the individual test result及because “this.XXService“ is nuLL

在使用 Spring Boot 开发项目时，多数据源的配置往往会带来一些复杂性，特别是在进行单元测试时，可能会遇到一些意想不到的错误，比如 surefire-reports for the individual test result 和 because "this.XXService" is null。本文将探讨多数据源环境下可能出现的问题，以及解决方案。

多数据源配置

在 Spring Boot 中配置多数据源通常需要定义多个 DataSource，并通过 @Primary 注解来指定主数据源。以下是一个简单的多数据源配置示例：

@Configuration
public class DataSourceConfig {

    @Primary
    @Bean(name = "dataSourceOne")
    @ConfigurationProperties(prefix = "spring.datasource.one")
    public DataSource dataSourceOne() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "dataSourceTwo")
    @ConfigurationProperties(prefix = "spring.datasource.two")
    public DataSource dataSourceTwo() {
        return DataSourceBuilder.create().build();
    }
}

这里假设在 application.yml 中配置了两个数据源：

spring:
  datasource:
    one:
      url: jdbc:mysql://localhost:3306/db_one
      username: user_one
      password: pass_one
      driver-class-name: com.mysql.cj.jdbc.Driver
    two:
      url: jdbc:mysql://localhost:3306/db_two
      username: user_two
      password: pass_two
      driver-class-name: com.mysql.cj.jdbc.Driver

引入服务层

在多数据源环境下，服务层（Service Layer）会注入相应的数据源。以下是一个服务层的示例：

@Service
public class XXService {

    @Autowired
    @Qualifier("dataSourceOne")
    private DataSource dataSourceOne;

    @Autowired
    @Qualifier("dataSourceTwo")
    private DataSource dataSourceTwo;

    // 业务逻辑...
}

常见错误分析

1. surefire-reports for the individual test result

这个错误通常出现在 Maven 的 surefire 插件执行单元测试时，请确保你在项目的 pom.xml 文件中包括了正确的测试依赖，比如 JUnit 和 Spring Test：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

如果在单元测试中出现 surefire-reports 相关的错误，通常是因为测试没有通过，可以查看 target/surefire-reports 目录中的报告，找到具体的错误信息。

2. because "this.XXService" is null

这个错误通常是由于 Spring 容器没有正确地注入服务类。例如，如果在测试类中直接使用了 @Autowired 注解而没有使用 Spring 的测试上下文，或者没有启用相应的组件扫描。

需要确保测试类中使用了 @SpringBootTest 注解，以及正确的组件扫描路径：

@RunWith(SpringRunner.class)
@SpringBootTest
public class XXServiceTest {

    @Autowired
    private XXService xxService;

    @Test
    public void testXXService() {
        assertNotNull(xxService, "XXService should not be null");
        // 其他测试逻辑...
    }
}

解决方案

1. 检查依赖：确保你的项目中包含了必要的测试依赖，尤其是 Spring Boot 的测试相关库。

2. 使用完整的上下文：在测试类中使用 @SpringBootTest，以确保所有的 Bean 都能被正确注入。

3. 调试 Bean 注入：如果注入仍然失败，可以在上下文中打印所有的 Bean 名称，确保所需的 Bean 已经被创建。

4. 测试数据库配置：如果是在测试环境中，我们通常会使用一个内存数据库（如 H2）来进行单元测试，确保配置正确。

通过以上的配置和调试，可以有效地避免和解决多数据源环境下的单元测试中的常见问题。希望这些信息能对你的项目开发有所帮助。