用Java测试网络代码

网络代码被证明是很难进行完全彻底的测试这是因为测试组件不依赖其他服务器以独立进程形式工作时效果最好本文中Nelson Minar描述了两种单元测试网络代码的方法首先他提出您设计网络代码时应该尽可能地做到逻辑上与网络独立接着他建议使用Java的协议处理器类模拟网络连接而不是使用实际的网络使用这些原则您就可以很轻松地生成网络测试软件

测试网络代码并是一件很困难的事情优秀的单元测试组件运行速度非常快这样开发人员在每次编译之后就能够进行测试当然测试流也要能够稳定地运行这样它们才可以持续捕获代码中的任何错误然而实践证明网络代码（例如从URL上读取的代码）是很难快速并稳定地测试的而且如果测试组件本身进行网络调用测试会因为依赖网络和其他服务器将会变得非常缓慢并十分不稳定

设想一个可以从网页上下载格式化并显示XML数据的程序该程序的本地测试流将需要从一个运行的Web服务器上获取XML数据但是程序的很多部分——XML解析器格式化程序和显示程序——可能不需要依赖网络就可以独立测试请记住这个例子我将在本文中举例说明两种可以测试与网络相关代码的方法当测试进行时这两种方法可以避免使用网络

我首先描述简单的网络激活演示程序PrintRSS然后再讨论如何使用简单的 Reader 和Writer 对象而不是网络连接来设计简化测试的PrintRSS程序最后我将介绍一个允许程序员合成特殊的testurl库使用正常http中的URLs绕过网络注意 测试将使用JUnit 测试框架的 assert() 方法

PrintRSS演示程序

PrintRSS是一个可以从URL读取数据并对数据进行处理的程序它可以很好的演示网络代码的测试PrintRSS 使用RSS格式读取数据这个数据格式可以简单地将新鲜内容并入XML本文中这个重要的RSS结构定义如下

PrintRSS从某个URL下载RSS文档规定内容的具体布局然后以一种易读的方式将标题输出到Systemout

Channel Title

Item

Item

PrintRSS执行四个主要操作

● 打开与某一URL的连接

● 使用XML进行读取

● 格式化数据

● 输出到Systemout

PrintRSS程序将上述的四种功能封装在一个单独的方法（printURL(URL)）中然而很难对这个方法进行测试原因有两个

首先代码依赖于从URL上读取的数据如果URL 是一 URL这就要涉及到网络而且输出到Systemout所产生的影响使代码自己的行为也被隐藏起来好好考虑一下这些问题您又能如何更好地设计Printress来进行测试呢？

使用eaders和writers封装数据

简单地解析和格式化XML代码而不是连接网络您就能分解代码并独立测试数据的逻辑性虽然再分解代码看起来有点令人畏惧但是这样的努力是为了得到更好的代码这是因为代码是经过测试的同时设计也更标准

记住您可以将printURL()的代码解析和格式化功能分解为一个新的方法formatReader(Reader Writer)这个方法专门用于对一个带有XML数据的Reader对象进行解析然后将结果报告输出到提供的Writer

测试 formatReader(Reader Writer)现在变得简单了

testFormatReaderGoodData():

String goodRSSData = +

+

+

+

;

String goodRSSOutput = Channel Title\n Item \n Item \n;

Reader r = new StringReader(goodRSSData);

Writer w = new StringWriter();

PrintRSSformatReader(r w);

assertEquals(goodRSSOutput wtoString());

上面的示例只用readers和writers在没有URL和网络连接的情况下测试了解析和格式化逻辑测试示例演示了一个有用的测试方法创建的reader流将测试数据包含在测试代码中而不是从文件或者网络读取数据实践证明StringReader和StringWriter(或者 ByteArrayInputStream 和ByteArrayOutputStream)在把测试数据嵌入到单元测试流方面是没有价值的

上述的单元测试在一切都正常时执行一定的逻辑进行观察但它对问题出现错误处理代码同样重要接下来就是一个测试坏数据的示例其中巧妙的使用了Junit来检查是否出现异常

testFormatReaderBadData():

String badXMLData = this is not valid xml data;

StringReader r = new StringReader(badXMLData);

