基于mock对象的Spring Web组件单元测试

一、基于mock对象的Spring Web组件单元测试技术

1、易测性（在框架中测试每个组件而不管其具体种类）是Spring框架所提倡的关键原则之一

（1）测试传统型J2EE Web组件是一项更为困难的任务

一直以来，与测试独立的Java对象相比，测试传统型J2EE Web组件是一项更为困难的任务，因为Web 组件必须运行在某种服务器平台上并且它们还要与基于HTTP的Web交互细节相联系。

我们前面所介绍的StrutsTestCase技术就是帮助我们解决对依赖服务器容器的各种组件的测试平台。易测性（在框架中测试每个组件而不管其具体种类）是Spring框架所提倡的关键原则之一。

从这一角度看，Spring是对核心J2EE模型的一个重大改进—在以前情况下，在容器外进行组件测试是很难实现的，而且即使是容器内测试也往往要求复杂的安装过程。

（2）Spring Controller或者SimpleFormController的单元测试

2、Spring Mock技术

（1）什么是Mock技术

Mock对象是一个术语，原来主要流行于eXtreme程序员和JUnit小组中。在单元测试上下文中，一个mock 对象是指这样的一个对象——它能够用一些“虚构的占位符”功能来“模拟”实现一些对象接口。

在测试过程中，这些虚构的占位符对象可用简单方式来模仿对于一个组件的期望的行为和结果，从而让你专注于组件本身的彻底测试而不用担心其它依赖性问题。

我们前面所介绍的StrutsTestCase技术中就提供了MockStrutsTestCase来帮助我们对Struts的MVC系统进行Mock方式的测试。

（2）Spring从J2EE的Web端为每个关键接口提供了一个mock实现

●MockHttpServletRequest：几乎每个单元测试中都要使用这个类，它是J2EE Web应用程序最常用的

接口HttpServletRequest的mock实现。

●MockHttpServletResponse：此对象用于HttpServletResponse接口的mock实现。

●MockHttpSession：这是另外一个经常使用的mock对象（后文将讨论此类在会话绑定处理中的应用）。

●DelegatingServletInputStream：这个对象用于ServletInputStream接口的mock实现。

●DelegatingServletOutputStream：这个对象将代理ServletOutputStream实现。在需要拦截和分析写向

一个输出流的内容时，我们可以使用它。

总之，在实现你自己的测试控制器时，上面这些对象是最为有用的。然而，Spring也提供了下列相应于其它不太常用的组件的mock实现（如果我们是一个底层API开发者，那么我们可能会找到其各自的相应用法）。

3、Spring中的其它的Mock技术的API

（1）MockFilterConfig

这是FilterConfig接口的一个mock实现。

（2）MockPageContext

这是JSP PageContext接口的一个mock实现。你会发现这个对象的使用有利于测试预编译的JSP。（3）MockRequestDispatcher

RequestDispatcher接口的一个mock实现，你主要在其它mock对象内使用它。

（4）MockServletConfig

这是ServletConfig接口的一个mock实现。在单元测试某种Web组件（例如Struts框架所提供的Web 组件）时，要求你设置由MockServletContext所实现的ServletConfig和ServletContext接口。

4、如何使用这些mock对象

（1）MockHttpServletRequest类

HttpServletRequest是一个持有描述HTTP参数的固定值的组件，而正是这些参数驱动Web组件的功能。MockHttpServletRequest，作为HttpServletRequest接口的一个实现，允许我们设置这些不可改变的参数。在典型的Web组件测试情形下，我们可以实例化这个对象并按如下方式设置其中的任何参数。

（2）指定表单方法和表单行为

MockHttpServletRequest request = new MockHttpServletRequest("GET", "/SpringWeb/hello.do");

request.addParameter("nameOne", valueOne);

request.addParameter("nameTwo", valuetwo);

注意：

对上面的MockHttpServletRequest request = new MockHttpServletRequest("GET", "/SpringWeb/hello.do");也可

以改变为下面的代码：

MockHttpServletRequest request = new MockHttpServletRequest();

request.setMethod("GET");

request.setRequestURI("/SpringWeb/hello.do");

同样地，我们可以实例化并全面地控制和分析HttpServletResponse和HttpSession对象。

