JQuery、Spring MVC @RequestBody 和 JSON - 使其协同工作

Posted 2023-02-26

【中文标题】JQuery、Spring MVC @RequestBody 和 JSON - 使其协同工作

【英文标题】：JQuery, Spring MVC @RequestBody and JSON - making it work together

【发布时间】：2011-08-19 23:46:24

【问题描述】：

我想要一个双向 JSON 到 Java 序列化

我正在成功使用 Java 到 JSON 到 JQuery 的路径... (@ResponseBody) 例如

@RequestMapping(value="/fooBar/id", method=RequestMethod.GET)
     public @ResponseBody FooBar getFooBar(
            @PathVariable String id,
            HttpServletResponse response , ModelMap model) 
        response.setContentType("application/json");
...

在 JQuery 中我使用

$.getJSON('fooBar/1', function(data) 
    //do something
);

这工作很好（例如，注释已经工作，感谢所有回答者）

但是，如何执行 reverse 路径：是否使用 RequestBody 将 JSON 序列化为 Java 对象？

无论我尝试什么，我都无法让这样的事情发挥作用：

@RequestMapping(value="/fooBar/save", method=RequestMethod.POST)
public String saveFooBar(@RequestBody FooBar fooBar,
        HttpServletResponse response , ModelMap model) 

  //This method is never called. (it does when I remove the RequestBody...)

我已经正确配置了 Jackson（它在退出时序列化），并且我将 MVC 设置为当然驱动的注释

如何让它发挥作用？有可能吗？还是 Spring / JSON / JQuery 是单向（out）？

---

更新：

我更改了这个 Jackson 设置

<bean id="jsonHttpMessageConverter"
    class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter" />

<!-- Bind the return value of the Rest service to the ResponseBody. -->
<bean
    class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
    <property name="messageConverters">
        <util:list id="beanList">
            <ref bean="jsonHttpMessageConverter" />
<!--            <ref bean="xmlMessageConverter" /> -->              
        </util:list>
    </property>
</bean>

对（几乎类似的）建议

<bean id="jacksonMessageConverter"
    class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"></bean>
    <bean
        class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
        <property name="messageConverters">
            <list>
                <ref bean="jacksonMessageConverter" />
            </list>
        </property>
    </bean> 

而且它似乎有效！我不知道到底是什么伎俩，但它确实有效......

【问题讨论】：

我在这里更好地改写了这个问题：***.com/questions/5930894/…（我将关闭这个问题，因为它似乎太长且不清楚）

看起来它没有被调用，因为您正在执行 GET 但您的方法是 POST。

【参考方案1】：

我很确定你只需要注册MappingJacksonHttpMessageConverter

（最简单的方法is through <mvc:annotation-driven /> in XML or @EnableWebMvc in Java）

参见：

this forum post 和 7.6.5 Configuring Formatting in Spring MVC

---

这是一个工作示例：

Maven POM

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion><groupId>test</groupId><artifactId>json</artifactId><packaging>war</packaging>
    <version>0.0.1-SNAPSHOT</version><name>json test</name>
    <dependencies>
        <dependency><!-- spring mvc -->
            <groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>3.0.5.RELEASE</version>
        </dependency>
        <dependency><!-- jackson -->
            <groupId>org.codehaus.jackson</groupId><artifactId>jackson-mapper-asl</artifactId><version>1.4.2</version>
        </dependency>
    </dependencies>
    <build><plugins>
            <!-- javac --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId>
            <version>2.3.2</version><configuration><source>1.6</source><target>1.6</target></configuration></plugin>
            <!-- jetty --><plugin><groupId>org.mortbay.jetty</groupId><artifactId>jetty-maven-plugin</artifactId>
            <version>7.4.0.v20110414</version></plugin>
    </plugins></build>
</project>

---

在文件夹 src/main/webapp/WEB-INF

web.xml

<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
    version="2.4">
    <servlet><servlet-name>json</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>json</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>
</web-app>

json-servlet.xml

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
                        http://www.springframework.org/schema/beans/spring-beans.xsd">

    <import resource="classpath:mvc-context.xml" />

</beans>

---

在文件夹 src/main/resources 中：

mvc-context.xml

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd
        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">

    <mvc:annotation-driven />
    <context:component-scan base-package="test.json" />
</beans>

---

在文件夹 src/main/java/test/json

TestController.java

@Controller
@RequestMapping("/test")
public class TestController 

    @RequestMapping(method = RequestMethod.POST, value = "math")
    @ResponseBody
    public Result math(@RequestBody final Request request) 
        final Result result = new Result();
        result.setAddition(request.getLeft() + request.getRight());
        result.setSubtraction(request.getLeft() - request.getRight());
        result.setMultiplication(request.getLeft() * request.getRight());
        return result;
    

