Java 单元测试（1）合格的单元测试方式

前言

        最近需要做单元测试代码覆盖率，虽然并不能反映代码的质量；但是在写单元测试的时候，发现对代码的规范上有质的提升。比如：判空处理，比如多分支处理等。单元测试其实是初级程序员的必备技能，只是很多时候忽略了。而在Java的编程中一般单元测试指Junit测试与testng测试。

1. Junit 测试demo

Junit测试其实已经根深蒂固，常用的版本是Junit4，最新的版本Junit5，基本上使用最新版本，功能更强。

1.1 pom依赖

        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>5.6.2</version>
            <scope>test</scope>
        </dependency>

 1.2 模拟类

比如我有一个User类，当然这个类一般不用验证写单元测试（这里仅说一下单元测试方式），单元测试需要花费一定的时间，一般保证核心与复杂功能有覆盖即可。

import lombok.Setter;

@Setter
public class User {

    private String name;

    public String getResult(String test){
        return test + "\tjunit";
    }
}

1.3 单元测试

笔者是一个maven项目，在test的代码里按照User相同的包名创建测试类，需要的资源文件，同理放在resource目录下；一般而言所有的方法都需要覆盖单元测试，但实际情况是部分方法覆盖单元测试就够了。有些公司要求代码单元测试覆盖率，可以多写点。优先保证核心功能。

package com.feng.demo;

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;

class UserTest {

    @Test
    void getResult() {
    }

    @Test
    void setName() {
    }
}

比如上面的单元测试，其实只要getResult方法覆盖就可以了，get set方法一般不需要单元测试。完善一下

单元测试的核心，断言，没有断言的单元测试是没有灵魂的，像我们的system.out或者log.info其实是不标准的。

断言才意味着单元测试OK。

Junit5的官方文档有很详细的介绍：Junit5；常用的注解是@Before与@After

2. 第三方高效断言

2.1 hamcrest  assertThat

引入hamcrest的jar，遗憾的是更新比较慢，这个jar是2019年发布的

<!-- https://mvnrepository.com/artifact/org.hamcrest/hamcrest -->
<dependency>
    <groupId>org.hamcrest</groupId>
    <artifactId>hamcrest</artifactId>
    <version>2.2</version>
    <scope>test</scope>
</dependency>

官方文档：http://hamcrest.org/JavaHamcrest/tutorial；非常详细了，API就不介绍了，etg

2.2 assertJ

推荐使用，官方更新频繁，引入pom即可

        <dependency>
            <groupId>org.assertj</groupId>
            <artifactId>assertj-core</artifactId>
            <version>3.15.0</version>
            <scope>test</scope>
        </dependency>

同理官方文档很详细了，需要的功能自行查找https://assertj.github.io/doc/#assertj-core-assertions-guide

比如

定义了很多类型，都是写好了，无需自行实现

而且可以一次实现多次断言

assertThat(new HashMap()).containsKeys("sss").containsValues("123").hasSize(0);

3. Spring的Junit测试

3.1 Spring MVC

Junit4

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:my-spring.xml")
public class MyServiceTest {
    
    @Autowired
    private MyService xxx;

    @Test
    public void testFind() {
        xxx.xxx();
    }

}

junit5

注意junit5在RunWith注解变为ExtendWith，其中一个显著的优势是可以加载多个class了

@RunWith

@ExtendWith

 

完整示例如下： 

@ExtendWith(SpringExtension.class)
@ContextConfiguration("classpath:my-spring.xml")
public class MyServiceTest {
    
    @Autowired
    private MyService xxx;

    @Test
    public void testFind() {
        xxx.xxx();
    }

}

观看Spring源码也可以看出，junit5命名也变了，叫jupiter

3.2 Spring boot junit

//@RunWith(SpringRunner.class) //junit4加上
@SpringBootTest
class ApplicationTests {

}

 

4.testng

        TestNG：即Testing Next Generation，用JDK的annotation技术来强化测试功能，借助XML 文件强化测试组织结构而构建的测试框架。笔者也没使用过，有官方文档：https://testng.org/doc/documentation-main.html；据说功能更强大，支持xml方式。

引入pom，官方更新没有junit5频繁

<!-- https://mvnrepository.com/artifact/org.testng/testng -->
<dependency>
    <groupId>org.testng</groupId>
    <artifactId>testng</artifactId>
    <version>7.1.0</version>
    <scope>test</scope>
</dependency>

笔者也只是简单的使用过，不过一般而言，只会使用20%的功能（二八原则），改造demo。

package com.feng.demo;


import org.assertj.core.api.Assertions;
import org.testng.annotations.BeforeSuite;
import org.testng.annotations.Test;

class UserTest {
    @BeforeSuite
    static void before(){

    }

    @Test
    void getResult() {
        User user = new User();
        String result = user.getResult("tom");
        Assertions.assertThat(result).isEqualTo("tom\tjunit", result);
    }

    @Test
    void setName() {

    }
}

 更详细的可以看上面的链接文档，etg

 

总结

       junit单元测试其实很简单，很多时候我们并没有规范而已。关于代码测试覆盖率，其实idea工具很完善了，eclipse同理。以idea为例

在代码类上右键

选择Test

即可自动生成单元测试，测试后就有覆盖率统计

结果如下