使用Spring MVC 3.0生产/使用对称JSON
问题内容:
我正在通过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)时,它会输出类似的内容。
{"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错误的请求。无论哪种情况,都不会命中我的控制器代码。
这是我的控制器-我宁愿这里没有任何特定于JSON的代码(或将对我的类的注解进行编组/解组),因为它们将具有多种表示形式-
我想使用Spring的解耦MVC基础结构来推动这种事情(编组) / view解析/等)到配置文件中:
@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));
}
问题答案:
即使令人尴尬,我还是回答自己的后代问题:-)
事实证明,我发布的此示例方法所代表的真实代码中的等效控制器方法为:
void saveBook(@RequestBody Book book, @PathVariable String isbn)
实际上看起来更像这样(注意:Long
Vice String
):
void saveBook(@RequestBody Book book, @PathVariable Long isbn)
并且传递的值不能转换为Long(字母数字)。所以…我搞砸了!:-)
但是,Spring对此不是很好,只是吐出来了400 Bad Request
。我附加了调试器来发现这一点。
使用ModelAndView仍会生成一个外部包装器元素,我将不得不以某种方式处理它(因为我想使用ModelAndView来支持JSP视图等)。我可能必须为此提供一个自定义视图。
包装元素的更新:
事实证明,它是由Spring编组代表模型的对象的Map创建的。该映射具有一个名为“
book”的键(从我认为的类名生成,因为即使我只是返回一本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();
}
}