无涯教程-Spring Boot - Rest单元测试 Spring Boot提供了一种简单的方法来编写Rest Con

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>

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

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

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

编写单元测试

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

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

package com.learnfk.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 {
  </span><span class="typ">ObjectMapper</span><span class="pln"> objectMapper</span><span class="pun">=</span><span class="kwd">new</span><span class="pln"> </span><span class="typ">ObjectMapper</span><span class="pun">();</span><span class="pln">
  </span><span class="kwd">return</span><span class="pln"> objectMapper</span><span class="pun">.</span><span class="pln">readValue</span><span class="pun">(</span><span class="pln">json</span><span class="pun">,</span><span class="pln"> clazz</span><span class="pun">);</span><span class="pln">

}
}

接下来，编写一个扩展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");
}

下面给出了删除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");
}

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

package com.learnfk.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.learnfk.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();
  </span><span class="kwd">int</span><span class="pln"> status</span><span class="pun">=</span><span class="pln">mvcResult</span><span class="pun">.</span><span class="pln">getResponse</span><span class="pun">().</span><span class="pln">getStatus</span><span class="pun">();</span><span class="pln">
  assertEquals</span><span class="pun">(</span><span class="lit">200</span><span class="pun">,</span><span class="pln"> status</span><span class="pun">);</span><span class="pln">
  </span><span class="typ">String</span><span class="pln"> content</span><span class="pun">=</span><span class="pln">mvcResult</span><span class="pun">.</span><span class="pln">getResponse</span><span class="pun">().</span><span class="pln">getContentAsString</span><span class="pun">();</span><span class="pln">
  </span><span class="typ">Product</span><span class="pun">[]</span><span class="pln"> productlist</span><span class="pun">=</span><span class="kwd">super</span><span class="pun">.</span><span class="pln">mapFromJson</span><span class="pun">(</span><span class="pln">content</span><span class="pun">,</span><span class="pln"> </span><span class="typ">Product</span><span class="pun">[].</span><span class="kwd">class</span><span class="pun">);</span><span class="pln">
  assertTrue</span><span class="pun">(</span><span class="pln">productlist</span><span class="pun">.</span><span class="pln">length </span><span class="pun">&gt;</span><span class="pln"> </span><span class="lit">0</span><span class="pun">);</span><span class="pln">

}
@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();
  </span><span class="kwd">int</span><span class="pln"> status</span><span class="pun">=</span><span class="pln">mvcResult</span><span class="pun">.</span><span class="pln">getResponse</span><span class="pun">().</span><span class="pln">getStatus</span><span class="pun">();</span><span class="pln">
  assertEquals</span><span class="pun">(</span><span class="lit">201</span><span class="pun">,</span><span class="pln"> status</span><span class="pun">);</span><span class="pln">
  </span><span class="typ">String</span><span class="pln"> content</span><span class="pun">=</span><span class="pln">mvcResult</span><span class="pun">.</span><span class="pln">getResponse</span><span class="pun">().</span><span class="pln">getContentAsString</span><span class="pun">();</span><span class="pln">
  assertEquals</span><span class="pun">(</span><span class="pln">content</span><span class="pun">,</span><span class="pln"> </span><span class="str">"Product is created successfully"</span><span class="pun">);</span><span class="pln">

}
@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();
  </span><span class="kwd">int</span><span class="pln"> status</span><span class="pun">=</span><span class="pln">mvcResult</span><span class="pun">.</span><span class="pln">getResponse</span><span class="pun">().</span><span class="pln">getStatus</span><span class="pun">();</span><span class="pln">
  assertEquals</span><span class="pun">(</span><span class="lit">200</span><span class="pun">,</span><span class="pln"> status</span><span class="pun">);</span><span class="pln">
  </span><span class="typ">String</span><span class="pln"> content</span><span class="pun">=</span><span class="pln">mvcResult</span><span class="pun">.</span><span class="pln">getResponse</span><span class="pun">().</span><span class="pln">getContentAsString</span><span class="pun">();</span><span class="pln">
  assertEquals</span><span class="pun">(</span><span class="pln">content</span><span class="pun">,</span><span class="pln"> </span><span class="str">"Product is updated successsfully"</span><span class="pun">);</span><span class="pln">

}
@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

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

无涯教程-Spring Boot - Rest单元测试

编写单元测试

参考链接