Java单元测试之JUnit篇

单元测试是编写测试代码，应该准确、快速地保证程序基本模块的正确性。
好的单元测试的标准
JUnit是Java单元测试框架，已经在Eclipse中默认安装。

JUnit4###

JUnit4通过注解的方式来识别测试方法。目前支持的主要注解有：

• @BeforeClass 全局只会执行一次，而且是第一个运行
• @Before 在测试方法运行之前运行
• @Test 测试方法
• @After 在测试方法运行之后允许
• @AfterClass 全局只会执行一次，而且是最后一个运行
• @Ignore 忽略此方法

下面基于Eclipse介绍JUnit的基本应用####

基本测试

1. 新建一个项目叫JUnitTest，我们编写一个Calculator类，这是一个能够简单实现加减乘除、平方、开方的计算器类，然后对这些功能进行单元测试。

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;
    }
}

2. 将JUnit4单元测试包引入这个项目：在该项目上点右键，点“属性”，如图
   
   在弹出的属性窗口中，首先在左边选择“Java Build Path”，然后到右上选择“Libraries”标签，之后在最右边点击“Add Library…”按钮，如下图所示
   
   
   
   然后在新弹出的对话框中选择JUnit4并点击确定，如上图所示，JUnit4软件包就被包含进我们这个项目了。
3. 生成JUnit测试框架：在Eclipse的Package Explorer中用右键点击该类弹出菜单，选择“New JUnit Test Case”。如下图所示：
   
   
   
   点击“下一步”后，系统会自动列出你这个类中包含的方法，选择你要进行测试的方法。此例中，我们仅对“加、减、乘、除”四个方法进行测试。
   
   之后系统会自动生成一个新类CalculatorTest，里面包含一些空的测试用例。你只需要将这些测试用例稍作修改即可使用。
   完整的CalculatorTest代码如下：

public class CalculatorTest {	
	private static Calculator calculator = new Calculator();

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

	@Test
	public void testAdd() {
		calculator.add(3);
        calculator.add(4);
        assertEquals(7, calculator.getResult());

	}

	@Test
	public void testSubstract() {
		calculator.add(8);
        calculator.substract(3);
        assertEquals(5, calculator.getResult());

	}

	@Ignore("Multiply() Not yet implemented")
	@Test
	public void testMultiply() {
		fail("Not yet implemented");
	}

	@Test
	public void testDivide() {
		calculator.add(8);
        calculator.divide(2);
        assertEquals(4, calculator.getResult());

	}

}

4. 运行测试代码：按照上述代码修改完毕后，我们在CalculatorTest类上点右键，选择“Run As a JUnit Test”来运行我们的测试，如下图所示
   
   运行结果如下：
   
   进度条是红颜色表示发现错误，具体的测试结果在进度条上面有表示“共进行了4个测试，其中1个测试被忽略，一个测试失败”。
   限时测试
   对于那些逻辑很复杂，循环嵌套比较深的程序，很有可能出现死循环，因此一定要采取一些预防措施。限时测试是一个很好的解决方案。我们给这些测试函数设定一个执行时间，超过了这个时间，他们就会被系统强行终止，并且系统还会向你汇报该函数结束的原因是因为超时，这样你就可以发现这些Bug了。要实现这一功能，只需要给@Test标注加一个参数即可，代码如下：

    @Test(timeout = 1000)
    public void squareRoot() {
        calculator.squareRoot(4);
        assertEquals(2, calculator.getResult());
    }

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

测试异常##

JAVA中的异常处理也是一个重点，因此你经常会编写一些需要抛出异常的函数。那么，如果你觉得一个函数应该抛出异常，但是它没抛出，这算不算Bug呢？这当然是Bug，并JUnit也考虑到了这一点，来帮助我们找到这种Bug。例如，我们写的计算器类有除法功能，如果除数是一个0，那么必然要抛出“除0异常”。因此，我们很有必要对这些进行测试。代码如下：

  @Test(expected = ArithmeticException.class)
  public void divideByZero(){
        calculator.divide(0);
   }

如上述代码所示，我们需要使用@Test标注的expected属性，将我们要检验的异常传递给他，这样JUnit框架就能自动帮我们检测是否抛出了我们指定的异常。
参数化测试
我们可能遇到过这样的函数，它的参数有许多特殊值，或者说他的参数分为很多个区域。
例如，测试一下“计算一个数的平方”这个函数，暂且分三类：正数、0、负数。在编写测试的时候，至少要写3个测试，把这3种情况都包含了，这确实是一件很麻烦的事情。测试代码如下：

    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提出了“参数化测试”的概念，只写一个测试函数，把这若干种情况作为参数传递进去，一次性的完成测试。代码如下：

    @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());
    }
 }

