Spring Boot 单元测试未检测到自动装配组件的模块

Posted 2023-02-26

【中文标题】Spring Boot 单元测试未检测到自动装配组件的模块

【英文标题】：Spring Boot Unit Test a module not detecting an autowired component

【发布时间】：2018-12-06 17:16:03

【问题描述】：

我们将基于 Maven 的 Spring Boot 项目拆分为两个模块，如下所示：

ProjectRoot
-SharedModel
-Application
--main
---java
----com....(Application.java)
-----com....(ClassToAutowire.java)
--test
----com....(ApplicationTest.java)
-----com....(ClassToAutowireTest.java)

测试类如下：

@RunWith(SpringRunner.class)
public class ClassToAutowireTest extends BaseTest 

    @Autowired
    private ClassToAutowire classToAutowire;

    @Before
    public void setup() throws IOException         
    ....
    

    @Test
    public void someTest() 
        ....
        assertEquals(this.classToAutowire.isSupported(this.message), true);
    

ClassToAutowire 如下所示：

@Component
public class ClassToAutowire 

    private ConfigurationService configurationService;

    @Autowired
    public ClassToAutowire(ConfigurationService configurationService) 
        this.configurationService = configurationService;
    



    ....

Application.java 如下所示：

@SpringBootApplication
@EnableRetry
public class Application 

    public static void main(String[] args) 
        SpringApplication.run(Application.class, args);
    

ApplicationTest.java 如下所示：

@SpringBootTest
@RunWith(SpringRunner.class)
public class ApplicationTests 

    @Test
    @Ignore
    public void contextLoads() 
        // °º¤ø,¸¸,ø¤º°`°º¤ø,¸,ø¤°º¤ø,¸¸,ø¤º°`°º¤ø,¸
    

当我运行这个单元测试时，我们得到以下跟踪：

    2018-06-27 15:02:37.835 ERROR [                                main] context.TestContextManager.prepareTestInstance(TestContextManager.java:234): Caught exception while allowing TestExecutionListener [org.springframework.test.context.support.DependencyInjectionTestExecutionListener@57c03d88] to prepare test instance [com.some.package.structure.ClassToAutowireTest@16aa8654]
org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'com.some.package.structure.ClassToAutowireTest': Unsatisfied dependency expressed through field 'classToAutowire'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.some.package.structure.ClassToAutowire' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: @org.springframework.beans.factory.annotation.Autowired(required=true)
    at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor$AutowiredFieldElement.inject(AutowiredAnnotationBeanPostProcessor.java:588)
    at org.springframework.beans.factory.annotation.InjectionMetadata.inject(InjectionMetadata.java:88)
    at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.postProcessPropertyValues(AutowiredAnnotationBeanPostProcessor.java:366)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.populateBean(AbstractAutowireCapableBeanFactory.java:1264)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.autowireBeanProperties(AbstractAutowireCapableBeanFactory.java:386)
    at org.springframework.test.context.support.DependencyInjectionTestExecutionListener.injectDependencies(DependencyInjectionTestExecutionListener.java:118)
    at org.springframework.test.context.support.DependencyInjectionTestExecutionListener.prepareTestInstance(DependencyInjectionTestExecutionListener.java:83)
    at org.springframework.test.context.TestContextManager.prepareTestInstance(TestContextManager.java:230)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.createTest(SpringJUnit4ClassRunner.java:228)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner$1.runReflectiveCall(SpringJUnit4ClassRunner.java:287)
    at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.methodBlock(SpringJUnit4ClassRunner.java:289)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.runChild(SpringJUnit4ClassRunner.java:247)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.runChild(SpringJUnit4ClassRunner.java:94)
    at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
    at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
    at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
    at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
    at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
    at org.springframework.test.context.junit4.statements.RunBeforeTestClassCallbacks.evaluate(RunBeforeTestClassCallbacks.java:61)
    at org.springframework.test.context.junit4.statements.RunAfterTestClassCallbacks.evaluate(RunAfterTestClassCallbacks.java:70)
    at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.run(SpringJUnit4ClassRunner.java:191)
    at org.junit.runner.JUnitCore.run(JUnitCore.java:137)
    at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68)
    at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47)
    at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
    at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.some.package.structure.ClassToAutowire' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: @org.springframework.beans.factory.annotation.Autowired(required=true)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.raiseNoMatchingBeanFound(DefaultListableBeanFactory.java:1493)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1104)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveDependency(DefaultListableBeanFactory.java:1066)
    at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor$AutowiredFieldElement.inject(AutowiredAnnotationBeanPostProcessor.java:585)
    ... 27 more

看来这个问题可以通过添加注解绕过 @SpringBootTest(classes=ClassToAutowire.class) 在@RuneWith 注释下面，但随后单元测试似乎加载了整个SpringBoot 应用程序来运行测试。

我的问题是：

1) 为什么需要这个额外的注释来解决问题？应该是扫描整个Application/main/java/....（基于Application.java），为什么没有检测到组件呢？

2) 如何最好地做到这一点，以最小的负载使单元测试更快？

【问题讨论】：

这在Spring Boot测试文档docs.spring.io/spring-boot/docs/current/reference/html/…987654321@中都有解答

【参考方案1】：

@SpringBootTest 用于集成测试，这意味着集成应用程序的不同层。这就是它加载整个上下文的原因。

如果您只想对控制器进行单元测试，请使用@WebMvcTest 和模拟您需要的所有其他层。

有关所有层的完整单元测试以及工作示例，请参见： Testing in Spring

最后检索日期：2018/27/06

【参考方案2】：

为您的测试提供@ContextConfiguration(classes = ClassToAutowire.class)，然后您的上下文将随该类一起提供。 @SpringBootTest 注释在集成测试中用于加载完整的上下文。使用@ContextConfiguration 注释，您只能加载部分上下文。

【参考方案3】：

我已经解决了这个错误，将我的测试类移动到 com 包中。测试文件夹的结构是这样的

--/test
--/--/java
--/--/--/com
--/--/--/--/TestClass

我不确定，这个结构是否可以，但这是可行的。