Spring 的 @RequestBody 在 POST 上提供空字符串

Posted 2023-02-19

【中文标题】Spring 的 @RequestBody 在 POST 上提供空字符串

【英文标题】：Spring's @RequestBody providing empty string on POST

【发布时间】：2011-08-13 23:38:20

【问题描述】：

我有一个带有 Spring 3.0.5.RELEASE 的应用程序，它试图使用 @RequestBody 获取帖子的全部内容。该方法被调用，但传递的字符串始终为空。我通过放置断点检查了是否调用了 StringHttpMessageConverter，但内部 HttpInputMessage 为空。

我在 Jetty 和 Tomcat 上都看到过这个问题，所以我放弃了这是容器的问题。

这是我的示例控制器：

@Controller
@RequestMapping("/")
public class SubscriptionController 
    @RequestMapping(value = "/requestbody", method = RequestMethod.POST)
    public ModelAndView mycustomAction(@RequestBody String body) 

        // body is always empty
        Logger.getLogger(this.getClass()).debug("REQUEST BODY '" + body + "'");
        return new ModelAndView("empty");
    

我的应用上下文定义如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans 
        http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
        http://www.springframework.org/schema/context 
        http://www.springframework.org/schema/context/spring-context-3.0.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

    <!-- Enable auto detection of controllers -->
    <context:component-scan base-package="com.big.viajerotelcel.controller" />

    <!--
        use annotation driven mvc and one single validator with JSR-303
        standard
    -->
    <mvc:annotation-driven />

    <!--
        Message source for this context, loaded from localized "messages_xx"
        files
    -->

    <bean id="messageSource"
        class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
        <property name="basenames" value="classpath:i18n/messages" />
        <property name="defaultEncoding" value="UTF-8" />
    </bean>

    <!-- Declare the Interceptor -->
    <mvc:interceptors>
        <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor"
            p:paramName="locale" />
    </mvc:interceptors>

    <!-- Declare the Resolver -->
    <bean id="localeResolver"
        class="org.springframework.web.servlet.i18n.SessionLocaleResolver" />

    <!-- will load Tiles definitions! -->
    <bean id="tilesConfigurer"
        class="org.springframework.web.servlet.view.tiles2.TilesConfigurer">
        <property name="definitions">
            <list>
                <value>/WEB-INF/general.xml</value>
            </list>
        </property>
    </bean>

    <!-- Tiles view resolver -->
    <bean id="viewResolver"
        class="org.springframework.web.servlet.view.UrlBasedViewResolver">
        <property name="viewClass"
            value="org.springframework.web.servlet.view.tiles2.TilesView" />
    </bean>

    <!-- Configure the multipart resolver -->
    <bean id="multipartResolver"
        class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <!--
            one of the properties available; the maximum file size in bytes (5MB)
        -->
        <property name="maxUploadSize" value="5120000" />
    </bean>

    <!-- Adding these lines has no effect, the StringHttpMessageConverter is called either way -->
<!--    <bean id="stringHttpMessageConverter" class="org.springframework.http.converter.StringHttpMessageConverter"/>-->
<!--           -->
<!--    <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">-->
<!--        <property name="messageConverters">-->
<!--          <list>-->
<!--            <ref bean="stringHttpMessageConverter"/>-->
<!--          </list>-->
<!--        </property>-->
<!--    </bean>-->
</beans>

我正在使用 curl 进行如下测试：

curl -d asd=123 -d qwe=456 http://localhost:8080/requestbody

欢迎任何想法或帮助！

【问题讨论】：

你有拦截器吗？也许他们对请求对象做了一些事情，以使以下对请求正文的访问变得无用？请记住，您可以使用请求阅读器或请求流，但不能同时使用两者。

如我的上下文 xml 文件中所示，我确实有一个 LocaleChangeInterceptor，但即使删除它后问题仍然存在。

【参考方案1】：

XML 可能没有编组到 JAXB 对象的另一个原因与 XML 中的命名空间有关。

1.8.101 之后的 java 版本在解析命名空间 XML 方面更加严格。 见JAXB doesn't unmarshall after updating java from 1.8.0_77 to 1.8.0_121

在我的例子中，我看到一个请求正文，其中包含所有 null 和 no 异常被抛出以表明 XML 解析失败。

【参考方案2】：

有一个类似的问题 - 弹簧控制器收到的字符串总是空的。修改了我的 spring 配置，但没有结果。最后的问题是客户端实际上没有发送任何正文！（由于我的一些错字）

如果发现有类似的错误，如果客户端的有效负载实际上是非空的，则值得检查一次。

【参考方案3】：

这是ServletServerHttpRequest的代码sn-p，它扩展了HttpInputMessage。我很肯定这是您在代码中使用的实现：

public InputStream getBody() throws IOException 
    return this.servletRequest.getInputStream();

换句话说，请求正文被读取为HttpServletRequest对象的输入流。

请求的输入流在某些情况下无效，但我目前找不到正确的文档。例如，如果您在 post 请求上调用 request.getParameter()，则 tomcat 必须读取输入流才能解释参数，因此当您读取输入流时，它是空的，因为它已经到了结尾。

也许您正在拦截器中的某处调用getParameter，或者可能是在 web.xml 中定义的过滤器。另一种选择是 Spring 正在为您执行此操作，例如，如果您的控制器具有其他具有复杂 @RequestMappings 的方法（例如读取参数值或标头值）。

我有两个建议给你：

添加一个 servlet 过滤器（在 spring 有机会采取行动之前），并用您自己的包装器包装请求（只需扩展 HttpServletRequestWrapper）。这样，您可以在请求对象的某些方法处放置断点或记录消息，并查看谁在调用它们。

使用 pojo 对象参数，并设置绑定。这似乎是一种更简洁的阅读帖子数据的方式。

【讨论】：

确实，Spring 的org.springframework.web.filter.HiddenHttpMethodFilter 是罪魁祸首。我更改了一些网址并更改了一些映射，现在它正在工作。谢谢！

我遇到了同样的问题，您的建议有所帮助。在我的 Controller 方法中，我同时使用了 @RequestBody 和 @RequestParam 注释。在我删除 @RequestParam 之前，正文是空的。有趣的是，相同的配置在 RequestMethod=PUT 而不是 POST 上也能正常工作

@filip 这很可能是因为在 POST 请求中将不同的 Content-Type 标头设置为 application/x-www-form-urlencoded。这将主体标记为请求参数的载体。

【参考方案4】：

您如何向此 URL 发布消息？您确定 HTTP 请求包含您认为的内容吗？我建议从图片中删除所有 Web 浏览器并下拉到像 curl 这样的低级别，这样您就可以自己发送任何类型的 HTTP 消息。

【讨论】：

我正在使用 curl -d asd=123 -d qwe=456 localhost:8080/requestbody 并且 Wireshark 正确显示正文不是空的。