执行了3次该测试类，依次采用了数据集合中的数据{处理值，预期处理结果}，结果如下：

代码分析如下：

• 为这种测试专门生成一个新的类，而不能与其他测试共用同一个类，此例中我们定义了一个SquareTest类。
• 为这个类指定一个Runner，而不能使用默认的Runner，@RunWith(Parameterized.class)这条语句就是为这个类指定了一个ParameterizedRunner
• 定义一个待测试的类，并且定义两个变量，一个用于存放参数，一个用于存放期待的结果。
• 定义测试数据的集合，也就是上述的data()方法，该方法可以任意命名，但是必须使用@Parameters标注进行修饰。
• 定义构造函数，其功能就是对先前定义的两个参数进行初始化

出处：https://www.cnblogs.com/happyzm/p/6482886.html

==============================================================

SpringBoot与单元测试JUnit的结合

有些人认为，写单元测试就是在浪费时间 ，写完代码，依然还是能够进行测试的。但是，还是建议写单元测试的，可以让你的条理更加清晰，而且当某个功能出现问题时，可能通过单元测试很容易的定位和解决问题。本文主要总结下在Spring及SpringBoot项目中，使用单元测试时的方法。将JUnit4和JUnit5对比着来写，因为我发现我身边的同事经常搞不明白要怎么用。

Juint版本说明

这里主要说明下它们在Maven下的依赖包

Junit4

<dependency>
	<groupId>junit</groupId>
	<artifactId>junit</artifactId>
	<version>4.13</version>
  <!--请注意这个scope的用法-->
  <scope>test</scope>
</dependency>

Junit5

<dependency>
  <groupId>org.junit.jupiter</groupId>
  <artifactId>junit-jupiter</artifactId>
  <version>5.6.2</version>
  <!--请注意这个scope的用法-->
  <scope>test</scope>
</dependency>

在上边的依赖中，两个依赖分别写了scope属性，这里做一个讲解：

一个标准的maven项目结构如下图：

写Java代码的地方有两个src/main/java和src/test/java。如果我们不在上边依赖中添加scope为test属性，就可以在这两个地方任意地方写@Test测试方法，但是，如果添加了这个属性，就只能在src/test/java下写单元测试代码，这个就是maven所谓的test域。从上图也可以看出，test域可以有自己的配置文件，如果没有的话就会去加载main下的resources的配置文件，如果有，则以自己的为优先。

Junit5常见注解及其用法

不管使用哪一种方法，一个标准的单元测试方法如下：

public class TestDemo {
		
    @Test
    void fun1(){
        System.out.println("欢迎关注我的微信公众号——小鱼与Java");
    }
}

但是对于Junit4而言，所有的测试方法应当是public声明的，而Junit5不用。只不过不同的版本，这个@Test的类是不同的：

Junit4: org.junit.Test
Junit5: org.junit.jupiter.api.Test

相比Junit4而言，5添加了新的一些注解，但是常用的注解还是相同的，主要有以下：

注解	Description
@Test	写在一个测试类中的测试方法中的元注解，也就是说，在每一个单元测试方法上都应加上它才会生效
@ParameterizedTest	参数化测试，就是在你的测试方法执行时，自动添加一些参数
@RepeatedTest	重复此测试方法
@TestFactory	动态测试的工厂方法
@TestTemplate	测试模板
@TestMethodOrder	测试方法的执行顺序，默认是按照代码的前后顺序执行的
@DisplayName	自定义测试方法的名称显示
@DisplayNameGeneration	自定义名称生成器
@BeforeEach	在Junit4中，这个注解叫@Before。就是会在每一个测试方法执行前都会执行的方法，包括@Test, @RepeatedTest, @ParameterizedTest,或者 @TestFactory注解的方法
@AfterEach	和上边很相似，在Junit4中，这个注解叫@After。就是会在每一个测试方法执行之后都会执行的方法，包括@Test, @RepeatedTest, @ParameterizedTest, 或者@TestFactory注解的方法.
@BeforeAll	在当前测试类中的方法执行前执行，只会执行一次，在Junit4中是@BeforeClass
@AfterAll	在当前测试类中的所有测试方法执行完之后执行，只会执行一次，在Junit4中是@AfterClass
@Nested	表示一个非静态的测试方法，也就是说@BeforeAll和@AfterAll对此方法无效，如果单纯地执行此方法，并不会触发这个类中的@BeforeAll和@AfterAll方法
@Tag	自定义tag，就是可以自定义一个属于自己的@Test一样功能的注解
@Disabled	表明此方法不可用，并不会执行，在JUnit4中的@Ignore
@Timeout	设定方法执行的超时时间，如果超过，就会抛出异常

