秒懂如何使用SpringBoot+Junit4进行单元测试

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6

在这里插入图片描述

文章目录

一、目标

  • 学会基于AssertJ的断言技术
  • 学会基于AssertJ-DB的数据库断言技术
  • 学会基于JMockit的mock技术
  • 学会内存和数据库的造数
  • 学会集成Maven进行单元测试、集成测试的执行
  • 学会查看测试覆盖率

二、断言技术

断言库包含很多比如junit自带的、hamcrest等这里推荐使用AssertJ看它的官网就知道了宣称fluent assertions java library。

2.1 核心库断言

AssertJ的断言采用assertThat(result)的形式等同于then(result)这两种方式使用上没有区别我们需要在pom中引入如下依赖

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

下面列出常见的断言用法其它的用法可以参考依赖库学习使用。

  • 对文本的断言

    assertThat(result).isEqualTo("apple");
assertThat(result).isEqualToIgnoringCase("apple");
assertThat(result).contains("apple");
assertThat(result).containsIgnoringCase("apple");
assertThat(result).startsWith("apple");
assertThat(result).matches("^[A-Za-z0-9]{8}$");
assertThat(result).hasSize(10);
assertThat(result).containsSequence("a", "p", "l");
...

  • 对数字的断言

    assertThat(result).isGreaterThanOrEqualTo(100);
assertThat(result).isCloseTo(100.0, Offset.offset(0.000001));
assertThat(result).isBetween(90.0, 91.0),
assertThat(result).isNaN();
...

  • 对日期的断言

    assertThat(result).isAfter(startDate);
assertThat(result).isBefore("2020-01-01");
assertThat(result).isInSameMonthAs("2019-12-01");
...

  • 对集合的断言

    assertThat(result).hasSize(3);
assertThat(result).contains("apple", "orange");
assertThat(result).doesNotcontain("apple", "orange");
assertThat(result).containsExactly("apple", "orange");
assertThat(result).startsWith("apple");
assertThat(result).endsWith("orange");
assertThat(result).doesNotContainNull();
assertThat(result).doesNotHaveDuplicates();
assertThat(result).isNotEmpty();
assertThat(result).isNullOrEmpty();
...
assertThat(result).hasSize(2);
assertThat(result).containsEntry("apple", "12");
assertThat(result).containsKeys("apple", "orange");
assertThat(result).containsOnlyKeys("apple", "orange");
assertThat(result).containsValues("apple", "orange");
...

  • 对对象的断言

    assertThat(result).isEqualToComparingOnlyGivenFields(obj1, "name", "weight");
assertThat(result).isEqualToIgnoringGivenFields(obj1,"name", "weight");
assertThat(result).isEqualToIgnoringNullFields(obj1);
...

2.2 数据库断言

AssertJ-Core只适合为单元测试使用如果要进行集成测试或者只测试DAO层的SQL执行结果就无能为力了这是就需要用到AssertJ-DB首先我们需要在pom中引入如下的依赖

        <dependency>
            <groupId>org.assertj</groupId>
            <artifactId>assertj-db</artifactId>
            <version>1.3.0</version>
            <scope>test</scope>
        </dependency>

下面是一些常用的功能

  • 数据源

    如果我们想使用SpringBoot项目中配置的数据源比如在application.properties中的数据库配置项

    spring.datasource.url=jdbc:postgresql://localhost:5432/mydb?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true
spring.datasource.username=postgre
spring.datasource.password=postgre
spring.datasource.driver-class-name=org.postgresql.Driver

    那么我们就需要在运行该单元测试的时候启动整个Spring Boot工程首先需要先建立一个测试基类

    @RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = DailyWorkServerApplication.class, webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
