Eclipse使用Junit单元测试

咱们在编写大型程序的时候，须要写成千上万个方法或函数，这些函数的功能可能很强大，但咱们在程序中只用到该函数的一小部分功能，而且通过调试能够肯定，这一小部分功能是正确的。可是，咱们同时应该确保每个函数都彻底正确，由于若是咱们从此若是对程序进行扩展，用到了某个函数的其余功能，而这个功能有bug的话，那绝对是一件很是郁闷的事情。因此说，每编写完一个函数以后，都应该对这个函数的方方面面进行测试，这样的测试咱们称之为单元测试。传统的编程方式，进行单元测试是一件很麻烦的事情，你要从新写另一个程序，在该程序中调用你须要测试的方法，而且仔细观察运行结果，看看是否有错。正由于如此麻烦，因此程序员们编写单元测试的热情不是很高。因而有一个牛人推出了单元测试包，大大简化了进行单元测试所要作的工做，这就是JUnit4。本文简要介绍一下在Eclipse3.2中使用JUnit4进行单元测试的方法。

首先，咱们来一个傻瓜式速成教程，不要问为何，Follow Me，先来体验一下单元测试的快感！

首先新建一个项目叫JUnit_Test，咱们编写一个Calculator类，这是一个可以简单实现加减乘除、平方、开方的计算器类，而后对这些功能进行单元测试。这个类并非很完美，咱们故意保留了一些Bug用于演示，这些Bug在注释中都有说明。该类代码以下：

package andycpp;

public class Calculator ... {
    private static int result; // 静态变量，用于存储运行结果
    public void add(int n) ...{
result = result + n;
    }
    public void substract(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;
    }
}

 

第二步，将JUnit4单元测试包引入这个项目：在该项目上点右键，点“属性”，如图：

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


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

    第三步，生成JUnit测试框架：在Eclipse的Package Explorer中用右键点击该类弹出菜单，选择“New à JUnit Test Case”。以下图所示：


在弹出的对话框中，进行相应的选择，以下图所示：


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

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

package andycpp;

