如何使用 mockMvc 检查响应正文中的 JSON

Posted 2023-02-25

【中文标题】如何使用 mockMvc 检查响应正文中的 JSON

【英文标题】：How to check JSON in response body with mockMvc

【发布时间】：2015-08-09 13:36:11

【问题描述】：

这是我在控制器中的方法，由 @Controller 注释

@RequestMapping(value = "/getServerAlertFilters/serverName/", produces = "application/json; charset=utf-8")
    @ResponseBody
    public JSONObject getServerAlertFilters(@PathVariable String serverName) 
        JSONObject json = new JSONObject();
        List<FilterVO> filteredAlerts = alertFilterService.getAlertFilters(serverName, "");
        JSONArray jsonArray = new JSONArray();
        jsonArray.addAll(filteredAlerts);
        json.put(SelfServiceConstants.DATA, jsonArray);
        return json;
    

我期待 "data":["useRegEx":"false","hosts":"v2v2v2"] 作为我的 json。

这是我的 JUnit 测试：

@Test
    public final void testAlertFilterView()        
        try            
            MvcResult result = this.mockMvc.perform(get("/getServerAlertFilters/v2v2v2/").session(session)
                    .accept("application/json"))
                    .andDo(print()).andReturn();
            String content = result.getResponse().getContentAsString();
            LOG.info(content);
         catch (Exception e) 
            e.printStackTrace();
        
    

这是控制台输出：

MockHttpServletResponse:
              Status = 406
       Error message = null
             Headers = 
        Content type = null
                Body = 
       Forwarded URL = null
      Redirected URL = null
             Cookies = []

即使result.getResponse().getContentAsString() 也是一个空字符串。

有人可以建议如何在我的 JUnit 测试方法中获取我的 JSON，以便我可以完成我的测试用例。

【问题讨论】：

请注意，您收到了一个http错误代码406（不可接受的请求错误），这就是您的正文为空的原因

【参考方案1】：

您可以尝试以下获取和发布方法

@Autowired
private MuffinRepository muffinRepository;

@Test
public void testGetMethod throws Exception()
    Muffin muffin = new Muffin("Butterscotch");
    muffin.setId(1L);
    
    BddMockito.given(muffinRepository.findOne(1L)).
        willReturn(muffin);
        
    mockMvc.perform(MockMvcRequestBuilders.
        get("/muffins/1")).
        andExpect(MockMvcResutMatchers.status().isOk()).
        andExpect(MockMvcResutMatchers.content().string("\"id\":1, "flavor":"Butterscotch""));    


//Test to do post operation
@Test
public void testPostMethod throws Exception()
    Muffin muffin = new Muffin("Butterscotch");
    muffin.setId(1L);
    
    BddMockito.given(muffinRepository.findOne(1L)).
        willReturn(muffin);
        
    mockMvc.perform(MockMvcRequestBuilders.
        post("/muffins")
        .content(convertObjectToJsonString(muffin))
        .contentType(MediaType.APPLICATION_JSON)
        .accept(MediaType.APPLICATION_JSON))
        .andExpect(MockMvcResutMatchers.status().isCreated())
        .andExpect(MockMvcResutMatchers.content().json(convertObjectToJsonString(muffin))); 

如果响应为空，请确保覆盖您的存储库正在使用的 Entity 上的 equals() 和 hashCode() 方法：

//Converts Object to Json String
private String convertObjectToJsonString(Muffin muffin) throws JsonProcessingException
    ObjectWriter writer = new ObjectWriter().writer().withDefaultPrettyPrinter();
    return writer.writeValueAsString(muffin);

【参考方案2】：

有两种方法可以检查 JSON 响应。 Lemme 指导您完成这两个，（从上面的问题中获取测试方法，并假设响应"data":["useRegEx":"false","hosts":"v2v2v2"] 如上所述）

方法 1) 断言完整的 JSON