Request.java

public class Request implements Serializable 
    private static final long serialVersionUID = 1513207428686438208L;
    private int left;
    private int right;
    public int getLeft() return left;
    public void setLeft(int left) this.left = left;
    public int getRight() return right;
    public void setRight(int right) this.right = right;

Result.java

public class Result implements Serializable 
    private static final long serialVersionUID = -5054749880960511861L;
    private int addition;
    private int subtraction;
    private int multiplication;

    public int getAddition()  return addition; 
    public void setAddition(int addition)  this.addition = addition; 
    public int getSubtraction()  return subtraction; 
    public void setSubtraction(int subtraction)  this.subtraction = subtraction; 
    public int getMultiplication()  return multiplication; 
    public void setMultiplication(int multiplication)  this.multiplication = multiplication; 

您可以通过在命令行上执行mvn jetty:run，然后发送 POST 请求来测试此设置：

URL:        http://localhost:8080/test/math
mime type:  application/json
post body:   "left": 13 , "right" : 7 

我使用Poster Firefox plugin 来执行此操作。

下面是响应的样子：

"addition":20,"subtraction":6,"multiplication":91

【讨论】：

或者我想使用<mvc:annotation-driven>。

@Eran，你试过log4j，你会看到来自控制器的序列化异常或错误。

log4j 中没有例外，我快要放弃了……有没有可以开始的工作样本？ （一个简单的响应/请求正文 + JSON / JQuery 测试？）

@Eran 我知道你已经解决了你的问题，但我现在在我的答案中添加了一个工作示例

@SeanPatrickFloyd 太棒了。这真的很清楚。也就是说，当我尝试这个时，我注意到出现了一个小问题。示例中的帖子正文引用为 "left": 13 ; "right" : 7 这不是合法的 JSON。当我尝试它时，我收到了 400 个错误的请求代码。然后我注意到那里有一个分号，它不是 JSON 语法的一部分。我通过 curl 发布以下内容获得了成功 - curl -v -H "Content-Type: application/json" -X POST -d "\"left\":13,\"right\":7" http://localhost:8080/test/math

【参考方案2】：

此外，你还需要确保你有

 <context:annotation-config/> 

在您的 SPring 配置 xml 中。

我也建议您阅读这篇博文。这对我帮助很大。 Spring blog - Ajax Simplifications in Spring 3.0

更新：

刚刚检查了我的工作代码，@RequestBody 工作正常。 我的配置中也有这个 bean：

<bean id="jacksonMessageConverter" class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"></bean>
 <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
<property name="messageConverters">
  <list>
    <ref bean="jacksonMessageConverter"/>
  </list>
</property>
</bean>

也许很高兴看到Log4j 在说什么。它通常会提供更多信息，根据我的经验，如果您的请求的内容类型不是Application/JSON，@RequestBody 将失败。您可以运行 Fiddler 2 对其进行测试，甚至 Mozilla Live HTTP 标头插件也可以提供帮助。

【讨论】：

如果当然，不是问题，我确实有 ResponseBody 工作，它是 RequestBody 不起作用，我确定我错过了一些基本的东西......

log4j 中没有其他错误 :( 并且我的配置相同...是否有工作示例可以下载和调试差异？

我使用了您的配置并替换了几乎相同的配置，我真的不知道是什么小改动起到了作用，但确实如此......所以谢谢

【参考方案3】：

除了这里的答案...

如果您在客户端使用 jquery，这对我有用：

Java：

@RequestMapping(value = "/ajax/search/sync") 
public String sync(@RequestBody Foo json) 

Jquery（您需要包含 Douglas Crockford 的 json2.js 才能拥有 JSON.stringify 功能）：

$.ajax(
    type: "post",
    url: "sync", //your valid url
    contentType: "application/json", //this is required for spring 3 - ajax to work (at least for me)
    data: JSON.stringify(jsonobject), //json object or array of json objects
    success: function(result) 
        //do nothing
    ,
    error: function()
        alert('failure');
    
);

【讨论】：

这将起作用，因为您正在执行 POST 并且原始发布者使用的是 GET。

【参考方案4】：

如果您不想自己配置消息转换器，您可以使用 @EnableWebMvc or <mvc:annotation-driven />，将 Jackson 添加到类路径中，Spring 默认会为您提供 JSON、XML（和一些其他转换器）。此外，您还将获得一些其他常用的转换、格式化和验证功能。

【讨论】：

老兄，谢谢你这个绝妙的建议，非常喜欢它

【参考方案5】：

如果您愿意将 Curl 用于手头带有 JSON 2 和 Spring 3.2.0 的调用，请查看常见问题解答here。由于 AnnotationMethodHandlerAdapter 已弃用并由 RequestMappingHandlerAdapter 取代。