Spring Boot 集成测试中 @Autowired 字段为空的解决方案

本文旨在解决 spring Boot 集成测试中，使用 @Autowired 注解的 Repository 字段出现空指针异常的问题。通常，这表明测试没有在 Spring 上下文中运行，导致依赖注入失败。本文将提供详细的排查和解决方案，确保集成测试能够正确地运行在 Spring 上下文中，并成功注入所需的依赖。

问题分析

在 spring boot 集成测试中，使用 @Autowired 注解将 Repository 注入到测试类中是很常见的做法。但是，如果测试没有在 Spring 上下文中运行，@Autowired 注解将不会生效，导致注入的 Repository 字段为 NULL，从而引发空指针异常。

常见的原因包括：

1. 缺少必要的 junit 运行器： 如果使用的是 JUnit 4，则需要使用 @RunWith(SpringRunner.class) 或 @RunWith(SpringJUnit4ClassRunner.class) 注解来指定 Spring 运行器。JUnit 5 则不需要，但需要确保使用了正确的 Spring Boot 测试注解。
2. 测试注解配置不正确： 确保测试类使用了正确的 Spring Boot 测试注解，例如 @SpringBootTest 或 @DataMongoTest。
3. Spring Boot 上下文未正确加载： 检查测试配置，确保 Spring Boot 上下文能够正确加载。
4. 组件扫描配置错误： 确保 Spring Boot 能够扫描到需要注入的 Repository 组件。

解决方案

以下是一些解决 @Autowired 字段为空问题的步骤：

1. 确认 JUnit 版本和运行器：

   • JUnit 4: 确保测试类使用了 @RunWith(SpringRunner.class) 或 @RunWith(SpringJUnit4ClassRunner.class) 注解。

     import org.junit.runner.RunWith; import org.springframework.test.context.junit4.SpringRunner;  @RunWith(SpringRunner.class) @SpringBootTest public class MovieRepositoryIntegrationTest {     // ... }

   • JUnit 5: JUnit 5 不需要 @RunWith 注解，但需要确保使用了正确的 Spring Boot 测试注解，例如 @SpringBootTest 或 @DataMongoTest。

2. 使用正确的 Spring Boot 测试注解：

   • @SpringBootTest: 用于启动完整的 Spring Boot 应用上下文。
   • @DataMongoTest: 用于测试 mongodb 相关的功能，会自动配置 MongoDB 的测试环境。

   根据测试的需求选择合适的注解。例如，如果只需要测试 MongoDB 相关的功能，可以使用 @DataMongoTest。如果需要测试整个应用的集成，可以使用 @SpringBootTest。

   import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;  @DataMongoTest public class MovieRepositoryIntegrationTest extends AbstractContainerBaseTest {     // ... }

   如果使用 @SpringBootTest，可以配置 webEnvironment 属性来指定 Web 环境：

   • SpringBootTest.WebEnvironment.MOCK: 启动一个模拟的 Web 环境。
   • SpringBootTest.WebEnvironment.RANDOM_PORT: 启动一个真实的 Web 环境，并随机分配端口。
   • SpringBootTest.WebEnvironment.DEFINED_PORT: 启动一个真实的 Web 环境，并使用指定的端口。
   • SpringBootTest.WebEnvironment.NONE: 不启动 Web 环境。

   import org.springframework.boot.test.context.SpringBootTest;  @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) public class MovieRepositoryIntegrationTest {     // ... }

3. 检查组件扫描配置：

   确保 Spring Boot 能够扫描到需要注入的 Repository 组件。通常情况下，Spring Boot 会自动扫描与主应用类同包及其子包下的组件。如果 Repository 组件不在这些包下，需要手动配置组件扫描。

   可以通过以下方式配置组件扫描：

   • 在主应用类上使用 @ComponentScan 注解指定需要扫描的包。
   • 在配置类上使用 @EnableJpaRepositories 注解指定需要扫描的 Repository 接口。

   import org.springframework.context.annotation.ComponentScan; import org.springframework.boot.autoconfigure.SpringBootApplication;  @SpringBootApplication @ComponentScan("com.example.testingtwo") // 指定需要扫描的包 public class TestingTwoApplication {     public static void main(String[] args) {         SpringApplication.run(TestingTwoApplication.class, args);     } }

4. 确保测试类和 Repository 接口在同一个包或子包下：

   如果测试类和 Repository 接口不在同一个包或子包下，Spring Boot 可能无法自动扫描到 Repository 接口。可以将测试类和 Repository 接口放在同一个包或子包下，或者手动配置组件扫描。

5. 检查依赖注入是否正确：

   确保 @Autowired 注解使用正确，并且注入的类型与实际类型匹配。

6. 使用调试器进行调试：

   如果以上步骤都无法解决问题，可以使用调试器进行调试，查看 Spring 上下文是否正确加载，以及 Repository 组件是否被正确创建和注入。

示例代码

以下是一个完整的示例代码，演示了如何在 Spring Boot 集成测试中使用 @Autowired 注解注入 Repository：

package com.example.testingtwo.repository;  import com.example.testingtwo.AbstractContainerBaseTest; import com.example.testingtwo.model.Movie; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;  import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull;  @DataMongoTest public class MovieRepositoryIntegrationTest extends AbstractContainerBaseTest {      @Autowired     private MovieRepository movieRepository;      @AfterEach     void cleanUp() {         movieRepository.deleteAll();     }      @Test     public void testFindById() {         Movie movie = new Movie(null, "Test Name", "Test Description");         String movieId = movieRepository.save(movie).getId();         Movie movieFound = movieRepository.findById(movieId).orElse(null);          assertNotNull(movieFound);         assertEquals(movieFound.getName(), movie.getName());         assertEquals(movieFound.getDescription(), movie.getDescription());     } }

注意事项：

• 确保 MovieRepository 接口继承了 MongoRepository 接口。
• 确保 Movie 类是一个 MongoDB 文档类，并使用 @Document 注解进行标记。
• 确保 AbstractContainerBaseTest 类配置了 MongoDB 的测试环境。

总结

解决 Spring Boot 集成测试中 @Autowired 字段为空的问题，需要仔细检查测试环境的配置，确保测试在 Spring 上下文中运行，并且依赖注入能够正确生效。通过检查 JUnit 运行器、Spring Boot 测试注解、组件扫描配置、依赖注入是否正确以及使用调试器进行调试，可以有效地解决这个问题。