Spring Boot 控制器单元测试：无法加载 ApplicationContext

Posted 2023-04-18

【中文标题】Spring Boot 控制器单元测试：无法加载 ApplicationContext

【英文标题】：Spring Boot controller unit test : Failed to load ApplicationContext

【发布时间】：2018-01-14 07:09:52

【问题描述】：

我有一个简单的 Spring Boot 控制器，我想为它编写单元测试，但出现了错误。我已经搜索了几个小时，但仍然找不到解决方案。这是代码：

HelloController.java

@RestController
public class HelloController 

    @Autowired
    private HelloService helloService;

    @GetMapping("/hello")
    public String sayHello()
        return helloService.sayHello();
    

HelloService.java：

@Service
public class HelloService 
    public String sayHello()
        return "Hello";
    

和单元测试文件： HelloControllerTest.java：

@RunWith(SpringJUnit4ClassRunner.class)
@WebMvcTest(HelloController.class)
public class HelloControllerTest 

    @Autowired
    private MockMvc mockMvc;

    @Mock
    private HelloService helloService;


    @Before
    public void setUp()
        MockitoAnnotations.initMocks(this);
    

    @Test
    public void sayHello() throws Exception 
        when(helloService.sayHello()).thenReturn("thach");
        mockMvc.perform(get("/hello"))
                .andExpect(status().isOk())
                .andExpect(content().string("thach"));
    

但是有一个错误：

java.lang.IllegalStateException: Failed to load ApplicationContext

    at org.springframework.test.context.CacheAwareContextLoaderDelegate.loadContext(CacheAwareContextLoaderDelegate.java:99)
    at org.springframework.test.context.TestContext.getApplicationContext(TestContext.java:122)
    at org.springframework.test.context.web.ServletTestExecutionListener.setUpRequestContextIfNecessary(ServletTestExecutionListener.java:105)
    at org.springframework.test.context.web.ServletTestExecutionListener.prepareTestInstance(ServletTestExecutionListener.java:74)
    at org.springframework.test.context.TestContextManager.prepareTestInstance(TestContextManager.java:312)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.createTest(SpringJUnit4ClassRunner.java:211)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner$1.runReflectiveCall(SpringJUnit4ClassRunner.java:288)
    at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.methodBlock(SpringJUnit4ClassRunner.java:284)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.runChild(SpringJUnit4ClassRunner.java:231)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.runChild(SpringJUnit4ClassRunner.java:88)
    at org.junit.runners.ParentRunner$3.run(ParentRunner.java:238)
    at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:63)
    at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:236)
    at org.junit.runners.ParentRunner.access$000(ParentRunner.java:53)
    at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:229)
    at org.springframework.test.context.junit4.statements.RunBeforeTestClassCallbacks.evaluate(RunBeforeTestClassCallbacks.java:61)
    at org.springframework.test.context.junit4.statements.RunAfterTestClassCallbacks.evaluate(RunAfterTestClassCallbacks.java:71)
    at org.junit.runners.ParentRunner.run(ParentRunner.java:309)
    at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.run(SpringJUnit4ClassRunner.java:174)
    at org.junit.runner.JUnitCore.run(JUnitCore.java:160)
    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: java.lang.IllegalArgumentException: Cannot load an ApplicationContext with a NULL 'contextLoader'. Consider annotating your test class with @ContextConfiguration or @ContextHierarchy.
    at org.springframework.util.Assert.notNull(Assert.java:134)
    at org.springframework.test.context.CacheAwareContextLoaderDelegate.loadContextInternal(CacheAwareContextLoaderDelegate.java:57)
    at org.springframework.test.context.CacheAwareContextLoaderDelegate.loadContext(CacheAwareContextLoaderDelegate.java:91)
    ... 24 more

谁能帮帮我？我只是 Spring Boot 的新手

【问题讨论】：

Failed to load ApplicationContext when running Integration Tests的可能重复

【参考方案1】：

我有类似的问题。请看下面的代码：

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class ApplicationControllerTest 

@Autowired
MockMvc mockMvc;
@MockBean
ApplicationService applicationService;

@Test
public void testGetImagePath() throws Exception 

    RequestBuilder requestBuilder = MockMvcRequestBuilders.get("/application/get-image")
            .contentType(MediaType.IMAGE_GIF);

    MvcResult result = mockMvc.perform(requestBuilder).andReturn();
    System.out.println(result.getResponse());

请看下面的测试用例执行：

检查您使用的注释，即： 1) @RunWith(SpringRunner.class) 2）@SpringBootTest 3) @AutoConfigureMockMvc

【讨论】：

有些情况需要为@SpringBootTest注解指定classes属性

@MockBean 成功了，谢谢！

【参考方案2】：

对于遇到相同问题的任何人 - 使用 @MockBean 很重要。 （@Mock 不会剪掉它）

见https://spring.io/guides/gs/testing-web/:

我们使用@MockBean 为 GreetingService 创建和注入一个 mock（如果不这样做，应用程序上下文将无法启动），我们使用 Mockito 设置它的期望。

所以如果 OP 刚刚被替换，可能一切都很好

@Mock
private HelloService helloService;

与

@MockBean
private HelloService helloService;

因此，接受答案中的其他类注释应该是不必要的

【参考方案3】：

如果转换为@SpringBootTest，它将成为集成测试。但我们只想使用@WebMvcTest 测试特定的控制器（单元测试），这样它将如何成为一个可行的解决方案。

【讨论】：

表示同意，但没有具体说明如何解决

【参考方案4】：

我遇到了同样的问题并尝试了不同的方法，但没有一个不起作用，最后，我在我的测试类中添加了两个注释来解决我的问题：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
HelloControllerTest 

如果您不想生成随机端口来测试您的 API，只需添加以下注释：

@SpringBootTest
@AutoConfigureMockMvc
HelloControllerTest 

【参考方案5】：

这里缺少的是@SpringBootTest 注释。该注解用于加载@Configuration 类进行测试，并使用默认端口启动嵌入式容器。 如果未指定@Configuration 类，它将使用默认的@SpringBootApplication 类，因为它的注解中有@Configuration。