Eclipse中的JUnit使用手册

一、JUnit概述

1.1 简介

JUnit是一个Java语言的单元测试框架。它由Kent Beck和Erich Gamma建立，逐渐成为源于Kent Beck的sUnit的xUnit家族中最为成功的一个。 JUnit有它自己的JUnit扩展生态圈。多数Java的开发环境都已经集成了JUnit作为单元测试的工具。JUnit测试是程序员测试，即所谓白盒测试，因为程序员知道被测试的软件如何（How）完成功能和完成什么样（What）的功能。JUnit是一套框架，继承TestCase类，就可以用JUnit进行自动测试了。

1.2环境配置

首先，必须安装好JDK，并且需要配置好环境变量，具体如何安装和配置这里就不多说，相信之前学习Java的时候已经配置好了。在这里推荐大家安装JDK后安装Eclipse这款软件，这款软件不仅可以编写Java项目，同时还可以进行JUnit测试。

断言，它是JUnit框架里面的若干个方法，用来判断某个语句的结果是否为真，是否和预期相符。所有的断言都包含在 Assert 类中，这个类提供了很多有用的断言方法来编写测试用例。只有失败的断言才会被记录。Assert 类中的一些常用的断言如下所示：

二、JUnit的使用

2.1JUnit断言

1. 断言

该断言的作用是判断一条语句或一个表达式的结果是否为真，其基本形式为：

assertTrue(condition)。condition为布尔类型，条件为真，执行通过；否则，如果条件为假，那么断言就会执行失败。

assertTrue的具体代码如下:

public void assertTrue(Boolean condition){

         if (! Condition){

                  abort();

         }

}

2. assertEquals断言

assertEquals断言的作用是判定两个表达式的值是否相等，其基本新式为：

assertEquals([String message], expected, actual)。expected是期望值，由测试人员自己指定。actual是测试代码实际产生的值。如果expected和actual相等，则该断言执行通过，否则就会报错，而报错的信息可以通过第一个参数String message输入，当然该参数是可选的，也可以不输入。

大部分基本的数据类型都可以使用该断言进行比较，如整形(int)、短整形(short)、布尔型(Boolean)等。但是对于浮点型(float和double)的数据来说则需要特殊考虑，需要指定一个额外的误差参数，其基本形式如下：assertEquals([String message], expected, actual, tolerance)。

比如下面的一个例子：assertEquals(“两数不相等”, 3.33, 10.0/3.0, 0.01)。该断言表示精确到小数点后两位，该断言可通过，但如果精确到小数点后三位断言则通过不了了。

3. assertSame断言

该断言的作用是判断两个引用的是否指向同一个对象，其基本形式为：

assertSame([String message], expected, actual)。如果expected和actual这两个引用指向同一个对象，该断言通过；否则，执行失败。

4. assertNull断言

该断言的作用是判定一个对象是否为空，其基本形式为：

assertNull([String message], java.lang.Objectobject)。如果一个给定的对象为null，则该断言通过；否则，执行失败。

5. fail断言

该断言的作用是立即终止测试代码的执行，其基本形式为：

Fail([String message])。该断言通常会放在测试代码中某个不应该到达的分支处。

2.2单元测试

2.2.1单元测试实例

首先在Eclipse中新建一个项目叫JUnit_Test，我们编写一个Calculator类，这是一个能够简单实现加减乘除的计算器类，然后对这些功能进行单元测试。

这个类并不是很完美，我们故意保留了一些Bug用于演示，这些Bug在注释中都有说明。该类代码如下：

package com.examples.test;

public class Calculator 
{
	private static int result; // 静态变量，用于存储运行结果
	
    public void add(int n) 
    {
        result = result + n;
    }
    public void subtract(int n) 
    {
        result = result - 1;  //Bug: 正确的应该是 result = result - n
    }
    public void multiply(int n) 
    {
    	 // 此方法尚未写好
    }         
    public void divide(int n) 
    {
        result = result / n;
    }
    public void square(int n)
    {
        result = n * n;
    }
    public void squareRoot(int n) 
    {
        for (; ;) ;      //Bug : 死循环
    }
    public void clear() // 将结果清零
    {     
        result = 0;
    }
    public int getResult()
    {
        return result;
    }
}

