Spring Boot Rest控制器单元测试过程解析

更新时间：2020年03月06日 10:27:08 作者：borter

这篇文章主要介绍了Spring Boot Rest控制器单元测试过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

Spring Boot提供了一种为Rest Controller文件编写单元测试的简便方法。在SpringJUnit4ClassRunner和MockMvc的帮助下，可以创建一个Web应用程序上下文来为Rest Controller文件编写单元测试。
单元测试应该写在src/test/java目录下，用于编写测试的类路径资源应该放在src/test/resources目录下。
对于编写单元测试，需要在构建配置文件中添加Spring Boot Starter Test依赖项，如下所示。

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

XML

Gradle用户可以在build.gradle 文件中添加以下依赖项。

testCompile(‘org.springframework.boot:spring-boot-starter-test‘)

在编写测试用例之前，应该先构建RESTful Web服务。有关构建RESTful Web服务的更多信息，请参阅本教程中给出的相同章节。

编写REST控制器的单元测试

在本节中，看看如何为REST控制器编写单元测试。

首先，需要创建用于通过使用MockMvc创建Web应用程序上下文的Abstract类文件，并定义mapToJson()和mapFromJson()方法以将Java对象转换为JSON字符串并将JSON字符串转换为Java对象。

package com.yiibai.demo;

import java.io.IOException;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = DemoApplication.class)
@WebAppConfiguration
public abstract class AbstractTest {
 protected MockMvc mvc;
 @Autowired
 WebApplicationContext webApplicationContext;

 protected void setUp() {
  mvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
 }
 protected String mapToJson(Object obj) throws JsonProcessingException {
  ObjectMapper objectMapper = new ObjectMapper();
  return objectMapper.writeValueAsString(obj);
 }
 protected <T> T mapFromJson(String json, Class<T> clazz)
  throws JsonParseException, JsonMappingException, IOException {

  ObjectMapper objectMapper = new ObjectMapper();
  return objectMapper.readValue(json, clazz);
 }
}

接下来，编写一个扩展AbstractTest类的类文件，并为每个方法(如GET，POST，PUT和DELETE)编写单元测试。

下面给出了GET API测试用例的代码。此API用于查看产品列表。

@Test
public void getProductsList() throws Exception {
 String uri = "/products";
 MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.get(uri)
  .accept(MediaType.APPLICATION_JSON_VALUE)).andReturn();

 int status = mvcResult.getResponse().getStatus();
 assertEquals(200, status);
 String content = mvcResult.getResponse().getContentAsString();
 Product[] productlist = super.mapFromJson(content, Product[].class);
 assertTrue(productlist.length > 0);
}

POST API测试用例的代码如下。此API用于创建产品。

@Test
public void createProduct() throws Exception {
 String uri = "/products";
 Product product = new Product();
 product.setId("3");
 product.setName("Ginger");

 String inputJson = super.mapToJson(product);
 MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.post(uri)
  .contentType(MediaType.APPLICATION_JSON_VALUE).content(inputJson)).andReturn();

 int status = mvcResult.getResponse().getStatus();
 assertEquals(201, status);
 String content = mvcResult.getResponse().getContentAsString();
 assertEquals(content, "Product is created successfully");
}

下面给出了PUT API测试用例的代码。此API用于更新现有产品。

@Test
public void updateProduct() throws Exception {
 String uri = "/products/2";
 Product product = new Product();
 product.setName("Lemon");

 String inputJson = super.mapToJson(product);
 MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.put(uri)
  .contentType(MediaType.APPLICATION_JSON_VALUE).content(inputJson)).andReturn();

 int status = mvcResult.getResponse().getStatus();
 assertEquals(200, status);
 String content = mvcResult.getResponse().getContentAsString();
 assertEquals(content, "Product is updated successsfully");
}

Delete API测试用例的代码如下。此API将删除现有产品。

@Test
public void deleteProduct() throws Exception {
 String uri = "/products/2";
 MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.delete(uri)).andReturn();
 int status = mvcResult.getResponse().getStatus();
 assertEquals(200, status);
 String content = mvcResult.getResponse().getContentAsString();
 assertEquals(content, "Product is deleted successsfully");
}

完整的控制器测试类文件代码如下 -

package com.yiibai.demo;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

import org.junit.Before;
import org.junit.Test;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;

import com.yiibai.demo.model.Product;