try {

PrintRSSformatReader(r new StringWriter());

fail(should have thrown XML error);

} catch (XMLParseException ex) {

// No error we expected an exception

}

readers 和 writers再次封装数据主要的不同在于这里的数据使 formatReader()抛出异常如果没有产生异常就会调用Junit的方法fail()

使用Java 协议处理器测试网络代码

虽然非网络的分离方法可以使程序能像PrintRSS一样易于测试但是这样的努力对于创建完整的测试流还是不够的我们仍希望测试网络代码本身尤其是网络异常控制而且有时候分离到reader接口并不是很方便被测试的代码可能会依赖于一个仅能理解URL的库本部分我将解释如何测试方法 formatURL(URL Writer)这种方法带有URL读取RSS并将数据输出到writer

您可以使用多种方式测试包含URL的代码首先您可以使用标准 URLs 并指向运转的测试服务器然而这种方法要求稳定的Web服务器——少一个组件来使测试复杂化其次您可以使用指向本地文件的 file: URLs这种方法和使 URLs存在相同的问题虽然您可以使用file:或者 URLs访问准确的测试数据但是它仍然很难模拟导致I/O（输入和输出）异常的网络失败

一个测试URL代码的更好方法就是创建新的URL命名空间testurl:使之处于测试程序的完全控制之中——种使用Java协议处理器的简单方法

实现sturl

Java协议处理器允许编程人员使用它们自己的代码实现协议协议处理器很简单

首先满足Java编写协议处理器的需求要处理好三个重要的部分

● 类TTestURLConnection URLConnection的实现可以处理返回输入流标题等实际方法

● 类 Handler 将testurl: URL转换成 TestURLConnection

● 属性javaprotocolhandlerpkgs 表示何处找到新的URL命名空间实现的系统属性

其次提供一个有用的TestURLConnection执行过程在这种情况下库用户看不到实际的 TestURLConnection 相反工作是通过类TestURLRegistry进行的这个类只有一个单独的方法 TestURLRegistryregister(String InputStream)它将输入流和给订的URL联系在一起例如

InputStream inputIS = ;

TestURLRegistryregister(data inputIS);

如此安排使得开放的URL testurl:data返回inputIS中的输入流实现了这一点您就能很容易的构建测试程序控制输出的URL（注意输入流数据并没有复制因此通常情况下每一个URL您只能使用一次）

对准确数据的测试

首先我们使用testurl用准确数据测试formatURL()

testFormatURLGoodStream():

InputStream dataIS = new ByteArrayInputStream(goodRSSDatagetBytes());

TestURLRegistryregister(goodData dataIS);

URL testURL = new URL(testurl:goodData);

Writer w = new StringWriter();

PrintRSSformatURL(testURL w);

assertEquals(goodRSSOutput wtoString());

上面的代码和先前的测试使用相同的数据但这里却把数据与testurl:goodData URL联系起来方法formatURL() 打开并读取URL测试代码保证数据能够正确读取格式化并被输出到Writer

模拟失败

用网络环境编写程序很容易但编写可以正确处理网络失败的代码却比较困难testurl能够模拟网络失败——这是该方法的主要优点

首先模拟连接到某一URL的网络失败是不可能的这种情形的一个典型代表就是远程web服务器没有工作我们的testurl:库包含一个它能理解的URLtestlurl:errorOnConnect 将保证只要您连接到这个URL它就会抛出一个IOException您可以使用这个URL并对程序是否能正确处理URL不能访问的情况进行测试

testFormatURLNoConnection():

URL noConnectURL = new URL(testurl:errorOnConnect);

Writer w = new StringWriter();

try {

PrintRSSformatURL(noConnectURL w);

fail(Should have thrown IO exception on connect);

} catch (IOException ioex) {

}

如果连接失败上面的测试保证formatURL()可以正确地抛出一个IOException但是您将如何测试这样一种情形(起初网络连接正常工作但在交互期间失败)呢？

因为您已经完全控制了与测试URL相关的输入流您就可以选用任意一种输入流实现例如您创建一个简单的类BrokenInputStream它用方法read()封装输入流而方法read()在抛出异常IOException之前只允许读取一定字节数目的数据