@Transactional
@Rollback
public class BaseTest {
    // 集成测试基类
      // 如果使用maven运行测试用例需要在maven-surefire-plugin插件中将本基类排除执行否则会报错因为没有测试用例
}

    然后我们的测试基类继承该测试基类

    public class SystemInfoDaoTest extends BaseTest {
    // 获取系统数据源
      @Autowired
    private DataSource dataSource;
    @Autowired
    private PersonDao personDao;

    @Test
    public void getPersonCount() {
          // 构造一个连接到数据源的Request,此处可以先略过后面会有详细介绍
        Request request = new Request(dataSource, "select count(1) from person where name = ?", "zhangsan");
          // assertj-db执行如上Request中的SQL对获取的数据进行断言
        assertThat(request).row(0).column().value().isEqualTo(1);
    }
}

    如果你不想使用SpringBoot的数据源需要自定义数据源那么可以在测试类中这么写

    public class SystemInfoDaoTest extends BaseTest {
    private Source dataSource;
    @Autowired
    private PersonDao personDao;

    private static final String DB_URL = "jdbc:postgresql://localhost:5432/mydb?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true";
    private static final String DB_USER_NAME = "postgre";
    private static final String DB_PASSWORD = "postgre";

    @Before
    public void before(){
        this.dataSource = new Source(DB_URL,DB_USER_NAME,DB_PASSWORD);
    }

    @Test
    public void getUmCount() {
       // 构造一个连接到数据源的Request,此处可以先略过后面会有详细介绍
        Request request = new Request(dataSource, "select count(1) from person where name = ?", "zhangsan");
          // assertj-db执行如上Request中的SQL对获取的数据进行断言
        assertThat(request).row(0).column().value().isEqualTo(1);
    }
}

    当然还可以使用其它类型的DataSource详细信息可以参考文末关于AssertJ-DB的官网内容。

  • Table

    当数据源连接上之后我们可以使用如下的语句来代表某一张具体的表

    Table table = new Table(dateSource, "person");

  • Request

    一个Request可以代表一个即将要执行的SQL请求

    Request request = new Request(dataSource, "select count(1) from person where name = ?", "zhangsan");

  • Row

    Row是基于上面table和request的结果的某一行数据

    // 取当前表的第二行数据
table.row(1);
// 取当前请求的第4行数据然后再跳到第11行数据
request.row(3).row(10);

  • Column

    Column是基于上面table和request的结果的某一列数据

    // 取当前表的第二列数据
table.column(1);
// 取当前请求的第4列数据然后再跳到第11列数据
request.column(3).column(10);
// 取当前请求的第2行数据然后取当前行的第4列单元格
request.row(1).column(3);

  • Value

    Value是基于Row或者Column的某一单元格中的值

    // 取当前请求的第2行数据然后取当前行的第4列单元格的值
request.row(1).column(3).value();

    总结下来只有DAO层的对数据库的增、删、改操作才需要使用AssertJ-DB而查询操作是不需要的因为查询已经将数据加载到内存中只要使用AssertJ-Core做断言比较即可。

    关于这些常用功能的详细案例可以参考文末的Assertj-DB文档。

PS

实验表明对于事务回滚控制的测试用例assertJ-DB似乎并不能得到我们想要的结果。

如下案例中测试用例是事务回滚的但是使用JdbcTemplate可以得到正确的结果但是使用assertJ-DB就不行了。只能针对非事务回滚的测试用例assertJ-DB才能得到正确的结果。这个目前还不知道怎么解决暂时只能用JdbcTemplate替代。

    @Test
    public void addSystemInfoTest(){
        SystemUpdateDTO systemUpdateDTO = new SystemUpdateDTO();
        systemUpdateDTO.setSysNameCN("测试-商品管理系统");
        systemUpdateDTO.setSysNameEN("test-GMS");

        // 测试DAO逻辑-插入一条数据
        systemInfoDao.addSystemInfo(systemUpdateDTO);

        String querySql = "select count(1) from dw_sys_info dsi";
        JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
        Integer rows = jdbcTemplate.queryForObject(querySql,Integer.class);
        // 1
        System.out.println("总共有" + rows);
        Request request = new Request(dataSource, querySql);
        // 0
        System.out.println("总共有" + request.getRow(0).getColumnValue(0).getValue());
    }

三、Mock技术

Mock框架有很多古老的JMock、社区活跃的Mockito、还有我们今天要介绍的主角JMockit。

Mock技术是为了隔离被测试方法依赖的外部变量从而可以使得测试方法的表现只受被测试方法本身的逻辑影响。举个例子

@Service("personService")
public class PersonServiceImpl implements PersonService{
  @Autowired
  private InvokeService invokeService;
  
