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

Question

我正在通过 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 无法使用它，并抱怨无法识别的字段“book”（类 com.mycompany.Book），未标记为可忽略。此外，如果我去掉“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));
}

Answer 1

尽管这很尴尬，但我正在为后代回答我自己的问题:-)

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

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

实际上看起来更像这样（注意：Long 副 String)：

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();
    }
}

Answer 2

请注意，您指定在控制器方法上使用 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);
}

Answer 3

@SingleShot，没有包装书的 {"isbn":"1234","author":"Leo Tolstoy","title":"War and Peace"} 是 JSON 中书籍实例的正确表示，书籍包装器是添加是因为当您在 GET 方法中返回 ModelAndView 时您拥有 modelName“book”，并且 MappingJacksonJSONView 附加在 book 包装器上。

更好的模式是简单地在 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。