如何使用junit编写测试类

Posted 2023-05-01

首先我们需要先下载相应的 JUnit 相关的 JAR 包，下载的过程可以去 JUnit 的官方网站，也可以直接通过 Maven 资源仓库来完成。
使用简单的 @Test 注解实现我们的测试方法的编写和执行
准备工作做好之后，接下来我们就可以开始尝试编写壹个简单的测试代码了。首先，我们编写了壹个 Calculator 类，并提供五个方法分别完成加减乘除以及求平方的运算。代码如下：
package net.oschina.bairrfhoinn.main;
public class Calculator
public void add(int n)
result += n;

public void substract(int n)
result -= n;

public void multiply(int n)
result *= n;

public void divide(int n)
result /= n;

public void square(int n)
result = n * n;

public int getReuslt()
return result;

public void clear()
result = 0;

private static int result;


在测试类中用到了JUnit4框架，自然要把相应地Package包含进来。最主要地一个Package就是org.junit.*。把它包含进来之后，绝大部分功能就有了。还有一句话也非常地重要“import static org.junit.Assert.*;”，我们在测试的时候使用的壹系列assertEquals()方法就来自这个包。大家注意壹下，这是壹个静态包含（static），是JDK5中新增添的壹个功能。也就是说，assertEquals是Assert类中的壹系列的静态方法，壹般的使用方式是Assert. assertEquals()，但是使用了静态包含后，前面的类名就可以省略了，使用起来更加的方便。
另外要注意的是，我们的测试类是壹个独立的类，没有任何父类。测试类的名字也可以任意命名，没有任何局限性。所以我们不能通过类的声明来判断它是不是一个测试类，它与普通类的区别在于它内部的方法的声明，我们接着会讲到。在测试类中，并不是每壹个方法都是用于测试的，所以我们必须使用“注解”来明确表明哪些是测试方法。“注解”也是JDK5的壹个新特性，用在此处非常恰当。我们可以看到，在某些方法的前有@Before、@Test、@Ignore等字样，这些就是注解，以壹个“@”作为开头。这些注解都是JUnit4自定义的，熟练掌握这些注解的含义，对于编写恰当的测试类非常重要。
接下来我们创建壹个测试类 CalculatorTest.java，代码如下：
package net.oschina.bairrfhoinn.test;
import static org.junit.Assert.*;
import org.junit.Test;
import net.oschina.bairrfhoinn.main.Calculator;
public class CalculatorTest
private static Calculator calculator = new Calculator();
@Test
public void testAdd()
calculator.add(7);
calculator.add(8);
assertEquals(15, calculator.getReuslt());



首先，我们要在方法的前面使用@Test标注，以表明这是壹个测试方法。对于方法的声明也有如下要求：名字可以随便取，没有任何限制，但是返回值必须为void，而且不能有任何参数。如果违反这些规定，会在运行时抛出壹个异常。至于方法内该写些什么，那就要看你需要测试些什么了。比如上述代码中，我们想测试壹下add()方法的功能是否正确，就在测试方法中调用几次add函数，初始值为0，先加7，再加8，我们期待的结果应该是15。如果最终实际结果也是15，则说明add()方法是正确的，反之说明它是错的。assertEquals(15, calculator.getResult());就是用来判断期待结果和实际结果是否相等，其中第壹个参数填写期待结果，第二个参数填写实际结果，也就是通过计算得到的结果。这样写好之后，JUnit 会自动进行测试并把测试结果反馈给用户。
如果想运行它，可以在 eclipse 的资源管理器中选择该类文件，然后点击右键，选择 Run As->JUnit Test 即可看到运行结果。
使用@Test 的属性 Ignore 指定测试时跳过这个方法
如果在写程序前做了很好的规划，那么哪些方法是什么功能都应该实现并且确定下来。因此，即使该方法尚未完成，他的具体功能也是确定的，这也就意味着你可以为他编写测试用例。但是，如果你已经把该方法的测试用例写完，但该方法尚未完成，那么测试的时候无疑是“失败”。这种失败和真正的失败是有区别的，因此 JUnit 提供了壹种方法来区别他们，那就是在这种测试函数的前面加上 @Ignore 标注，这个标注的含义就是“某些方法尚未完成，暂不参与此次测试”。这样的话测试结果就会提示你有几个测试被忽略，而不是失败。壹旦你完成了相应函数，只需要把@Ignore标注删去，就可以进行正常的测试。
比如说上面的测试类 Calculator.java 中，假设我们的 Calculator 类的 multiply() 方法没有实现，我们可以在测试类 CalculatorTest 中先写如下测试代码：
package net.oschina.bairrfhoinn.test;
import static org.junit.Assert.*;
import org.junit.Ignore;
import org.junit.Test;
import net.oschina.bairrfhoinn.main.Calculator;
public class CalculatorTest
private static Calculator calculator = new Calculator();
... //此处代码省略
@Ignore("method square() not implemented, please test this later...")
@Test
public void testSquare()
calculator.square(3);
assertEquals(9, calculator.getReuslt());



