在Spring-Boot中进行单元测试

2023-10-27

要进行单元测试,需要引入依赖:

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-test</artifactId>
   <scope>test</scope>
</dependency>

设有一个Controller,其路径为src/main/java/com/template/controller/HelloWorldController:

package com.template.controller;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloWorldController {

    @RequestMapping("/HelloWorld")
    public JSONObject index() {
        JSONObject r = new JSONObject();
        ((JSONObject) r).put("name", "tesla");
        ((JSONObject) r).put("age", 88);
        return r;
    }
}

现在要对该Controller编写单元测试:

1.在路径src/test/java/com/template下,创建对应的controller文件夹,并在其下添加HelloWorldControllerTest.java。

2.编写测试代码:

package com.template.controller;

import com.alibaba.fastjson.JSON;
import com.template.TemplateApplication;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class HelloWorldControllerTest {
    @Autowired
    HelloWorldController hwController;

    // 初始化
    @Before
    public void setUp() throws Exception {
        System.out.println("执行初始化");
    }

    // 测试
    @Test
    public void test() throws Exception {
        JSONObject r = hwController.index();
        System.out.println(r.toJSONString());
    }
}

其中:

  • 类名为HelloWorldControllerTest,也就是HelloWorldController的类名后添加一个Test,这不是强制的,可以看作一种习惯。类名前要添加@RunWith(SpringRunner.class)@SpringBootTest
  • 使用@Autowired来引入HelloWorldController变量。这样就可以在成员函数中调用HelloWorldController的各个函数。
  • @Before注解用于初始化。因为测试之前很可能需要设定一些变量等,可以在该函数里执行。测试函数运行时,会先执行@Before注解函数。
  • 测试函数使用@Test注解。在该函数中调用HelloWorldController变量来执行某些操作即可。

3.在测试函数test()函数上点右键,选择Run或者Debug。

即可看到控制台打印的结果。

 

通常,使用System.out.println()将测试需要查看的值打印出来,或者直接加断点,就已经可以满足测试需求了。然而为了更高效的测试,还可以使用两种方式:

  1. Assert.assertThat()断言。
  2. Mock
 

Assert.assertThat()断言

格式:

Assert.assertThat(需测试对象, 测试条件)

即传入两个参数,一个是需要测试的对象,另一个是测试的条件。

例如:

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.template.TemplateApplication;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import static org.hamcrest.core.Is.is;

@RunWith(SpringRunner.class)
@SpringBootTest
public class HelloWorldControllerTest {
    @Autowired
    HelloWorldController hwController;

    // 初始化
    @Before
    public void setUp() throws Exception {
        System.out.println("执行初始化");
    }

    // 测试
    @Test
    public void test() throws Exception {
        JSONObject r = hwController.index();
        Assert.assertThat(r.getString("name"),is("tesla"));
    }
}

若测试通过,会看到提示:

若测试没有通过:

这里判断条件使用了is()函数。

判断条件所用的函数非常多:

1.   assertThat( testedNumber, allOf( greaterThan(8), lessThan(16) ) );

allOf传入多个条件,所有条件必须都成立测试才通过,相当于“与”(&&)。

2.   assertThat( testedNumber, anyOf( greaterThan(16), lessThan(8) ) );

anyOf传入多个条件,所有条件只要有一个成立则测试通过,相当于“或”(||)。
3.   assertThat( testedNumber, anything() );

anything传入一个String或者不传,无论传入的是什么,永远为true。
4.   assertThat( testedString, is( "developerWorks" ) );

is若前面待测的object等于后面给出的object,则测试通过。
5.   assertThat( testedString, not( "developerWorks" ) );

not与is匹配符相反,若前面待测的object不等于后面给出的object,则测试通过。

除此之外还有很多其他用于字符串,数值,iterator,map等的判断条件。

 

Mock

对一个Controller进行测试,通常需要:启动服务→打开浏览器/测试工具→发出请求→收到Controller的返回数据并打印。而且测试一个Controller,必须将整个工程全部加载。

Mock可以创建一个虚拟的对象来代替那些不易构造或不易获取的对象,通常就是request对象。并且可以只测试当前Controller,且不需要启动Tomcat等服务。相比于常规的调试,Mock测试更加便捷。

Mock为Spring自带,不需要额外引入依赖库。

例如:

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.RequestBuilder;
import org.springframework.test.web.servlet.ResultActions;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;

@RunWith(SpringRunner.class)
@SpringBootTest
public class HelloWorldControllerTest {
    private MockMvc mockMvc; 
    @Autowired
    private HelloWorldController helloWorldController;

