Spring Boot - Rest Controller Unit Test

Spring Boot Rest控制器单元测试 - 从简单和简单的步骤学习Spring Boot，从基本到高级概念，包括简介，快速入门，引导，Tomcat部署，构建系统，代码结构，Spring Bean和依赖注入，Runners，应用程序属性，日志记录，构建RESTful Web服务，异常处理，拦截器，Servlet过滤器，Tomcat端口号，休息模板，文件处理，服务组件，Thymeleaf，使用RESTful Web服务，CORS支持，国际化，调度，启用HTTPS，Eureka服务器，服务注册Eureka，Zuul代理服务器和路由，Spring云配置服务器，Spring云配置客户端，执行器，管理服务器，管理客户端，启用Swagger2，创建Docker镜像，跟踪微服务日志，Flyway数据库，发送电子邮件，Hystrix，Web套接字，批处理服务，Apache Kafka的Spring，Twilio，单元测试用例，休息控制器单元测试，数据库处理，S使用JWT，Google Cloud Platform，Google OAuth2登录，实现Web应用程序，OAuth2。

Spring Boot提供了一种为Rest Controller文件编写单元测试的简便方法.在SpringJUnit4ClassRunner和MockMvc的帮助下，我们可以创建一个Web应用程序上下文来编写Rest Controller for Rest Controller文件.

单元测试应该在 src/test/java下编写用于编写测试的目录和类路径资源应放在 src/test/resources 目录下.

对于编写单元测试，我们需要在构建配置文件中添加Spring Boot Starter Test依赖项，如下所示.

   org.springframework.boot   spring-boot-starter-test   test

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

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

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

为REST控制器编写单元测试

在本节中，让我们看看如何为REST控制器编写单元测试.

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

package com. it1352.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)@WebAppConfigurationpublic 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 mapFromJson(String json, Class clazz)      throws JsonParseException, JsonMappingException, IOException {            ObjectMapper objectMapper = new ObjectMapper();      return objectMapper.readValue(json, clazz);   }}

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

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

@Testpublic 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用于创建产品.

@Testpublic 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用于更新现有产品.

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

下面给出了删除API测试用例的代码.此API将删除现有产品.

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

完整的Controller Test类文件在下面和下面给出;

package com.it1352.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.it1352.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

现在，您可以在控制台窗口中看到测试结果.

控制台窗口中的测试结果

对于Gradle，您可以使用如下所示的命令 :

gradle clean build

您可以在控制台窗口中看到其余结果，如下所示.

在控制台窗口中休息结果