代码编写好后就需要配置一下JUnit了。将JUnit4单元测试包引入这个项目，在该项目上点右键，点“Properties”，如图2.1所示：

在弹出的属性窗口中，首先在左边选择“Java Build Path”，然后到右上选择“Libraries”标签，之后在最右边点击“Add Library…”按钮，如下图所示：

然后在新弹出的对话框中选择JUnit4并点击确定，如下图所示，JUnit4软件包就被包含进我们这个项目了。

接下来生成JUnit测试框架，在Eclipse的PackageExplorer中用右键点击Calculator类弹出菜单，选择“New> Other”,在弹出的窗口中找到“Java>JUnit>JUnit Test Case”如下图所示：

在弹出的对话框中，进行相应的选择：

点击“Next”后，系统会自动列出你这个类中包含的方法，选择你要进行测试的方法。此例中，我们仅对“加、减、乘、除”四个方法进行测试：

之后系统会自动生成一个新类CalculatorTest，里面包含一些空的测试用例。你只需要将这些测试用例稍作修改即可使用。完整的CalculatorTest代码如下：

package com.examples.test;

import static org.junit.Assert.assertEquals;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;

public class CalculatorTest 
{
	private static Calculator calculator = new Calculator();
	
	@Before
	public void setUp() throws Exception //初始化操作
	{
		calculator.clear();
	}

	@Test
	public void testAdd() //测试加法
	{
		calculator.add(2);
        calculator.add(3);
        assertEquals(5, calculator.getResult());
	}

	@Test
	public void testSubtract() //测试减法
	{
		calculator.add(10);
        calculator.subtract(2);
        assertEquals(8, calculator.getResult());
	}

	@Ignore("Multiply() Not yet implemented")
	@Test
	public void testMultiply() //测试乘法
	{
	}

	@Test
	public void testDivide() //测试除法
	{
		calculator.add(8);
		calculator.divide(2);
		assertEquals(4, calculator.getResult());
	}

}

按照上述代码修改完毕后，我们在CalculatorTest类上点右键，选择“Run As> JUnit Test”来运行我们的测试，

在这里需要注意一个问题，如果Eclipse中配置了android，运行时会多出一个android的JUnit Test Launcher选项，如下图所示：

我们不要选择这个，只需要选择Eclipse的JUnit Launcher即可。运行结果如下：

进度条是红颜色表示发现错误，具体的测试结果在进度条上面有表示“共进行了4个测试，其中1个测试被忽略，一个测试失败”。同样，进度条是绿色的话就代表测试的方法都通过了。

2.2.2 JUnit单元测试实例分析

我们继续对实例进行分析。上节的实例中我们使用Eclipse自动生成了一个测试框架，接下来，我们来仔细分析一下这个测试框架中的每一个细节，知其然更要知其所以然，才能更加熟练地应用JUnit4。

一、包含必要地Package

在测试类中用到了JUnit4框架，自然要把相应地Package包含进来。最主要地一个

Package就是org.junit.*。把它包含进来之后，绝大部分功能就有了。还有一句话也非常地重要“import static org.junit.Assert.*;”，我们在测试的时候使用的一系列assertEquals方法就来自这个包。大家注意一下，这是一个静态包含（static），是JDK5以来新增添的一个功能。也就是说，assertEquals是Assert类中的一系列的静态方法，一般的使用方式是Assert. assertEquals()，但是使用了静态包含后，前面的类名就可以省略了，使用起来更加的方便。

二、测试类的声明

大家注意到，我们的测试类是一个独立的类，没有任何父类。测试类的名字也可以任意命名，没有任何局限性。所以我们不能通过类的声明来判断它是不是一个测试类，它与普通类的区别在于它内部的方法的声明。

三、创建一个待测试的对象

你要测试哪个类，那么你首先就要创建一个该类的对象。正如上一篇文章中的代码：

private static Calculator calculator = newCalculator()。为了测试Calculator类，我们必须创建一个calculator对象。

四、测试方法的声明