我们再运行壹次测试，会看到如下结果，从图中可以很明显的看出，方法testSquare() 上的 @Ignore 注解已经生效了，运行时直接跳过了它，而方法testAdd()仍然正常的运行并通过了测试。
使用注解 @Before 和 @After 来完成前置工作和后置工作
前置工作通常是指我们的测试方法在运行之前需要做的壹些准备工作，如数据库的连接、文件的加载、输入数据的准备等需要在运行测试方法之前做的事情，都属于前置工作；类似的，后置工作则是指测试方法在运行之后的壹些要做的事情，如释放数据库连接、输入输出流的关闭等；比如我们上面的测试，由于只声明了壹个 Calculator 对象，他的初始值是0，但是测试完加法操作后，他的值就不是0了；接下来测试减法操作，就必然要考虑上次加法操作的结果。这绝对是壹个很糟糕的设计！我们非常希望每壹个测试方法都是独立的，相互之间没有任何耦合度。因此，我们就很有必要在执行每壹个测试方法之前，对Calculator对象进行壹个“复原”操作，以消除其他测试造成的影响。因此，“在任何壹个测试方法执行之前必须执行的代码”就是壹个前置工作，我们用注解 @Before 来标注它，如下例子所示：
package net.oschina.bairrfhoinn.test;
...
import org.junit.After;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
public class CalculatorTest
...//这里省略部分代码
@Before
public void setUp() throws Exception
calculator.clear();

@After
public void tearDown() throws Exception
System.out.println("will do sth here...");

...//这里省略部分代码


另外要说的是，注解 @Before 是定义在 org.junit.Before 这个类中的，因此使用时需要将其引入我们的代码中。这样做了之后，每次我们运行测试方法时，JUnit 都会先运行 setUp() 方法将 result 的值清零。不过要注意的是，这里不再需要 @Test 注解，因为这并不是壹个 test，只是壹个前置工作。同理，如果“在任何测试执行之后需要进行的收尾工作，我们应该使用 @After 来标注，方法与它类似。由于本例比较简单，不需要用到此功能，所以我们只是简单了给它添加了壹个 tearDown() 方法并在收尾时打印壹句话到控制台，并且使用 @After 来注解这个方法。
使用@BeforeClass 和 @AfterClass 来完成只需要执行壹次的前置工作和后置工作
上面我们提到了两个注解 @Before 和 @After ，我们来看看他们是否适合完成如下功能：有壹个类负责对大文件（超过500 MB）进行读写，他的每壹个方法都是对文件进行操作。换句话说，在调用每壹个方法之前，我们都要打开壹个大文件并读入文件内容，这绝对是壹个非常耗费时的操作。如果我们使用 @Before 和 @After ，那么每次测试都要读取壹次文件，效率及其低下。所以我们希望的是，在所有测试壹开始读壹次文件，所有测试结束之后释放文件，而不是每次测试都读文件。JUnit的作者显然也考虑到了这个问题，它给出了@BeforeClass 和 @AfterClass 两个注解来帮我们实现这个功能。从名字上就可以看出，用这两个注解标注的函数，只在测试用例初始化时执行 @BeforeClass 方法，当所有测试执行完毕之后，执行 @AfterClass 进行收尾工作。在这里要注意壹下，每个测试类只能有壹个方法被标注为 @BeforeClass 或 @AfterClass，而且该方法必须是 public static 类型的。
使用@Test 的属性 timeout 来完成限时测试，以检测代码中的死循环
现在假设我们的 Calculator 类中的 square() 方法是个死循环，那应该怎么办呢，比如说像下面这样：
public void square(int n)
for(;;)


如果测试的时候遇到死循环，你的脸上绝对不会露出笑容的。因此，对于那些逻辑很复杂，循环嵌套比较深的、有可能出现死循环的程序，因此壹定要采取壹些预防措施。限时测试是壹个很好的解决方案。我们给这些测试函数设定壹个预期的执行时间，超过了这壹时间，他们就会被系统强行终止，并且系统还会向你汇报该函数结束的原因是因为超时，这样你就可以发现这些 Bug 了。要实现这壹功能，只需要给 @Test 标注加壹个参数timeout即可，代码如下：
@Test(timeout=2000L)
public void testSquare()
calculator.square(3);
assertEquals(9, calculator.getReuslt());


timeout参数表明了你预计该方法运行的时长，单位为毫秒，因此2000就代表2秒。现在我们让这个测试方法运行壹下，看看失败时是什么效果。
使用@Test 的属性expected来监控测试方法中可能会抛出的某些异常
JAVA中的异常处理也是壹个重点，因此你经常会编写壹些需要抛出异常的函数。如果你觉得壹个函数应该抛出异常，但是它没抛出，这算不算 Bug 呢？这当然是Bug，JUnit 也考虑到了这壹点，并且可以帮助我们找到这种 Bug。例如，我们写的计算器类有除法功能，如果除数是壹个0，那么必然要抛出“除0异常”。因此，我们很有必要对这些进行测试。代码如下：
@Test(expected=java.lang.ArithmeticException.class)
public void testDivide()
calculator.divide(0);