    // 初始化
    @Before
    public void setUp() throws Exception {
        System.out.println("执行初始化");
        mockMvc = MockMvcBuilders.standaloneSetup(helloWorldController
).build();
    }

    // 测试
    @Test
    public void test() throws Exception {
        RequestBuilder request = MockMvcRequestBuilders.get("/HelloWorld")
                .contentType(MediaType.APPLICATION_JSON)    //发送所用的数据格式
                .accept(MediaType.APPLICATION_JSON) //接收所使用的数据格式
                .param("id","201801");  //附加参数

        // 执行请求
        ResultActions result = mockMvc.perform(request);
        // 分析结果
        result.andExpect(MockMvcResultMatchers.status().isOk()) // 执行状态
                .andExpect(MockMvcResultMatchers.jsonPath("name").value("Tesla")) // 期望值
                .andDo(MockMvcResultHandlers.print()) // 打印
                .andReturn();   // 返回
    }
}

如上,Mock的使用过程为:

1.定义MockMvc变量和Controller类变量:

private MockMvc mockMvc;
@Autowired
private HelloWorldController helloWorldController;

2.在修饰的初始化函数中,创建MockMvc对象:

@Before
public void setUp() throws Exception {
    System.out.println("执行初始化");
    mockMvc = MockMvcBuilders.standaloneSetup(helloWorldController).build();
}

创建MockMvc对象时,需要传入1中定义的Controller对象。

注意该传入的Controller对象必须使用 1中的方式以@Autowired引入,而不可以如下:

mockMvc = MockMvcBuilders.standaloneSetup(new HelloWorldController()).build();

使用上面这种方式,虽然可以得到Controller对象,且其成员函数都可以正常访问,但Controller中以@Autowired引入的各种对象却无法初始化,导致这些对象的值为null。

最典型的就是Service。Controller通常并不会承担过多的逻辑,而是将其交给Service,于是在Controller中往往会以@Autowired的形式引入Service。然而,若使用上面new的方式来创建Mock对象,会导致Controller中引入的Service对象无法注入,从而为null。执行测试,控制台会报空指针错误。

3.创建请求

RequestBuilder request = MockMvcRequestBuilders.get("/HelloWorld")
        .contentType(MediaType.APPLICATION_JSON)    //发送所用的数据格式
        .accept(MediaType.APPLICATION_JSON) //接收所使用的数据格式
        .param("id","201801");  //附加参数

调用的请求为get,同时传入接口名。

  • 可以将get换为post,或者其他请求方式。
  • contentType和accept定义了发送和接收用的数据格式,这里设置为JSON。
  • param用于附加1个参数,每多1个参数,都可以多调用一次param来附加。无论是get还是post,都可以使用param来附加参数。附加后的参数会填充到请求的parameters字段中。

4.执行请求

ResultActions result = mockMvc.perform(request);

ResultActions一共有3个接口:

public interface ResultActions {
    ResultActions andExpect(ResultMatcher var1) throws Exception;

    ResultActions andDo(ResultHandler var1) throws Exception;

    MvcResult andReturn();
}
  • andExpect():用于测试是否为期望值。
  • andDo():用于执行某个指定的操作。
  • andReturn():用于返回执行结果,为MvcResul类型。

5.分析结果

MvcResult mvcResult = result.andExpect(MockMvcResultMatchers.status().isOk()) // 执行状态
                    .andExpect(MockMvcResultMatchers.jsonPath("name").value("Tesla")) // 期望值
                    .andDo(MockMvcResultHandlers.print()) // 打印
                    .andReturn();   // 返回

可以看到分析结果使用了4中ResultActions的函数。

其中使用MockMvcResultMatchers.jsonPath()可以获取到一个JsonPathResultMatchers,可以用于判断request请求的返回值是否符合期望。
若要自行解析返回结果,则可以:

String resultStr = mvcResult.getResponse().getContentAsString();

然后将resultStr转为JSON即可。
实际测试过程中,往往是Assert.seertThath()与Mock配合使用。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

在Spring-Boot中进行单元测试 的相关文章

