《重构 改善既有代码的设计》 读书笔记（十五）

第四章 构筑测试体系

可靠的测试是安全重构的前提。

4.1 自测试代码的价值

一套测试就是一个强大的BUG侦测器，能够大大缩短查找BUG所需要的时间。

但我们都很懂，编写测试代码，意味着额外的时间，额外的精力，除非真正地感受到这种方法对编程速度的提升，否则自我测试是没有意义的。（体现不出它的意义）

在通常情况下，我们的测试是手动运行的，如果测试变得自动化，能够自动告诉错误出现在哪里，那么测试就会变得有趣且有意义了。

撰写测试代码最有用的实际是在开始编写之前——编写测试代码代码其实就是在问自己，这个功能需要做些什么。编写测试代码还能使你把注意力集中于接口而非实现。预先写好的测试代码也为你的工作安上一个明确的结束标志。

在Java中，测试的惯用手法是testing main，意思是每个类都应该有一个用于测试的main()。而另一种做法是，建立一个独立类用于测试，并在一个框架中运行它，使测试工作更轻松。

4.2 JUnit测试框架

从现在起，我们又要开始敲代码了。

声明一点：这本书用的JUnit版本比较古老，而我对JUnit其实不很熟悉，所以大致还是按着书的思路来写，如果有必要的话，我也许会修改。

任何包含测试代码的类都必须继承测试框架所提供的TestCase类。这个框架运用了设计模式之组合模式（Compoeite），允许你将测试代码聚集到测试套件（test suite）中。

组合模式：多用于部分-整体这样的关系。它的目的在于把一类东西聚集起来，在外表现出同样的行为接口。（恕我不能很好地讲出，具体还是网上查+实例比较好）

在本章中，将会创造一个FileReaderTester类来测试文件读取器，它与测试框架的UML类图如下：

/'在线作图（UML）网址：
http://www.plantuml.com/plantuml/uml/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000
如果要修改的的话，打开网址后，直接复制上图片链接（或者粘贴下方代码）修改即可'/
@startuml
Title '测试框架的组合结构'
class FileReaderTester
namespace junit.framework #DDDDDD {
interface Test
TestCase <|- .FileReaderTester
Test <|.. TestCase
Test <|.. TestSuite
Test <- TestSuite
}
@enduml

下面开始建立FileReaderTester类。

public class FileReaderTester extends TestCase {
	public FileReaderTester(String name) {
		super(name);
	}
}

对于老版本和新版本的JUnit而言，一个很显著的改变是由继承变成注解，如果之后我能提得起兴趣，可能会把较新版本的JUnit也写一遍。

这个新建的类必须有一个构造函数，完成之后就可以开始添加测试代码了。

首先，要设置测试夹具（test fixture），也就是样本。在这里供我们测试的样本是一个文件。

Bradman		99.94	52	80	10	6996	334	29
Pollock		60.97	23	41	4	2256	274	7
Headley		60.83	22	40	4	2256	270*	10
Sutcliffe	60.73	54	84	9	4555	194	16

在进一步运用这个文件之前，需要准备好测试夹具。

在JUnit中的TestCase类提供两个函数针对此用途：setUp()用来产生相关对象，tearDown()负责删除它们。

我们需要在我们的测试类中对这两个方法进行覆写。（在TestCase类中并没有为这两个方法附带代码）

public class FileReaderTester extends TestCase {
	private FileReader input;
	
	public FileReaderTester(String name) {
		super(name);
	}

	@Override
	protected void setUp() throws Exception {
		try {
			input = new FileReader("data.txt");
		} catch (FileNotFoundException e) {
			throw new RuntimeException("unable to open test file.");
		}
	}

	@Override
	protected void tearDown() throws Exception {
		try {
			input.close();
		} catch (IOException e) {
			throw new RuntimeException("error on closing test file.");
		}
	}
}

让我们看看setUp()和tearDown()在jdk中的注释吧。

/**
 * Sets up the fixture, for example, open a network connection.
 * This method is called before a test is executed.
 * 设置设备，例如，打开网络连接。
 * 在执行测试之前调用此方法。
 * （简单说，就是在测试开始前先执行的一段代码，可以简单理解为构造器的作用）
 */
protected void setUp() throws Exception {
}
/**
 * Tears down the fixture, for example, close a network connection.
 * This method is called after a test is executed.
 * 拆下设备，例如，关闭网络连接。
 * 此方法在执行测试后调用。
 * （擦屁股的一个类，会在最后执行，类似于finally）
 */
protected void tearDown() throws Exception {
}

现在测试类准备就绪了，开始编写测试代码。

首先测试read()：读取一些字符，然后检查后续读取的字符是否正确。这些测试方法都放在刚才我们建立的FileReaderTester类中。

public void testRead() throws IOException {
	char ch = '&';
	for (int i = 0; i < 4; i ++)
		ch = (char) input.read();
	// 断言
	assert ('d' == ch);
}

assert()扮演自动测试角色。（这是这本书之前提到的断言，我不熟悉这个东西）

如果assert()参数值为true，一切安好；否则我们就会收到错误通知。

下面，我们要让这个测试运行起来。

先在测试类中创造一个测试套件。

public static Test suite() {
	TestSuite suite = new TestSuite();
	suite.addTest(new FileReaderTester("testRead"));
	return suite;
}

在我一开始看的时候，其实是有一些懵的，不仅不知道它的作用，也不知道这么写为什么没有报错，但是可以回过头看看之前的那个类图，这些继承关系使得它不报错。

阅读这部分的源码（Test、TestSuite和TestCase），也许能更好地理解组合模式。

在这个测试套件（指代返回的TestSuite对象）中，只含有一个测试用例对象，即FileReaderTester实例。在增加测试用例时，我把待测函数的名称以字符串形式传给构造函数，从而创建一个对象，用以测试被指定的函数。这里是利用了Java的反射机制和对象关联，有兴趣可自行研究JUnit源码。

如果要让测试跑起来，需要一个独立的TestRunner类。

你可以写一个GUI，也可以用控制台。此处不用GUI。

public static void main(String[] args) {
	junit.textui.TestRunner.run(suite());
}

运行起来即可。

提供suite.addTest()方法我们可以添加多个测试类，然后去统一运行测试，这就让我们的测试更加系统化。

--------这一段我用eclipse测试时不会报错-begin--------

public void testRead() throws IOException {
	char ch = '&';
	for (int i = 0; i < 4; i ++)
		ch = (char) input.read();
	// 断言 本来此处的ch值应为d，此表达式false
    // 在书中说这里能显示一个错误信息，可我这里没有
	assert ('2' == ch);
}

--------这一段我用eclipse测试时不会报错-end--------

书中提到了另一种形式的断言，这种我这里可以报错。

public void testRead() throws IOException {
	char ch = '&';
	for (int i = 0; i < 4; i ++)
		ch = (char) input.read();
	// 断言
	assertEquals('2', ch);
}

通常情况，建议在写好测试代码时，先故意错误——这样能保证测试机制的确运行了，并且可以报错。

JUnit还包含一个很好的图形用户界面，如果所有测试顺利通过，就是绿色，只要有一个测试失败，就是红色进度条。这是一个很方便的测试环境。