import static org.junit.Assert. * ;
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 testSubstract() ...{
        calculator.add(10);
        calculator.substract(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”来运行咱们的测试，以下图所示：

运行结果以下：

进度条是红颜色表示发现错误，具体的测试结果在进度条上面有表示“共进行了4个测试，其中1个测试被忽略，一个测试失败”

 

 

 

咱们继续对初级篇中的例子进行分析。初级篇中咱们使用Eclipse自动生成了一个测试框架，在这篇文章中，咱们来仔细分析一下这个测试框架中的每个细节，知其然更要知其因此然，才能更加熟练地应用JUnit4。

<!--[if !supportLists]-->1、     <!--[endif]-->包含必要地Package

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

<!--[if !supportLists]-->2、     <!--[endif]-->测试类的声明

你们注意到，咱们的测试类是一个独立的类，没有任何父类。测试类的名字也能够任意命名，没有任何局限性。因此咱们不能经过类的声明来判断它是否是一个测试类，它与普通类的区别在于它内部的方法的声明，咱们接着会讲到。

<!--[if !supportLists]-->3、     <!--[endif]-->建立一个待测试的对象。

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

private static Calculator calculator = new Calculator();

为了测试Calculator类，咱们必须建立一个calculator对象。

<!--[if !supportLists]-->4、     <!--[endif]-->测试方法的声明

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

<!--[if !supportLists]-->5、     <!--[endif]-->编写一个简单的测试方法。

首先，你要在方法的前面使用@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会自动进行测试并把测试结果反馈给用户。

<!--[if !supportLists]-->6、     <!--[endif]-->忽略测试某些还没有完成的方法。

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

<!--[if !supportLists]-->7、     <!--[endif]-->Fixture（暂且翻译为“固定代码段”）

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

      @Before

      public void setUp() throws Exception ... {

           calculator.clear();

      }

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

 

 

经过前2篇文章，您必定对JUnit有了一个基本的了解，下面咱们来探讨一下JUnit4中一些高级特性。

1、     高级Fixture

上一篇文章中咱们介绍了两个Fixture标注，分别是@Before和@After，咱们来看看他们是否适合完成以下功能：有一个类是负责对大文件（超过500兆）进行读写，他的每个方法都是对文件进行操做。换句话说，在调用每个方法以前，咱们都要打开一个大文件并读入文件内容，这绝对是一个很是耗费时间的操做。若是咱们使用@Before和@After，那么每次测试都要读取一次文件，效率及其低下。这里咱们所但愿的是在全部测试一开始读一次文件，全部测试结束以后释放文件，而不是每次测试都读文件。JUnit的做者显然也考虑到了这个问题，它给出了@BeforeClass 和 @AfterClass两个Fixture来帮咱们实现这个功能。从名字上就能够看出，用这两个Fixture标注的函数，只在测试用例初始化时执行@BeforeClass方法，当全部测试执行完毕以后，执行@AfterClass进行收尾工做。在这里要注意一下，每一个测试类只能有一个方法被标注为@BeforeClass 或 @AfterClass，而且该方法必须是Public和Static的。

2、     限时测试。

还记得我在初级篇中给出的例子吗，那个求平方根的函数有Bug，是个死循环：

    public void squareRoot( int n) ... {

        for (; ;) ;                 //Bug : 死循环

    }

若是测试的时候遇到死循环，你的脸上绝对不会露出笑容。所以，对于那些逻辑很复杂，循环嵌套比较深的程序，颇有可能出现死循环，所以必定要采起一些预防措施。限时测试是一个很好的解决方案。咱们给这些测试函数设定一个执行时间，超过了这个时间，他们就会被系统强行终止，而且系统还会向你汇报该函数结束的缘由是由于超时，这样你就能够发现这些Bug了。要实现这一功能，只须要给@Test标注加一个参数便可，代码以下：

    @Test(timeout = 1000 )

    public void squareRoot() ... {

        calculator.squareRoot(4);

        assertEquals(2, calculator.getResult());



    }

Timeout参数代表了你要设定的时间，单位为毫秒，所以1000就表明1秒。

3、     测试异常

JAVA中的异常处理也是一个重点，所以你常常会编写一些须要抛出异常的函数。那么，若是你以为一个函数应该抛出异常，可是它没抛出，这算不算Bug呢？这固然是Bug，并JUnit也考虑到了这一点，来帮助咱们找到这种Bug。例如，咱们写的计算器类有除法功能，若是除数是一个0，那么必然要抛出“除0异常”。所以，咱们颇有必要对这些进行测试。代码以下：

  @Test(expected = ArithmeticException. class )

  public void divideByZero() ... {

calculator.divide(0);

  }

如上述代码所示，咱们须要使用@Test  标注的expected 属性，将咱们要检验的 异常传递给他，这样JUnit 框架就能自动帮咱们检测是否抛出了咱们指定的异常。

4、     Runner (运行器)

你们有没有想过这个问题，当你把测试代码提交给JUnit框架后，框架如何来运行你的代码呢？答案就是——Runner。在JUnit中有不少个Runner，他们负责调用你的测试代码，每个Runner都有各自的特殊功能，你要根据须要选择不一样的Runner来运行你的测试代码。可能你会以为奇怪，前面咱们写了那么多测试，并无明确指定一个Runner啊？这是由于JUnit中有一个默认Runner，若是你没有指定，那么系统自动使用默认Runner来运行你的代码。换句话说，下面两段代码含义是彻底同样的：

import org.junit.internal.runners.TestClassRunner;

import org.junit.runner.RunWith;



// 使用了系统默认的TestClassRunner，与下面代码彻底同样

public class CalculatorTest ... {

...

}





@RunWith(TestClassRunner. class )

public class CalculatorTest ... {

...

}

从上述例子能够看出，要想指定一个Runner，须要使用@RunWith标注，而且把你所指定的Runner做为参数传递给它。另一个要注意的是，@RunWith是用来修饰类的，而不是用来修饰函数的。只要对一个类指定了Runner，那么这个类中的全部函数都被这个Runner来调用。最后，不要忘了包含相应的Package哦，上面的例子对这一点写的很清楚了。接下来，我会向大家展现其余Runner的特有功能。

5、     参数化测试。

你可能遇到过这样的函数，它的参数有许多特殊值，或者说他的参数分为不少个区域。好比，一个对考试分数进行评价的函数，返回值分别为“优秀，良好，通常，及格，不及格”，所以你在编写测试的时候，至少要写5个测试，把这5中状况都包含了，这确实是一件很麻烦的事情。咱们还使用咱们先前的例子，测试一下“计算一个数的平方”这个函数，暂且分三类：正数、0、负数。测试代码以下：

import org.junit.AfterClass;

import org.junit.Before;

import org.junit.BeforeClass;

import org.junit.Test;

import static org.junit.Assert. * ;



public class AdvancedTest ... {



private static Calculator calculator ＝ new Calculator();



    @Before

public void clearCalculator() ...{

        calculator.clear();

    }



    @Test

    public void square1() ...{

        calculator.square(2);

        assertEquals(4, calculator.getResult());

    }



    @Test

    public void square2() ...{

        calculator.square(0);

        assertEquals(0, calculator.getResult());

    }



    @Test

    public void square3() ...{

        calculator.square(-3);

        assertEquals(9, calculator.getResult());

    }



}

为了简化相似的测试，JUnit4提出了“参数化测试”的概念，只写一个测试函数，把这若干种状况做为参数传递进去，一次性的完成测试。代码以下：

import static org.junit.Assert.assertEquals;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.junit.runners.Parameterized;

import org.junit.runners.Parameterized.Parameters;



import java.util.Arrays;

import java.util.Collection;



@RunWith(Parameterized. class )

public class SquareTest ... {



    private static Calculator calculator = new Calculator();

    private int param;

    private int result;



    @Parameters

    public static Collection data() ...{

        return Arrays.asList(new Object[][]...{

                ...{2, 4},

                ...{0, 0},

                ...{－3, 9},

        });

    }





//构造函数，对变量进行初始化

    public SquareTest(int param, int result) ...{

        this.param = param;

        this.result = result;

    }



    @Test

    public void square() ...{

        calculator.square(param);

        assertEquals(result, calculator.getResult());

    }



}

下面咱们对上述代码进行分析。首先，你要为这种测试专门生成一个新的类，而不能与其余测试共用同一个类，此例中咱们定义了一个SquareTest类。而后，你要为这个类指定一个Runner，而不能使用默认的Runner了，由于特殊的功能要用特殊的Runner嘛。@RunWith(Parameterized.class)这条语句就是为这个类指定了一个ParameterizedRunner。第二步，定义一个待测试的类，而且定义两个变量，一个用于存放参数，一个用于存放期待的结果。接下来，定义测试数据的集合，也就是上述的data()方法，该方法能够任意命名，可是必须使用@Parameters标注进行修饰。这个方法的框架就不予解释了，你们只须要注意其中的数据，是一个二维数组，数据两两一组，每组中的这两个数据，一个是参数，一个是你预期的结果。好比咱们的第一组{2, 4}，2就是参数，4就是预期的结果。这两个数据的顺序无所谓，谁前谁后均可以。以后是构造函数，其功能就是对先前定义的两个参数进行初始化。在这里你可要注意一下参数的顺序了，要和上面的数据集合的顺序保持一致。若是前面的顺序是{参数，期待的结果}，那么你构造函数的顺序也要是“构造函数(参数， 期待的结果)”，反之亦然。最后就是写一个简单的测试例了，和前面介绍过的写法彻底同样，在此就很少说。

6、     打包测试。

经过前面的介绍咱们能够感受到，在一个项目中，只写一个测试类是不可能的，咱们会写出不少不少个测试类。但是这些测试类必须一个一个的执行，也是比较麻烦的事情。鉴于此，JUnit为咱们提供了打包测试的功能，将全部须要运行的测试类集中起来，一次性的运行完毕，大大的方便了咱们的测试工做。具体代码以下：

import org.junit.runner.RunWith;
import org.junit.runners.Suite;

@RunWith(Suite. class )
@Suite.SuiteClasses( ... {
        CalculatorTest.class,
        SquareTest.class
        } )
public class AllCalculatorTests ... {
}

你们能够看到，这个功能也须要使用一个特殊的Runner，所以咱们须要向@RunWith标注传递一个参数Suite.class。同时，咱们还须要另一个标注@Suite.SuiteClasses，来代表这个类是一个打包测试类。咱们把须要打包的类做为参数传递给该标注就能够了。有了这两个标注以后，就已经完整的表达了全部的含义，所以下面的类已经可有可无，随便起一个类名，内容所有为空既可。

至此，本系列文章所有结束，但愿可以对你们使用JUnit4有所帮助。