在测试类中，并不是每一个方法都是用于测试的，你必须使用“标注”（也可称为“注释”）来明确表明哪些是测试方法。“标注”也是JDK5以来的一个新特性，用在此处非常恰当。我们可以看到，在某些方法的前面有@Before、@Test、@Ignore等字样，这些就是标注，以一个“@”作为开头。这些标注都是JUnit4自定义的，熟练掌握这些标注的含义非常重要。

JUnit 中的这些标注为我们提供了测试方法的相关信息，哪些方法将会在测试方法前后应用，哪些方法将会在所有方法前后应用，哪些方法将会在执行中被忽略。下面列出JUnit 中的标注的列表以及他们的含义：

序号	描述
1	@Test 这个标注说明依附在 JUnit 的 public void 方法可以作为一个测试用例。
2	@Before 有些测试在运行前需要创造几个相似的对象。在 public void 方法加该标注是因为该方法需要在 每一个test方法前运行。
3	@After 如果你将外部资源在 Before 方法中分配，那么你需要在测试运行后释放他们。在 public void 方法加该标注是因为该方法需要在每一个test方法后运行。
4	@BeforeClass 在 public static void 方法加该标注是因为该方法需要在类中所有方法前运行。
5	@AfterClass 它将会使方法在所有测试结束后执行。这个可以用来进行清理活动。
6	@Ignore 这个标注是用来忽略有关不需要执行的测试的。

五、编写一个简单的测试方法

首先，你要在方法的前面使用@Test标注，以表明这是一个测试方法。对于方法的声明也有如下要求：名字可以随便取，没有任何限制，但是返回值必须为void，而且不能有任何参数。如果违反这些规定，会在运行时抛出一个异常。至于方法内该写些什么，那就要看你需要测试些什么了。比如：

@Test
public void testAdd()
{
        calculator.add(2);
        calculator.add(3);
        assertEquals(5, calculator.getResult());
}

我们想测试一下“加法”功能时候正确，就在测试方法中调用几次add函数，初始值为0，先加2，再加3，我们期待的结果应该是5。如果最终实际结果也是5，则说明add方法是正确的，反之说明它是错的。assertEquals(5, calculator.getResult());就是来判断期待结果和实际结果是否相等，第一个参数填写期待结果，第二个参数填写实际结果，也就是通过计算得到的结果。这样写好之后，JUnit会自动进行测试并把测试结果反馈给用户。

六、忽略测试某些尚未完成的方法

如果你在写程序前做了很好的规划，那么哪些方法是什么功能都应该事先定下来。因此，即使该方法尚未完成，他的具体功能也是确定的，这也就意味着你可以为他编写测试用例。但是，如果你已经把该方法的测试用例写完，但该方法尚未完成，那么测试的时候一定是“失败”。这种失败和真正的失败是有区别的，因此JUnit提供了一种方法来区别他们，那就是在这种测试函数的前面加上@Ignore标注，这个标注的含义就是“某些方法尚未完成，暂不参与此次测试”。这样的话测试结果就会提示你有几个测试被忽略，而不是失败。一旦你完成了相应函数，只需要把@Ignore标注删去，就可以进行正常的测试。

七、Fixture（暂且翻译为“固定代码段”）

Fixture的含义就是“在某些阶段必然被调用的代码”。比如我们上面的测试，由于只声明了一个Calculator对象，他的初始值是0，但是测试完加法操作后，他的值就不是0了；接下来测试减法操作，就必然要考虑上次加法操作的结果。这绝对是一个很糟糕的设计！我们非常希望每一个测试都是独立的，相互之间没有任何耦合度。因此，我们就很有必要在执行每一个测试之前，对Calculator对象进行一个“复原”操作，以消除其他测试造成的影响。因此，“在任何一个测试执行之前必须执行的代码”就是一个Fixture，我们用@Before来标注它，如前面例子所示：

@Before
public void setUp() throws Exception	
{
	calculator.clear();
}

这里不再需要@Test标注，因为这不是一个test，而是一个Fixture。同理，如果“在任何测试执行之后需要进行的收尾工作”也是一个Fixture，使用@After来标注。由于本例比较简单，没有用到此功能。