5、Spring对JUnit框架的扩展

（1）AbstractDependencyInjectionSpringContextT ests

这是一个针对所有测试的超类，其具体使用依赖于Spring上下文。

（2）AbstractSpringContextT ests

这是一个针对所有的JUnit测试情形的超类。它使用一个Spring上下文。并且,一般在测试中不是直接使用它，而是使用AbstractDependencyInjectionSpringContextTests或者AbstractTransactionalSpringContextTests这样的派生类。

（3）AbstractT ransactionalSpringContextT ests

这是一个针对所有测试的超类，我们一般把它应用在事务相关的测试中。注意，一旦完成每个测试它就会正常地回滚事务；而且你需要重载onSetUpInTransaction和onTearDownInTransaction方法以便手工开始并提交事务。

（4）AbstractT ransactionalDataSourceSpringContextT ests

这是AbstractTransactionalSpringContextTests的一个子类，它使用了Spring的基于JDBC的jdbcTemplate 工具类。

所有上面这些扩展将极大程度地简化在测试时对于相关操作的依赖性注入和事务管理。

6、测试能够转发到一个正确的视图

基于输入参数生成正确的视图可能是在操作一个Web应用程序时最普通的功能。在Spring MVC的上下文中，这意味着Spring MVC将基于参数的状态返回某种ModelAndView对象。我们可以通过简单地利用如下的Mock对象以一个常规JUnit测试方式来测试这项功能：

public void final testGettingToDetails() throws Exception

{

MyController myController = new MyController();

myController.setDetailsView( detailsViewName );

MockHttpServletRequest request = new MockHttpServletRequest();

MockHttpServletResponse response = new MockHttpServletResponse();

request.setMethod("POST");

request.addParameter("viewDetails", "true");

ModelAndView modelAndView = myController.handleRequest(request, response);

assertEquals("Incorrect view name", detailsViewName,modelAndView.getViewName());

}

既然控制器很可能会利用一些服务对象来决定结果视图，那么你还可以定制控制器中所用的这些mock服务对象。

7、会话相关的操作

对于任何J2EE Web应用程序来说，另一个必须实现的操作是HttpSession绑定处理。例如，Spring MVC 可能需要决定是否一个对象处于会话中及其具体状态以便产生正确的结果。

我们可以利用MockHttpSession对象和JUnit框架测试这种情形。请参考如下的代码片断：

public void testInvokesCorrectMethodWithSession() throws Exception

{

TestController cont = new TestController();

MockHttpServletRequest request = new MockHttpServletRequest("GET", "/invoiceView.app");

request.setSession(new MockHttpSession(null));

HttpServletResponse response = new MockHttpServletResponse();

ModelAndView mv = cont.handleRequest(request, response);

assertTrue("Invoked loggedIn method", cont.wasInvoked("loggedIn"));

assertTrue("view name is ",mv.getViewName().equals("loggedIn"));

assertTrue("Only one method invoked", cont.getInvokedMethods() == 1); //测试控制器但是不使用会话

request = new MockHttpServletRequest("GET", "/invoiceView.app"); response = new MockHttpServletResponse();

try

{

cont.handleRequest(request, response);

fail("Should have rejected request without session");

}

catch (ServletException ex)

{

//在此加入期盼的异常处理

}

}

二、基于mock对象的Spring Web组件单元测试技术的实现示例

1、打开我们的被测试的Project----“在JBUilder 中创建Spring的MVC Web应用.doc”一文中的示例（1）打开它

（2）执行它以看是否有语法错误

2、在JBuilder中再新建一个测试项目-----采用分离的方法

（1）名称为T estSpringWebApp

（2）将被测试的类（SpringappController.java）引入到本测试项目中

3、为本测试Project增加Spring中对Mock的支持的*.jar包文件----spring-mock.jar

（1）由于Spring的Mock技术需要spring-mock.jar的支持，因此我们应该将它添加到我们的Project中。

（2）将spring-mock.jar增加到本Project的库SpringJar中。

（3）再将SpringJar引入到我们的Project中，另外还需要将被测试的项目引入到我们的测试项目中。

再编译本Project以观察是否还出现错误----此时，不应该再出现找不到XXX类的错误！

