测试 Spring 托管 servlet

Question

我需要测试一个 servlet，它现在工作正常。

servlet 需要使用 Spring 服务，因此对其进行了修改：

SpringBeanAutowiringSupport.processInjectionBasedOnServletContext(
    this, config.getServletContext()); // ImageServlet.java line 49

迁移到 Spring 4 后，测试中断，目前抛出此异常：

java.lang.IllegalStateException:
No WebApplicationContext found: no ContextLoaderListener registered?
at org.springframework.web.context.support.WebApplicationContextUtils.
    getRequiredWebApplicationContext(WebApplicationContextUtils.java:84)
at org.springframework.web.context.support.SpringBeanAutowiringSupport.
    processInjectionBasedOnServletContext(SpringBeanAutowiringSupport.java:107)
at package.ImageServlet.init(ImageServlet.java:49)
at in.nasv.utils.ImageServletTest.accessingImageViaHttp(ImageServletTest.java:45)

这是 ImageServletTest 的部分代码：

// prepare servlet instance
MockServletConfig config = new MockServletConfig(
    new MockServletContextPatched());
ImageServlet servlet = new ImageServlet();
servlet.init( config ); // ImageServletTest, line 45

而这个打补丁的类（现在实际上并没有打补丁）：

public class MockServletContextPatched extends MockServletContext{ }

我应该怎么做才能避免这种“IllegalStateException：未找到 WebApplicationContext：未注册 ContextLoaderListener？” ?

Answer 1

我找到了解决方案。但足够清楚，但有一个解决方案。

现在 servlet 初始化是：

MockServletContext servletContext = new MockServletContextPatched();
MockServletConfig config = new MockServletConfig( servletContext );
ImageServlet servlet = new ImageServlet();

ClassPathXmlApplicationContext appContext = new ClassPathXmlApplicationContext( "spring-data-app-context.xml" );
DefaultListableBeanFactory dlbf = new DefaultListableBeanFactory(appContext.getBeanFactory());
GenericWebApplicationContext gwac = new GenericWebApplicationContext(dlbf);        
servletContext.setAttribute(GenericWebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, gwac);
gwac.setServletContext(servletContext);
gwac.refresh();

servlet.init( config );

以标准方式准备请求和响应：

MockHttpServletResponse response = new MockHttpServletResponse();

URL serverUrl = new URL( propertyExtendedService.getServerAddress(true) );
MockHttpServletRequest request = new MockHttpServletRequest();
request.setRequestURI( "/what-you-want" );
request.setPathInfo( "/" + TEST_IMAGE );
request.setContentType("image/jpeg");
request.addHeader("Accept", "image/jpeg;image/jpg;" );

最后一步是调用过滤器并断言返回值：

servlet.doGet( request, response );
assertEquals( response.getStatus(), 200 );
// assert everything you want

Answer 2

更新：updated documentation for getServletContext() 现已上线。

---

不必仅仅为了在 Spring 的 MockServletContext 中配置自定义 MIME 类型而实现自定义 MockServletContextPatched 类。

由于 Spring 的 MockServletContext 使用 Java Activation Framework (JAF) 来实现 ServletContext.getMimeType(String) 方法，因此通过 JAF 的 MimetypesFileTypeMap.addMimeTypes(String) 方法配置自定义 MIME 类型非常容易，如下所示。

MockServletContext mockServletContext = new MockServletContext();
MimetypesFileTypeMap mimetypesFileTypeMap =
    (MimetypesFileTypeMap) MimetypesFileTypeMap.getDefaultFileTypeMap();
mimetypesFileTypeMap.addMimeTypes("text/enigma    enigma");
assertEquals("text/enigma", mockServletContext.getMimeType("filename.enigma"));

在上面基于 JUnit 的测试代码中，我为扩展名为 .enigma 的文件配置了自定义 MIME 类型 "text/enigma"。

希望这会有所帮助！

问候，

Sam（Spring TestContext 框架的作者）

附言我创建了 JIRA 问题 SPR-12126 以改进 MockServletContext 的文档。