public class ProductServiceControllerTest extends AbstractTest {
 @Override
 @Before
 public void setUp() {
  super.setUp();
 }
 @Test
 public void getProductsList() throws Exception {
  String uri = "/products";
  MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.get(uri)
   .accept(MediaType.APPLICATION_JSON_VALUE)).andReturn();

  int status = mvcResult.getResponse().getStatus();
  assertEquals(200, status);
  String content = mvcResult.getResponse().getContentAsString();
  Product[] productlist = super.mapFromJson(content, Product[].class);
  assertTrue(productlist.length > 0);
 }
 @Test
 public void createProduct() throws Exception {
  String uri = "/products";
  Product product = new Product();
  product.setId("3");
  product.setName("Ginger");
  String inputJson = super.mapToJson(product);
  MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.post(uri)
   .contentType(MediaType.APPLICATION_JSON_VALUE)
   .content(inputJson)).andReturn();

  int status = mvcResult.getResponse().getStatus();
  assertEquals(201, status);
  String content = mvcResult.getResponse().getContentAsString();
  assertEquals(content, "Product is created successfully");
 }
 @Test
 public void updateProduct() throws Exception {
  String uri = "/products/2";
  Product product = new Product();
  product.setName("Lemon");
  String inputJson = super.mapToJson(product);
  MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.put(uri)
   .contentType(MediaType.APPLICATION_JSON_VALUE)
   .content(inputJson)).andReturn();

  int status = mvcResult.getResponse().getStatus();
  assertEquals(200, status);
  String content = mvcResult.getResponse().getContentAsString();
  assertEquals(content, "Product is updated successsfully");
 }
 @Test
 public void deleteProduct() throws Exception {
  String uri = "/products/2";
  MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.delete(uri)).andReturn();
  int status = mvcResult.getResponse().getStatus();
  assertEquals(200, status);
  String content = mvcResult.getResponse().getContentAsString();
  assertEquals(content, "Product is deleted successsfully");
 }
}

创建一个可执行的JAR文件，并使用下面给出的Maven或Gradle命令运行Spring Boot应用程序 -

对于Maven，可以使用下面给出的命令

mvn clean install

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

@Configuration与@Component作为配置类的区别详解
这篇文章主要介绍了@Configuration与@Component作为配置类的区别详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-06-06
Spring Security登录表单配置示例详解
这篇文章主要介绍了Spring Security登录表单配置,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-06-06
Java基于Tcp协议的socket编程实例
这篇文章主要介绍了Java基于Tcp协议的socket编程实例,较为详细的分析了socket编程客户端与服务器端的具体实现步骤与使用技巧,具有一定的参考借鉴价值,需要的朋友可以参考下
2014-12-12
MyBatis集成Spring流程详解
在实际开发中不仅仅是要展示数据，还要构成数据模型添加数据，这篇文章主要介绍了SpringBoot集成Mybatis操作数据库，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-08-08
关于Spring Boot获取bean的3种方式
这篇文章主要介绍了关于Spring Boot获取bean的3种方式,在spring中ApplicationContext这个上下文对象是获取bean的基础,需要的朋友可以参考下
2023-04-04
Java线程中synchronized和volatile关键字的区别详解
这篇文章主要介绍了Java线程中synchronized和volatile关键字的区别详解,synchronzied既能够保障可见性,又能保证原子性,而volatile只能保证可见性,无法保证原子性,volatile不需要加锁,比synchronized更轻量级,不会阻塞线程,需要的朋友可以参考下
2024-01-01
Springboot mybatis plus druid多数据源解决方案 dynamic-datasource的使用详
这篇文章主要介绍了Springboot mybatis plus druid多数据源解决方案 dynamic-datasource的使用,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-11-11
Java和C的随机数(Random)详解
本篇文章主要介绍了Java和C随机数(Random)，现在分享给大家，也给大家做个参考，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
2021-09-09
Java数据结构及算法实例：冒泡排序 Bubble Sort
这篇文章主要介绍了Java数据结构及算法实例：冒泡排序 Bubble Sort,本文直接给出实现代码,代码中包含详细注释,需要的朋友可以参考下
2015-06-06
java 算法 6种排序小结
这篇文章主要介绍了java 算法 6种排序,排序原理及实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-10-10

Spring Boot Rest控制器单元测试过程解析

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具