ServletUnit－开发人员的好帮手

极限编程(XP)强调单元测试，力推测试驱动开发，尽可能减少在设计上花时间。其实，测试，就是设计的一种表述方式，可以被看作一种形式化的、可直接验证的设计。测试通过，也意味着设计的内容得以实现，开发工作完成。这也许就是测试为何如此重要的主要原因。

那么，如何最简单地进行测试呢？JUnit 是这个问题的答案。但是，对服务器上的程序(Servlet, JSP, EJB) 进行测试就不那么容易了，因为 JUnit 测试相当于运行一个普通的本地 Java 程序，而服务器上的应用程序往往需要在一个容器环境中才能运行。这时可以采用两种方式进行测试：1. 直接在容器中进行测试；2. 用一个模拟环境进行测试。

第一种方式看起来很不错，但做起来往往很麻烦。大多数人的开发方式是用测试用例跟踪代码的运行，而要想跟踪容器中运行的代码，往往要用特定的IDE开发工具才能完成。而且，一旦修改代码，往往要经过漫长的发布/重启服务过程，开发效率很低。

第二种方式，即用模拟环境测试，虽然有与真实环境不完全相同的缺点，但其跟踪调试几乎被所有的IDE支持，并且不需要发布服务，编辑－编译－测试循环速度快，能大大提高开发效率，不妨一试。

如何模拟呢？笔者曾自己写过一些 HttpServletRequest, HttpServletResponse 等的模拟类，直到发现 ServletUnit。它也许不很有名，它是更为有名的 HttpUnit 的一部分。HttpUnit 主要被设计为对网站进行“黑盒测试”，而 ServletUnit 则可以对服务器程序进行白盒测试。下面的内容回答这样一些问题：

  - 如何用 ServletUnit 测试一个 servlet？
  - 如何测试登录及模拟登录后的访问？
  - 如何测试 JSP？
  - ServletUnit 能够模拟的对象和功能

* 如何用 ServletUnit 测试一个 servlet？

首先，你需要创建一个Servlet运行器（它模拟了一个容器），并且注册你的 Servlet:

    ServletRunner servletRunner = new ServletRunner();    // (1) 创建运行器
    servletRunner.registerServlet("myServlet", MyServlet.class.getName()); // 注册你的Servlet

然后，你需要创建一个单元测试客户对象:

    ServletUnitClient client = servletRunner.newClient(); // (2) 创建浏览器

它相当于一个浏览器，你告诉它需要浏览的网页地址，这要用到一个 GetMethodWebRequest 或 PostMethodWebRequest 对象:

    WebRequest webRequest = new PostMethodWebRequest(
        "http://localhost/myServlet");                    // (3) 填写要浏览的网页地址
    webRequest.setParameter("color", "red");              //     添加参数

最后，你就可以通过访问上面指定的网页来调用你的 Servlet 了:

    InvocationContext invocation = client.newInvocation(webRequest); // (4) 发出请求
    invocation.getServlet().service(invocation.getRequest(),
                                    invocation.getResponse());

要查看 Servlet 输出的内容，使用一个 WebResponse 对象:

    WebResponse webResponse = invocation.getServletResponse(); // (5) 获得结果
    System.out.print(webResponse.getText());

下面是所有用到的对象清单及其使用次数：
    ServletRunner ----------------- 容器 ------------ 一组测试一个
    ServletUnitClient ------------- 浏览器 ---------- 一个测试用例一个
    WebRequest -------------------- URL地址 --------- 一次请求一个
    (Get/PostMethodWebRequest)
    InvocationContext ------------- Servlet运行环境 - 一次请求一个
    WebResponse ------------------- 返回内容 -------- 一次请求一个

* 如何测试登录及模拟登录后的访问？

首先访问登录页面，然后访问其它页面，使用同一个 ServletUnitClient 对象：

    // 1. 初始化 ServletRunner 和 ServletUnitClient
    ServletRunner servletRunner = new ServletRunner();
    servletRunner.registerServlet("loginServlet", LoginServlet.class.getName());
    servletRunner.registerServlet("myServlet", MyServlet.class.getName());

    ServletUnitClient client = servletRunner.newClient();

    // 2. 访问登录页面
    WebRequest webRequest = new PostMethodWebRequest("http://localhost/loginServlet");
    webRequest.setParameter("username", "zhang");
    webRequest.setParameter("password", "12345");
    InvocationContext invocation = client.newInvocation(webRequest);
    invocation.getServlet().service(invocation.getRequest(),
                                    invocation.getResponse());
    WebResponse webResponse = invocation.getServletResponse();

    WebClient_updateCookies(client, webResponse); //_vip: 说明见下

    // 3. 访问其它页面
    webRequest = new PostMethodWebRequest("http://localhost/myServlet");
    webRequest.setParameter("color", "red");
    invocation = client.newInvocation(webRequest);
    invocation.getServlet().service(invocation.getRequest(),
                                    invocation.getResponse());
    webResponse = invocation.getServletResponse();

需要说明的是，为了在访问其它页面时使用与登录页面相同的 HttpSession 对象，需要在
登录后更新一下我们的单元测试客户对象的 Cookie，调用下面的方法:

    static void WebClient_updateCookies(WebClient client, WebResponse webResponse){
        // 这一段代码参考 WebClient.updateCookies
        String[] names = webResponse.getNewCookieNames();
        for(int i = 0; i < names.length; i++)
            client.addCookie(names[i], webResponse.getNewCookieValue(names[i]));
    }

* 如何测试 JSP？

先将 JSP 编译为 Servlet，然后再访问。

* ServletUnit 能够模拟的对象和功能：
- HttpServletRequest
  : getSession
  : getServletContext
  : getRequestDispatcher
  : get/setAttribute
- HttpServletResponse
- HttpSession
- ServletContext
  : getResource
  : getResourceAsStream
  : get/setAttribute

上面并没有列出所有支持的功能，但从这里可以看到已经可以模拟几乎所有常用的功能了。
需要注意几点：
1) 几个 setAttribute 方法不支持空值
2) 要用 ServletContext.getResource 方法获取本地资源，必须用 new ServletRunner(webXMLFileSpec, contextPath) 的方式构造 ServletRunner 对象，例如:

      String userDir = System.getProperty("user.dir");
      userDir += "\\mywebapp\\WEB-INF\\web.xml";
      servletRunner = new ServletRunner(userDir, "");

   这样模拟的 ServletContext 会根据我们指定的 web.xml 文件的位置去加载其它资源。
   如果 web.xml 比较大，速度会很慢，我们可以写一个空的配置文件 web_blank.xml:

      <?xml version="1.0" encoding="UTF-8"?>
      <web-app>
      </web-app>

   将该文件放在 web.xml 所做目录，然后将上面的 userDir 改为指向 web_blank.xml 即可。

ServletUnit 不能模拟这些功能：
- HttpServletRequest.isRequestedSessionIdValid()
  可以用 null == HttpServletRequest.getSession(false) 判断 Session 是否有效
- JNDI 查找(数据源、EJB等)
  需要自己处理查找数据源的部分，通常这需要修改现有代码，加上一个调试状态变量，
  运行时判断如果处于调试状态，自己通过 JDBC 获取数据库连接。

* 参考和引用

使用HttpUnit进行集成测试(肖菁): http://gceclub.sun.com.cn/staticcontent/html/2004-03-30/httpunit.html   (需要注册)

本文的内容适用于 HttpUnit 1.5.4

本文地址：http://com.8s8s.com/it/it13739.htm