  @Override
  public Integer getPersonCountBySchool(String school){
    if(StringUtils.isEmpty(school)){
      return 0;
    }
    // 调用关联方获取数据的数量
    return invokeService.getPersonBySchool(school).size();
  }
  ...
}

我们如果想测试getPersonCountBySchool能否正常返回数据的数量我们不必真的去执行invokeService.getPersonBySchool(school)调用关联方只要使用Mock技术让其返回我们设定的值即可

public class PersonServiceImplTest extends BaseTest {
    @Tested
    @Autowired
    private PersonService personService;

    @Test
    public void testGetPersonCountBySchool(@Injectable InvokeService invokeService) {
        // 准备数据
        List<Person> personList = new ArrayList<>();
        Person peter = new Person("东方高中");
        Person jack = new Person("东方高中");
        personList.add(peter);
        personList.add(jack);
      
        // 模拟录制
        new Expectations(){
            {
                // 模拟调用关联方获取数据列表无论入参是什么字符串都返回上面准备好的列表
                invokeService.getPersonBySchool(anyString);
                result = personList;
            }
        };
        
        // 重放
        Integer personCount = personService.getPersonCountBySchool("华夏高中");
      
        // 验证
        assertThat(personCount).isEqualTo(2);
    }
}

在这里最重要的两个注解就是@Tested和@Injectable前者代表需要测试的类后者代表需要mock的对象。

JMockit支持mock一个类、mock一个对象实例、mock一个对象中的某个具体的方法甚至还可以对传入的参数进行检查更多细节请参考文末列举的JMockit的官方文档。

四、造数技术

4.1 内存中造数

我们在运行单元测试的时候为了满足调用参数的要求不得不为参数对象设置值。比如当参数对象为一个Person类的时候倘若它的属性值不多我们可以像上面的例子中一样使用手动造数但是如果属性值很多甚至中间还嵌套了其它对象怎么办手动造数太繁琐了。

  • java-faker可以对生活中常用的事物进行造数使用简单但无法满足复杂对象的造数
  • easy-random可以对复杂对象进行造数而且可以自定义造数的值类型和范围
  • jmockdata可以对复杂对象进行造数而且可以自定义造数的值类型和范围

这些工具库的使用都非常简单参考文末列出的官方文档看下即可。

4.2 数据库造数

我们在测试DAO层关于SQL的增删查改前要先提供一批专供测试使用的假数据一般有以下方式

  • 使用内存数据库

    如果不希望测试用例的执行污染测试数据库那么可以建立一个专为测试用例执行使用的内存数据库缺点是需要维护所有的建表语句。

  • 使用数据库造数工具

    可以使用DBFactory之类的造数工具往测试数据库中提前准备数据但是测试完成后删除数据是个问题。

  • 测试用例使用事务回滚

    好处是不会对测试数据库造成数据污染但是需要在测试用例逻辑执行前手动准备数据

五、Maven集成

我们在如上的学习过程中都是写完单元测试后直接运行了。倘若我们在提交代码前要运行所有的单元测试该怎么操作呢总不可能一个个地打开所有地测试类都点击运行一遍吧。

这里介绍使用Maven的插件进行单元测试运行的集成操作。

5.1 默认配置

首先在pom文件中引入maven-surefire-plugin版本选择最新版

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.19</version>
  </plugin>

其实这就可以了我们使用了默认配置执行mvn生命周期的test就可以运行src/test/java目录下的所有单元测试和集成测试了。

5.2 跳过执行测试用例

有时候我们编译工程并不像运行测试用例那么可以增加如下配置

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.19</version>
                <configuration>
                    <!--跳过执行测试用例-->
                    <skipTests>true</skipTests>
                </configuration>
            </plugin>

5.3 选定运行测试用例

有些场景下我们只想运行某一个/一类/一路径的测试用例我们可以使用<include>来配置

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.19</version>
                <configuration>
                    <!--只运行包含的测试-->
                    <includes>
                        <include>unit/**/*.java</include>
                    </includes>
                </configuration>
            </plugin>

如上配置表示只运行src/test/java/unit路径下所有java结尾的测试类中的测试用例

5.4 排除运行测试用例

