How to correctly receive string parameters in non-JSON format using @RequestBody annotation in SpringBoot?

@RequestBody annotation in Spring Boot receives non-JSON string parameters

In Spring Boot applications, the @RequestBody annotation is usually used to process request body data in JSON format. However, some additional configuration is required when it is necessary to handle string parameters in non-JSON format. This article will explore how to correctly receive non-JSON string parameters using @RequestBody and resolve possible JSON parsing errors.

Problem description

A Spring Boot controller interface uses @RequestBody to receive string parameters:

 @ResponseBody
@PostMapping("/sendnews")
public String sendContent(HttpServletRequest request, @RequestBody String lstMsgId) {
    System.out.println(lstMsgId);
    return lstMsgId;
}

Sending a request using Postman (the request body is set to raw, the content is "90c8c36f23a94c1487851129aa47d690/90c8c36f23a94c1487851129aa47d690" ) can work properly. But when sending the same request using the Hutool library:

 HttpRequest request = HttpRequest.post(url);
request.header("gatewayAuth", "xxxx");
String responseJsonStr = request.form(null)
        .body("90c8c36f23a94c1487851129aa47d690/90c8c36f23a94c1487851129aa47d690")
        .timeout(50000)
        .execute().body();

org.springframework.http.converter.HttpMessageNotReadableException is thrown, prompting a JSON parsing error.

Cause analysis

Postman by default encloses the requested string with double quotes, which conforms to the JSON string format. After Spring is received, it is processed using the JSON parser. The Hutool library's request lacks the necessary HTTP header information, which causes Spring to mistakenly process the request body as JSON, resulting in parsing failure.

Solution

In order for @RequestBody to correctly handle non-JSON strings, it is necessary to explicitly inform the Spring request body type. This can be achieved by setting Content-Type request header to text/plain .

Modify the Hutool request code:

 HttpRequest request = HttpRequest.post(url);
request.header("Content-Type", "text/plain");
request.header("gatewayAuth", "xxxx");
String responseJsonStr = request.body("90c8c36f23a94c1487851129aa47d690/90c8c36f23a94c1487851129aa47d690")
        .timeout(50000)
        .execute().body();

By setting Content-Type to text/plain , Spring will correctly parse non-JSON string parameters in the request body.

The above is the detailed content of How to correctly receive string parameters in non-JSON format using @RequestBody annotation in SpringBoot?. For more information, please follow other related articles on the PHP Chinese website!