Spring的rest控制器同时支持application/json和application/x-www-form-urlencoded

Question

我正在编写一个RESTendpoint，它需要同时支持application/x-www-form-urlencoded和application/json作为请求体。我做了以下配置，

@RequestMapping(method = RequestMethod.POST, produces = { MediaType.APPLICATION_JSON_VALUE }, consumes = {          
        MediaType.APPLICATION_FORM_URLENCODED_VALUE, MediaType.APPLICATION_JSON_VALUE }, path = Constants.ACCESS_TOKEN_V1_ENDPOINT)
public OAuth2Authorization createAccessTokenPost(
        @RequestBody(required = false) MultiValueMap<String, String> paramMap) { ..

虽然它单独支持application/x-www-form-urlencoded或application/json（当我从consumes={}中注释掉一种内容类型时），但它不同时支持这两种类型。有什么想法吗？

Answer 1

根据我的发现，spring不同时支持内容类型“application/x-www-form-urlencoded”、“application/json”和“application/xml”。

我认为原因是：Spring通过解析JSON和XML类型并将它们注入到标记有@requestbodySpring注释的java pojo中来处理它们。但是，x-www-form-urlencoded必须注入到标记为@requestbody的multivaluemap<>对象中。不会同时支持用@requestbody标记的两个不同的java类型，因为spring可能不知道在哪里注入有效负载。

一个可行的解决方案：

API中可以支持“application/x-www-form-urlencoded”。也就是说，它可以使用@RequestBody注释注入到Spring的MultiValueMap<>中。

为了在相同的方法上支持JSON和XML，我们可以利用servlet规范和Spring的类来提取有效负载作为流。

示例代码：

import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.util.MultiValueMap;

// usual REST service class

@Autowired
private MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter;

@Autowired
private Jaxb2RootElementHttpMessageConverter jaxb2RootElementHttpMessageConverter;

public ResponseEntity<Object> authorizationRequestPost(HttpServletResponse response, HttpServletRequest request,@RequestBody(required = false) MultiValueMap<String, String> parameters) {

    // this MultiValueMap<String,String> will contain key value pairs of "application/x-www-form-urlencoded" parameters.

    // payload object to be populated
    Authorization authorization = null;

    HttpInputMessage inputMessage = new ServletServerHttpRequest(request) {
                    @Override
                    html" target="_blank">public InputStream getBody() throws IOException {
                        return request.getInputStream();
                    }
                };

    if (request.getContentType().equals(MediaType.APPLICATION_JSON_VALUE)) {
        authorization = (Authorization) mappingJackson2HttpMessageConverter.read(Authorization.class, inputMessage);
    } 
    else if (request.getContentType().equals(MediaType.APPLICATION_XML_VALUE)) {
        authorization = (Authorization)jaxb2RootElementHttpMessageConverter.read(Authorization.class, inputMessage);
    }
    else{
        // extract values from MultiValueMap<String,String> and populate Authorization
    }

// remaining method instructions
}

请注意，使用这种方法可以支持任何自定义数据类型/标记/格式。Spring的org.springframework.http.converter.HttpMessageConverter<>可以扩展以编写解析逻辑。

另一种可能的方法是AOP风格的解决方案，它将执行相同的逻辑：通过从HttpServlet输入流中提取有效负载并注入有效负载对象来解析有效负载。

第三种方法是编写执行逻辑的过滤器。