4、在该Project中增加一个T estCase类

选择我们的被测试的方法handleRequest方法

设置类名称为TestSpringappController，包名称为springwebapptest，基类为junit.framework.TestCase

由于本例不需要其它的固件，因此不需要添加。

最后点击“Finish”按钮，Jbuilder将产生下面的代码。

package springwebapptest;

import junit.framework.*;

import springwebapp.*;

import javax.servlet.*;

import java.io.*;

import javax.servlet.http.*;

import org.springframework.web.servlet.*;

public class TestSpringappController extends TestCase

{

private SpringappController springappController = null;

protected void setUp() throws Exception {

super.setUp();

springappController = new SpringappController(); //不能再采用该方式来产生对象！}

protected void tearDown() throws Exception {

springappController = null;

super.tearDown();

}

public void testHandleRequest() throws ServletException, IOException {

HttpServletRequest request = null;

HttpServletResponse response = null;

ModelAndView expectedReturn = null;

ModelAndView actualReturn = springappController.handleRequest(request, response);

assertEquals("return value", expectedReturn, actualReturn);

/**@todo fill in the test code*/

}

}

5、编程修改前面的代码

package springwebapptest;

import junit.framework.*;

import springwebapp.*;

import javax.servlet.*;

import java.io.*;

import javax.servlet.http.*;

import org.springframework.web.servlet.*;

import org.springframework.mock.web.*;

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.FileSystemXmlApplicationContext;

public class TestSpringappController extends TestCase

{

private SpringappController springappController = null;

protected void setUp() throws Exception

{

super.setUp();

String springXMLFilePath="C:/temp/SpringWebApp/SpringWeb/WEB-INF/springapp-servlet.xml";

ApplicationContext applicationContext = new FileSystemXmlApplicationContext(springXMLFilePath);

springappController = (SpringappController) applicationContext.getBean("springappController");

}

protected void tearDown() throws Exception

{

springappController = null;

super.tearDown();

}

public void testHandleRequest() throws ServletException, IOException

{

MockHttpServletRequest request = new MockHttpServletRequest();

// request.addParameter("paraName",paraValue); //如果在请求过程中需要参数，可以利用该方法提供MockHttpServletResponse response = new MockHttpServletResponse();

/*目前不需要下面的代码，因为我们直接对handleRequest方法调用

request.setMethod("GET");

request.setRequestURI("/SpringWeb/hello.do");

*/

String expectedT argetPage = springappController.getViewPage(); //获得期望跳转的目标

ModelAndVie w modelAndView = springappController.handleRequest(request,response);

String actualT argetPage = modelAndView.getViewName(); //获得实际跳转的目标

assertEquals(expectedT argetPage, actualT argetPage);

}

}

6、执行前面的T estCase类-------不需要启动服务器

将产生下面的提示结果

同时可以观察输出的状态结果

学员练习：实现对本Web项目中的业务组件类TimeDateBusiness进行测试。注意的问题：应该选择什么类型的测试方法？！

1、将被测试的类TimeDateBusiness引入到测试项目中

2、针对上面的TimeDateBusiness类产生出对应的T estCase类

将产生出下面的状态

3、编程该T estCase类

package springwebapptest;

import junit.framework.*;

import springwebapp.*;

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.FileSystemXmlApplicationContext;

public class TestTimeDateBusiness extends TestCase

{

private SpringWebAppBusiness timeDateBusiness = null;

protected void setUp() throws Exception {

super.setUp();

// timeDateBusiness = new TimeDateBusiness();

String springXMLFilePath ="D:/JUnitExmp/SpringWebApp/SpringWeb/WEB-INF/springapp-servlet.xml";

ApplicationContext applicationContext = new FileSystemXmlApplicationContext(springXMLFilePath);

timeDateBusiness = (SpringWebAppBusiness) applicationContext.getBean("timeDateBusiness");

}

protected void tearDown() throws Exception {

timeDateBusiness = null;

super.tearDown();

}

public void testDoGetTimeBusiness()

{

String actualReturn = timeDateBusiness.doGetTimeBusiness();

this.assertNotNull(actualReturn);

}

}

4、执行本测试用例

将出现下面的结果

5、再通过一个测试套件来运行我们的测试用例