@Test
public final void testAlertFilterView()        
    mockMvc.perform(get("/getServerAlertFilters/v2v2v2/")
           .contentType("application/json"))
           .andExpect(status().isOk())
           // you may even read bigger json responses from file and convert it to string, instead of simply hardcoding it in test class
           .andExpect(content().json(""data":["useRegEx":"false","hosts":"v2v2v2"]"))     

方法2）断言响应的特定键值（不编写冗余代码）

.andExpect(jsonPath("$.data[0].useRegEx").value(false))
.andExpect(jsonPath("$.data[0].hosts").value("v2v2v2"));

您可能需要的另一件事是 import 语句，

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

【参考方案3】：

如果要检查 JSON 的特定字段中的一些值

.andExpect(MockMvcResultMatchers.jsonPath("$.message",
    AllOf.allOf(
        StringContains.containsString("name: must not be null"),
        StringContains.containsString("type: must not be null")
    )));

它在测试类中的外观。 JUnit4。

import com.fasterxml.jackson.databind.ObjectMapper;
import org.hamcrest.core.AllOf;
import org.hamcrest.core.StringContains;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
import org.mockito.junit.MockitoJUnitRunner;
import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;

@RunWith(MockitoJUnitRunner.class)
public class YourControllerTest 

  @Mock
  private YourService service;

  private MockMvc mvc;

  @Before
  public void setUp() 
    MockitoAnnotations.initMocks(this);
    mvc = MockMvcBuilders
        .standaloneSetup(new YourController(service))
        .setControllerAdvice(new YourExceptionHandler())
        .setCustomArgumentResolvers(new PageableHandlerMethodArgumentResolver())
        .build();
  

  @Test
  public void yourControllerMethodName_400_validation() throws Exception 
    String path = "/orders/orderId/items";
    Integer orderId = 123;

    YourRequestDto requestDto = YourTestFactory.buildYourRequestDto();
    requestDto.setName(null);
    requestDto.setType(null);

    YourResponseDto expected = YourTestFactory.buildYourResponseDto(requestDto);

    Mockito
        .when(service.someMethod(orderId, requestDto))
        .thenReturn(expected);

    mvc
        .perform(
            MockMvcRequestBuilders.post(path, orderId)
                .contentType(MediaType.APPLICATION_JSON)
                .content(new ObjectMapper().writeValueAsString(requestDto))
        )
        .andExpect(MockMvcResultMatchers.status().isBadRequest())
        .andExpect(MockMvcResultMatchers.jsonPath("$.message",
            AllOf.allOf(
                StringContains.containsString("name: must not be null"),
                StringContains.containsString("type: must not be null")
            )));
  

【参考方案4】：

我使用 TestNG 进行单元测试。但是在 Spring Test Framework 中，它们看起来都很相似。所以我相信你的测试如下所示

@Test
public void testAlertFilterView() throws Exception 
    this.mockMvc.perform(get("/getServerAlertFilters/v2v2v2/").
            .andExpect(status().isOk())
            .andExpect(content().json("'data':['useRegEx':'false','hosts':'v2v2v2']"));
    

如果你想检查检查 json 键和值，你可以使用 jsonpath .andExpect(jsonPath("$.yourKeyValue", is("WhatYouExpect")));

您可能会发现content().json() 无法解决请添加

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

【讨论】：

我在尝试解决方案时收到NoClassDefFoundError: org/skyscreamer/jsonassert/JSONAssert（用于spring的JsonExpectationsHelper）

它可能由于不同的原因而发生。 ***.com/a/5756989/2940265

@user7294900 可能您应该将jsonassert 库添加到您的运行时依赖项中。例如来自here。

【参考方案5】：

406 Not Acceptable 状态码表示 Spring 无法将对象转换为 json。您可以让您的控制器方法返回一个字符串并执行return json.toString(); 或配置您自己的HandlerMethodReturnValueHandler。检查这个类似的问题Returning JsonObject using @ResponseBody in SpringMVC