如上述代码所示，我们需要使用@Test注解中的expected属性，将我们要检验的异常（这里是 java.lang.ArithmeticException）传递给他，这样 JUnit 框架就能自动帮我们检测是否抛出了我们指定的异常。
指定 JUnit 运行测试用例时的 Runner
大家有没有想过这个问题，当你把测试代码提交给JUnit框架后，框架是如何来运行你的代码的呢？答案就是Runner。在JUnit中有很多个Runner，他们负责调用你的测试代码，每壹个Runner都有其各自的特殊功能，你要根据需要选择不同的Runner来运行你的测试代码。可能你会觉得奇怪，前面我们写了那么多测试，并没有明确指定壹个Runner啊？这是因为JUnit中有壹个默认的Runner，如果你没有指定，那么系统会自动使用默认Runner来运行你的代码。换句话说，下面两段代码含义是完全壹样的：
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
@RunWith(JUnit4.class)
public class CalculatorTest
...//省略此处代码

//用了系统默认的JUnit4.class，运行效果完全壹样
public class CalculatorTest
...//省略此处代码
参考技术A 首先创建一个java Project；将junit包和hamcrest-core包导入到项目中

创建一个source folder 资源文件夹 test，资源文件夹和普通的文件夹区别是，资源文件夹中的java文件可以被自动编译。

在java文件中编写java代码UserMananger.java，在test文件中创建一个与需要进行测试的java代码同包名称的TestUserManager.java文件。

junit4采用的是通过注解的方式（在方法的上面加上@）.
@Before表示在所有方法运行前运行的方法;
@After表示在所有的方法运行之后执行的方法;
@Test表示这是一个测试方法
@BeforeClass表示在这个测试类构造之前执行的方法
@AfterClass表示在这个测试类构造之后执行的方法

如果是对某一个方法进行测试，在方法的名称上点击右键 --> run as --> JUnit Test

6
如果是对所有的方法都执行一遍,在类体上右键--Run as--> JunitTest .
绿色的表示运行通过的方法,红x的表示运行失败的方法.

Junit4入门之如何编写好的测试类

参考技术A

在使用junit前， 我们需要 了解 一些规则，如何去写好一个测试类。

之所以放在junit前说明，是因为单元测试不一定只能用junit去做，就算我们什么软件依赖都不用，也是可以做的，就是会麻烦点，不要下意识的觉得 单元测试=Junit ，应该是 单元测试 > Junit 。

市面上单元测试并不是只有junit一家的，还有许多其他的框架模块，只是相比之下它们没有junit普及。而且有些公司还有内部的单元测试框架，也未必是基于junit开发的。

甚至必要的时候，哪怕不用Juint，也要进行单元测试，这就只能用Java原生的断言语句等等了。

1）java中断言（assert）的使用

一开始我以为断言是junit中的特色，其实不然，断言是一个编程术语，常用于单元测试中，甚至它都并不只存在于java。

而 java中的断言 ，是在JDK1.4后开始使用的，关键字是assert，它主要是用在代码 开发和测试时期 ，用于对某些数据进行预期判断，如果结果不符合自己的预期，程序就警告或退出。

它的语法大概如下：

语法①：assert condition

condition代表一个布尔类型的条件表达式，如果为真，就继续正常运行，如果为假，则异常退出

这里我断言x>=0，如果计算结果符合我的预期则无事发生，如果计算结果x小于0，则不符合我的预期，断言失败，抛出AssertionError。

语法②：assert condition : message

condition和上面是一样的，冒号后的message通常用于断言失败后的异常提示信息，它就是个传入到AssertionError构造参数里的值，用于我们自定义错误详情的，这里就不放代码了，大家可以自己试试。

关于使用断言还有个最重要的规则： 程序的任何行为都不能依赖断言，千万不要把断言当成程序中的逻辑来使用 ，也就是你的代码即便删除里面所有的断言语句，它的逻辑和之前也是不能有任何变化的。因为它只是用于测试和开发的，甚至JVM默认都是关闭断言使用的，如果没有开启断言，程序会自动忽略所有断言语句，仿佛它们并不存在，要执行assert语句，必须给Java虚拟机传递-enableassertions（可简写为**-ea**）参数 启用断言 ，也可以使用-disenableassertion（简写为**-da） 参数 关闭断言**（默认就是关闭的）。

最后，虽然java有提供断言，但我们实际开发中却很少使用它，因为如果要使用它去测试，还不如直接用Junit框架去写单元测试的代码，Junit也提供了断言的语句。

虽然我们用不上java里的断言，但是也要有所了解，并且大部分的断言其实逻辑都是差不多的。