有时候我们需要排除运行一些测试用例。比如在编译阶段我们只想快速地运行单元测试而不要运行集成测试那么就可以将集成测试所在的文件路径做如下的配置

           <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.19</version>
                <configuration>
                    <!--需要排除的测试-->
                    <excludes>
                        <!--当不需要运行集成测试时添加如下文件内容-->
                        <exclude>integration/**/*.java</exclude>
                    </excludes>

                    <!--设置并发执行测试节约时间-->
                    <parallel>methods</parallel>
                    <threadCount>10</threadCount>
                </configuration>
            </plugin>

前提是我们所有的集成测试类都必须放在src/test/java/integration目录下。

5.5 多线程运行测试用例

有时候项目中的单元测试和集成测试非常多一次执行会耗时比较久那么可以设置多线程来执行

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.19</version>
                <configuration>
                    <!--设置并发执行测试节约时间-->
                    <parallel>methods</parallel>
                    <threadCount>10</threadCount>
                </configuration>

需要注意的时要确保各测试用例之间没有调用依赖否则便不可使用多线程的方式。

5.6 测试报告及覆盖率的查看

如果仅靠上面引入的maven-surefire-plugin插件那么你只能在控制台看到运行的测试报告如果要跟别人分享十分不方便。可以通过引入maven-surefire-report-plugin插件

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-report-plugin</artifactId>
                <version>2.12.2</version>
                <configuration>
                    <!--报告中是否显示成功率为100%的项目-->
                    <showSuccess>false</showSuccess>
                </configuration>
            </plugin>

执行其中的surefire-report:report命令就可以重新运行所有测试用例并在target/site目录下生成一个html测试报告。

如果想查看测试覆盖率那么就需要引入另外一个插件cobertura-maven-plugin

            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>cobertura-maven-plugin</artifactId>
                <version>2.5.1</version>
            </plugin>

执行其中的cobertura:cobertura命令就可以重新运行所有测试用例并在target/site/cobertura目录下生成一个静态站点文件找到其中的index.html打开就可以看到各个测试覆盖率数据了。

5.7 其它配置

关于maven-surefire-plugin插件还有很多其它配置内容可以参考文末引用自行阅读尝试。

六、经验总结

  • 测试用例的名称一定要突显被测试代码的意图名称不一定要以“Test”结尾可以很长单词之间用下划线连接
  • 要注重测试用例代码的可读性让人一眼就能看出测试意图
  • 测试用例中应该避免使用分支和循环可以拆成多个测试用例
  • 每个测试用例使用prepare-action-verify三段式结构
  • 不要在测试用例中捕获异常应该抛出异常或者期待异常@Test(expected=SomeException)当然还可以使用ExpectedException
  • 测试用例不能依赖数据库中的已有数据应该在测试用例中自己准备数据
  • 测试完成后应该回滚数据避免造成数据库污染保证测试用例可以反复执行
  • 通常不使用单元测试来测JavaBean和Controller所以这两者中尽量也不要有业务逻辑

七、参考文献

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6
标签: Spring
返回列表

上一篇：《Eolink 征文活动- -RESTful接口全解测试-全方位了解Eolink-三神技超亮点》_eolink深度体验

下一篇：Java进阶 - MyBatis查询数据库 && Spring Boot 单元测试 - 细节狂魔

“秒懂如何使用SpringBoot+Junit4进行单元测试” 的相关文章

day05-Spring管理Bean-IOC-031年前 (2023-02-02)
Spring Boot 3.0横空出世，快来看看是不是该升级了1年前 (2023-02-02)
三,Spring AOP1年前 (2023-02-02)
【SpringBoot+MP】针对复杂业务来手动封装一些涉及到多表操作的删除、分页查询方法_mp实现分页查询1年前 (2023-02-02)
通过Docker启动DB2，并在Spring Boot整合DB21年前 (2023-02-02)
springmvc拦截器及源码分析1年前 (2023-02-02)
Spring Cloud服务发现组件Eureka1年前 (2023-02-02)
2022尚硅谷SSM框架跟学(五)Spring基础二1年前 (2023-02-02)
SpringBoot自动装配1年前 (2023-02-02)
SpringMVC视图&视图控制器1年前 (2023-02-02)

阿里云国际版