为什么使用 Spring 3.1 WebMvcConfig 进行单元测试会失败？

Question

从 Spring 3.1 开始，由于 @Enable* 注释，我们可以更轻松地使用 JavaConfig。

所以我做了一个 WebConfig 来设置 WebMvc 配置，并尝试测试它。但是，如果我使用 WebConfig 扩展 WebMvcConfigurerAdapter 或 WebMvcConfigurationSupport，则单元测试会因缺少 ServletContext 而失败。代码和消息如下所示。

WebConfig.java

@Configuration
@EnableWebMvc
public class WebConfig extends WebMvcConfigurationSupport {}

Test.java

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes=WebConfig.class)
public class TestFail {
    @Test
    public void test() {}
}

留言

java.lang.IllegalStateException: Failed to load ApplicationContext
    at org.springframework.test.context.TestContext.getApplicationContext(TestContext.java:157)
    at org.springframework.test.context.support.DependencyInjectionTestExecutionListener.injectDependencies(DependencyInjectionTestExecutionListener.java:109)
    at org.springframework.test.context.support.DependencyInjectionTestExecutionListener.prepareTestInstance(DependencyInjectionTestExecutionListener.java:75)
...
Caused by: java.lang.IllegalArgumentException: A ServletContext is required to configure default servlet handling
    at org.springframework.util.Assert.notNull(Assert.java:112)
    at org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer.<init>(DefaultServletHandlerConfigurer.java:54)
    at org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport.defaultServletHandlerMapping(WebMvcConfigurationSupport.java:253)
    at com.zum.news.comments.web.WebConfig$$EnhancerByCGLIB$$8bbfcca1.CGLIB$defaultServletHandlerMapping$10(<generated>)
    at com.zum.news.comments.web.WebConfig$$EnhancerByCGLIB$$8bbfcca1$$FastClassByCGLIB$$19b86ad0.invoke(<generated>)
    at net.sf.cglib.proxy.MethodProxy.invokeSuper(MethodProxy.java:215)
    at org.springframework.context.annotation.ConfigurationClassEnhancer$BeanMethodInterceptor.intercept(ConfigurationClassEnhancer.java:280)
    at com.zum.news.comments.web.WebConfig$$EnhancerByCGLIB$$8bbfcca1.defaultServletHandlerMapping(<generated>)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
    at java.lang.reflect.Method.invoke(Method.java:597)
    at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:149)
    ... 41 more

如何正确地对 WebConfig 进行单元测试？

编辑

正如 Garcia 所说，这个错误已在 Spring 3.2.0.RC1 中修复。

只需在测试类中添加@WebAppConfiguration注解即可。

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration(classes=WebConfig.class)
public class TestFail {
    @Test
    public void test() {}
}

Answer 1

如果@EnableWebMvc 注释需要ServletContext，那么我建议将您的配置拆分为bean 定义，这些定义将用于单元测试和应用程序和框架使用的其他配置。在这种情况下，应用程序将同时导入配置，而单元测试将只导入一个。

BeansConfig.java:

@Configuration
public class BeansConfig {
    @Bean
    MyBean myBean() {
        return new MyBean()
    }
}

WebConfig.java:

@Configuration
@EnableWebMvc
@Import(BeansConfig.class)
public class WebConfig extends WebMvcConfigurationSupport {}

TestFail.java:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes=BeansConfig.class)
public class TestFail {
    @Test
    public void test() {}
}

Answer 2

我的另一个建议是使用spring-test-mvc，它在内部创建了一个模拟 servlet 上下文，以便控制器测试工作。

如果您想继续使用您的方法，您可能必须创建自己的 Spring Context 加载器，该加载器另外初始化一个 Mock servlet 上下文 - 遵循以下原则： http://tedyoung.me/2011/02/14/spring-mvc-integration-testing-controllers/, 来自Spring-test-mvc source

Answer 3

Spring 3.1有一个bug，你可以在这两个问题中找到答案：

• https://jira.springsource.org/browse/SPR-5243
• https://jira.springsource.org/browse/SPR-9799

如果您找到 Spring 3.1 的解决方法，请告诉我们，如果没有，我们必须等到 3.2 发布。我不得不说我刚刚用 Spring 3.2.0.M2 尝试过，但它仍然不适合我。

Answer 4

正如 Guido 之前提到的，这已在 3.2 中解决。以下是如何利用新测试改进的详细信息。为确保为您的测试加载 servlet 上下文，您需要使用 @WebAppConfiguration 注释您的测试并将AnnotationConfigWebContextLoader 定义为您的上下文加载器，如下所示：

@RunWith(SpringJUnit4ClassRunner.class)    
@WebAppConfiguration
@ContextConfiguration(
    classes = MyWebConfig.class, 
    loader = AnnotationConfigWebContextLoader.class)
public class MyTest {
    //...
}