知識庫 / Spring / Spring MVC RSS 訂閱

public class JsonArgumentResolver implements HandlerMethodArgumentResolver {

    private static final String JSON_BODY_ATTRIBUTE = "JSON_REQUEST_BODY";

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(JsonArg.class);
    }

    @Override
    public Object resolveArgument(
      MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest,
      WebDataBinderFactory binderFactory) 
      throws Exception {
        String body = getRequestBody(webRequest);
        String jsonPath = Objects.requireNonNull(
          Objects.requireNonNull(parameter.getParameterAnnotation(JsonArg.class)).value());
        Class<?> parameterType = parameter.getParameterType();
        return JsonPath.parse(body).read(jsonPath, parameterType);
    }

    private String getRequestBody(NativeWebRequest webRequest) {
        HttpServletRequest servletRequest = Objects.requireNonNull(
          webRequest.getNativeRequest(HttpServletRequest.class));
        String jsonBody = (String) servletRequest.getAttribute(JSON_BODY_ATTRIBUTE);
        if (jsonBody == null) {
            try {
                jsonBody = IOUtils.toString(servletRequest.getInputStream());
                servletRequest.setAttribute(JSON_BODY_ATTRIBUTE, jsonBody);
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
        return jsonBody;
    }
}

Spring 使用 supportsParameter() 方法來檢查該類是否可以解析給定的參數。 由於我們希望我們的處理器能夠處理任何帶有 @JsonArg 註解的參數，因此如果給定的參數具有該註解，我們返回 true。

接下來，在 resolveArgument() 方法中，我們提取 JSON ，然後將其附加為請求的屬性，以便我們可以在後續調用中直接訪問它。然後我們從 @JsonArg 註解中獲取 JSON 路徑，並使用反射來獲取參數的類型。通過 JSON 路徑和參數類型信息，我們可以將 JSON 的各個部分反序列化為豐富的對象。

3.3. 註冊自定義 HandlerMethodArgumentResolver

為了讓 Spring MVC 使用我們的 JsonArgumentResolver，我們需要進行註冊：

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        JsonArgumentResolver jsonArgumentResolver = new JsonArgumentResolver();
        argumentResolvers.add(jsonArgumentResolver);
    }
}

我們的 JsonArgumentResolver 將現在處理所有帶有 @JsonArgs 註解的請求處理器參數。 我們需要確保 @JsonArgs 的值是一個有效的 JSON 路徑，但與需要為每個 JSON 結構創建單獨的 POJO 的 @RequestBody 方法相比，這是一種更輕量級的處理方式。

3.4. 使用自定義類型參數

為了證明這可以與自定義 Java 類一起使用，讓我們定義一個帶有強類型 POJO 參數的請求處理程序：

@PostMapping("/process/custompojo")
public ResponseEntity process(
  @JsonArg("firstName") String firstName, @JsonArg("lastName") String lastName,
  @JsonArg("address") AddressDto address) {
    /* business processing */
    return ResponseEntity.ok()
      .body(String.format("{\"firstName\": %s, \"lastName\": %s, \"address\" : %s}",
        firstName, lastName, address));
}

我們現在可以將 AddressDto 映射為一個單獨的參數。

3.5. 測試自定義 JsonArgumentResolver

讓我們編寫一個測試用例來證明 JsonArgumentResolver 按照預期工作：

@Test
void whenSendingAPostJSON_thenReturnFirstNameAndCity() throws Exception {

    String jsonString = "{\"firstName\":\"John\",\"lastName\":\"Smith\",\"age\":10,\"address\":{\"streetName\":\"Example Street\",\"streetNumber\":\"10A\",\"postalCode\":\"1QW34\",\"city\":\"Timisoara\",\"country\":\"Romania\"}}";
    
    mockMvc.perform(post("/user/process/custom").content(jsonString)
      .contentType(MediaType.APPLICATION_JSON)
      .accept(MediaType.APPLICATION_JSON))
      .andExpect(status().isOk())
      .andExpect(MockMvcResultMatchers.jsonPath("$.firstName").value("John"))
      .andExpect(MockMvcResultMatchers.jsonPath("$.city").value("Timisoara"));
}

接下來，我們編寫一個測試，其中我們調用第二個端點，直接將 JSON 解析為 POJO：

@Test
void whenSendingAPostJSON_thenReturnUserAndAddress() throws Exception {
    String jsonString = "{\"firstName\":\"John\",\"lastName\":\"Smith\",\"address\":{\"streetName\":\"Example Street\",\"streetNumber\":\"10A\",\"postalCode\":\"1QW34\",\"city\":\"Timisoara\",\"country\":\"Romania\"}}";
    ObjectMapper mapper = new ObjectMapper();
    UserDto user = mapper.readValue(jsonString, UserDto.class);
    AddressDto address = user.getAddress();

    String mvcResult = mockMvc.perform(post("/user/process/custompojo").content(jsonString)
      .contentType(MediaType.APPLICATION_JSON)
      .accept(MediaType.APPLICATION_JSON))
      .andExpect(status().isOk())
      .andReturn()
      .getResponse()
      .getContentAsString();

    assertEquals(String.format("{\"firstName\": %s, \"lastName\": %s, \"address\" : %s}",
      user.getFirstName(), user.getLastName(), address), mvcResult);
}

4. 結論

在本文中，我們探討了 Spring MVC 默認反序列化行為的一些侷限性，並學習瞭如何使用自定義的 `HandlerMethodArgumentResolver> 來解決這些問題。