随机推荐

  • 用函数完成两个数相加(用两个方法实现)

    用函数完成两个数相加 1 方法一 int f1 int x int y 声明函数 定义函数 int z z x y return z include
  • JAVA 敏感词过滤

    package me mymilkbottles import org apache commons lang CharUtils import java io File import java util HashMap import ja
  • 基于vue+leaflet+echart的足迹分享评论平台

    其实题目是随便取的 目的只是用来证明Vue leaflet springboot技术栈的可行性 效果 小专栏不支持上传视频 想看的话可以去我的知乎看最新的文章 那个应该可以 在这里 主要功能描述 vue leaflet结合 足迹管理 新建
  • python编程-2.编写程序,输出所有由1,2,3,4这四个数字组成的素数,并且每个数字在素数中只出现一次。

    data用于存储在一定范围内的素数 data set for n in range 1234 4321 1 if n 2 0 continue for i in range 3 int n 0 5 1 2 if n i 0 break el
  • 组合逻辑电路——编码器

    组合逻辑电路 编码器 概念 编码的概念 在数字系统中 常需要将有特定意义的信息编成二进制代码 这一过程称为编码 编码器 实现编码的数字电路被称为编码器 二进制编码器 这里我们采用与非门来设计二进制编码器 二进制编码器输出端数量不定 可以根据
  • ACM MM 2022

    有预训练 460多m 来源丨https zhuanlan zhihu com p 547671620 Bidirectional Self Training with Multiple Anisotropic Prototypes for
  • Glide使用及原理分析

    文章目录 前言 一 Glide的基本使用 二 Glide的网络请求 1 HttpURLConnection实现一个原生图片加载框架 2 Glide为什么能监听网络变化 三 Glide的生命周期 1 Fragment的生命周期 动态加载Fra
  • 解决线程安全问题的三种方法

    解决线程安全问题的三种方法 一 使用同步代码块 如 卖票案例 出现了线程安全 重复的票不能出现 步骤 成员位置建立锁对象 synchronized 锁对象 出现安全问题代码 1 锁对象 任意对象 2 必须保证多个线程使用的是同一个锁对象 3
  • pip配置问题解决-如何使用修改windows系统环境变量

    问题发现 在使用pip安装环境的时候 出现了如下的问题 解决办法 我是在windows系统环境变量上添加上python的Scripts文件夹路径 将其放到环境变量的path中去 操作如下 右键我的电脑 点开属性 在最下面的 关于 上 找到
  • 力扣:删除链表中的节点

    237 删除链表中的节点 请编写一个函数 用于 删除单链表中某个特定节点 在设计函数时需要注意 你无法访问链表的头节点 head 只能直接访问 要被删除的节点 题目数据保证需要删除的节点 不是末尾节点 示例 1 输入 head 4 5 1
  • 区块链节点和区块区别_区块链的常识之,区块链节点,是什么?

    专业科普 区块链节点 通常指的是区块链网络中的计算机 也就是说任何连接到区块链网络的计算机 包括手机 矿机等 都称为节点 比如说比特币网络 是一个公有链 用户在自己的联网电脑上运行比特币程序时 这个电脑就成为比特币区块链网络中的一个节点 是
  • 利用栈实现简单表达式求值

    简单表达式求值 关键点 首先明确要使用的数据结构 本文采用栈来实现 为了分别操作数字和运算符 采用双栈 一个数值栈和一个运算符栈 根据栈顶运算符和待入栈运算符的优先级的判断 产生中间结果 而中间结果作为最终结果的一部分需要再次入栈 栈顶运算
  • DEDECMS单独调用指定文章

    dede arclist idlist 指定ID limit 0 1 a href field title a 描述 field description dede arclist
  • js中获取body html元素

  • myBatis实现多对多操作的sql语句

    文章目录 1 角色对人 2 人对角色 3 创建数据库语句 总结 1 角色对人 实现角色对人的多对多查询 将有角色的人筛选出来 实现角色对人的多对多查询 SELECT u r id AS rid r role name r role desc
  • Go_方法、方法重写、方法与函数的区别

    方法 方法是绑定在自定义类型上的 常用在结构体上 方法方法不能直接调用 只能通过所绑定s类型的变量来调用 因为方法是和类型做关联的 方法是值拷贝的传递方式 如果希望改变结构体变量的值 需要通过结构体指针实现 方法名首字母大写为公共 小写为私
  • Tomcat的下载及其使用

    目录 一 Tomcat是什么 二 Tomcat的下载安装 1 在搜索框搜索Tomcat 2 下载 3 Tomcat里面的一些具体内容 三 运行Tomcat 1 直接点击脚本运行 2 使用浏览器访问 3 部署页面到Tomcat 一 Tomca
  • Win10如何彻底删除360的办法

    很多用户在购买电脑或者重装系统之后都会给电脑安装360安全卫士 其实360是一款知名的流氓软件 感觉进行了彻底的删除工作 其实还残留了很多 那Win10如何彻底删除360呢 下面小编就来给大家展示一下具体的办法 2022新版Win10 64
  • SQL Part3 --- 聚合操作符

    SQL 聚合操作符 聚合操作符 Aggregate Operators COUNT A SUM A AVG A MAX A MIN A GROUP BY and HAVING 聚合操作符 Aggregate Operators Sailor
  • 在Spring-Boot中进行单元测试

    要进行单元测试 需要引入依赖