使用Spring MVC 3.0生成/使用对称JSON

时间:2011-02-23 08:13:48

标签: java json spring spring-mvc marshalling

我正在通过Spring配置RESTful Web服务,包括各种表示,包括JSON。我希望接口是对称的,这意味着通过GET序列化为JSON的对象的格式也是POST / PUT可以接受的格式。不幸的是,我只能让GET工作。

这是我发送和接收JSON的配置,它包含一个JSON消息转换器和视图:

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

<bean id="contentNegotiatingViewResolver" class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
    <property name="mediaTypes">
        <util:map>
            <entry key="json" value="application/json"/>
        </util:map>
    </property>
    <property name="defaultViews">
        <util:list>
            <bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView"/>
        </util:list>
    </property>
</bean>

当我使用GET命中一个控制器来返回一个对象时,例如一本书,它会输出这样的东西。

{"book":{"isbn":"1234","author":"Leo Tolstoy","title":"War and Peace"}}

如果我转过身并通过POST或PUT重新提交一些类似的JSON,Spring就无法使用它,抱怨Unrecognized field "book" (Class com.mycompany.Book), not marked as ignorable。另外,如果我剥离“book”包装元素(我不想,但只是为了看看会发生什么),我得到了一个400 BAD REQUEST。在任何一种情况下,我的控制器代码都不会被命中。

这是我的控制器 - 我宁愿在这里没有任何特定于JSON的代码(或者我的类上的注释被编组/解组)因为它们将有多个表示 - 我想使用Spring的解耦MVC基础结构来推动这种类型的将(编组/视图解析/等)放入配置文件中:

@RequestMapping(method=PUT, value="/books/{isbn}")
@ResponseStatus(NO_CONTENT)
public void saveBook(@RequestBody Book book, @PathVariable String isbn) {
    book.setIsbn(isbn);
    bookService.saveBook(book)
}

@RequestMapping(method=GET, value="/books/{isbn}")
public ModelAndView getBook(@PathVariable String isbn) {
    return new ModelAndView("books/show", "book", bookService.getBook(isbn));
}

3 个答案:

答案 0 :(得分:1)

即使令人尴尬,我也会回答我自己的后代问题: - )

事实证明,我发布的这个示例方法所代表的真实代码中的等效控制器方法:

void saveBook(@RequestBody Book book, @PathVariable String isbn)

实际上看起来更像是这样(注:LongString):

void saveBook(@RequestBody Book book, @PathVariable Long isbn)

传递的值无法转换为Long(它是字母数字)。所以......我搞砸了! : - )

然而,Spring并不是很好,只是吐出400 Bad Request。我附上了一个调试器来发现这个。

使用ModelAndView仍然会生成一个外部包装元素,我将不得不以某种方式处理(因为我想使用ModelAndView来支持JSP视图等)。我可能需要为此提供自定义视图。


更新包装元素:

事实证明,它是由Spring编组表示模型的对象的Map。这张地图有一个名为“book”的键(根据我想的类名生成,因为它就在那里,即使我只是返回一本书)。这是一种愚蠢的方式,直到我找到更好的方式:

/**
 * When using a Spring Controller that is ignorant of media types, the resulting model
 * objects end up in a map as values. The MappingJacksonJsonView then converts this map
 * to JSON, which (possibly) incorrectly wraps the single model object in the map
 * entry's key. This class eliminates this wrapper element if there is only one model
 * object.
 */
public class SimpleJacksonJsonView extends MappingJacksonJsonView {

    @Override
    @SuppressWarnings("unchecked")
    protected Object filterModel(Map<String, Object> model) {
        Map<String, Object> filteredModel = (Map<String, Object>) super.filterModel(model);
        if(filteredModel.size() != 1) return filteredModel;
        return filteredModel.entrySet().iterator().next().getValue();
    }
}

答案 1 :(得分:0)

请注意,您指定在控制器方法上使用GET,因此您可以配置特定的POST方法,以便能够接收GET和POST格式的RESTFull方法,如下所示:

@RequestMapping(method=GET, value="/books/{isbn}")
public ModelAndView getBook(@PathVariable String isbn) {
    return new ModelAndView("books/show", "book", bookService.getBook(isbn));
}

@RequestMapping(method=POST, value="/books/{isbn}")
public ModelAndView getByPostBook(@PathVariable String isbn) {
    return getBook(isbn);
}

答案 2 :(得分:0)

@SingleShot,{“isbn”:“1234”,“作者”:“Leo Tolstoy”,“标题”:“战争与和平”}没有包装书是JSON中书籍实例的正确表示,由于您在GET方法中返回ModelAndView时所具有的modelName“book”,并且MappingJacksonJSONView在书籍包装器上添加了大小写,因此添加了书籍包装器。

更好的模式是简单地在Get中返回book对象并使用@ResponseBody注释方法

    @RequestMapping(method=RequestMethod.GET, value="/books/{isbn}")
public @ResponseBody Book getBook(@PathVariable String isbn) {
    return new Book("isbn","title","author");
}

关于您的PUT没有解析正确的Controller方法,您能否确认您的请求内容类型为application / json。