以上是在JUnit5中最常用的注解，可以自己挨个试下，一下子就会明白其用法。关注我，后续为您递上具体用法。

在普通Maven项目中使用Junit

引入相关依赖后，然后在对应的位置进行测试就可以了，这里不做演示，可以自行下载代码查看

在Spring项目中使用Junit

这里的Spring和SpringBoot项目也是基于Maven构建的，和普通Maven项目的最大区别就是加载Sprign容器而已，一般来说，使用Spring提供的上下文ApplicationContext就可以从配置文件件或者配置类加载Spring容器。如下代码：

/**
 * 使用普通的Spring上下文来加载Spring容器
 * 
 * @auther 微信公众号：小鱼与Java
 * 2020/4/23
 */
public class MyMain {
    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("application.xml");
        Teacher teacher = (Teacher) ctx.getBean("teacher");
        System.out.println(teacher.getName());
    }
}

但是，我们可以通过引入Spring相关的test依赖来让其自动加载Spring上下文，这样我们就能利用如@Autowired这样的自动注入方式来获取bean了

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-test</artifactId>
  <version>5.2.5.RELEASE</version>
</dependency>

但是这里对于JUnit4和JUnit5写测试方法时有一点儿不同之处，如下：

Junit4

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:application.xml"})
public class TestDemo {
    @Resource
    private Teacher teacher;

    @Test
    public void fun(){
        System.out.println(teacher.getName());
    }
}

Junit5

@SpringJUnitConfig
//指定配置文件路径，会先从test域中找
@ContextConfiguration("classpath:application.xml")
public class SpringTest {

    @Resource
    private Teacher teacher;

    @Test
    void fun(){
        System.out.println(teacher.getName());
    }
}

它们都加了额外的注解来加载Spring上下文的

在SpringBoot项目中使用Junit

在SpringBoot中，为我们提供了一个SpringBootTest的注解来加载Spring容器。在SpringBoot2.2.0以前是JUnit4，在SpringBoot之后是JUnit5。但是我建议最应该使用JUnit5。

Junit4

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>2.1.6.RELEASE</version>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <version>2.1.6.RELEASE</version>
    <!--表示只能在maven的测试域中使用-->
    <scope>test</scope>
  </dependency>
</dependencies>

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestDemo {

   @Resource
   private Student student;

   @Test
   public void fun1(){
        System.out.println(student.getName());
    }
}

Junit5

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>2.2.6.RELEASE</version>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <version>2.2.6.RELEASE</version>
    <!--表示只能在maven的测试域中使用-->
    <scope>test</scope>
    <exclusions>
      <!--这个是JUnit5中为了支持使用JUint4所做的一个过度
       也就是说，你只需要在你的JUnit4旧项目中添加这个依赖，
       就能完美过渡，而不用修改之前代码
       这里用不到，自然也就排除了。当然，这里，它无关紧要
			-->
      <exclusion>
        <groupId>org.junit.vintage</groupId>
        <artifactId>junit-vintage-engine</artifactId>
      </exclusion>
    </exclusions>
  </dependency>
</dependencies>

@SpringBootTest //它默认会为我们加载Spring容器，
public class TestDemo {

    @Resource
    private Student student;

    @Test
    void fun1(){
        System.out.println(student.getName());
    }
}

为什么在SpringBoot中不用指定Spring容器的配置文件？

​ 其实他是会自动加载类路径下的那个SpringBoot的启动类的，就算指定配置文件，也是指定那个启动类为配置类。如果你写的包结构不符合它的要求，就需要自己使用@ContextConfiguration注解来指定Spring的配置类了

关注微信公众号 "小鱼与Java"，回复 2001 获取本文源码

出处：https://www.cnblogs.com/Lyn4ever/p/12764875.html