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 1.5.4