@RequestBody注释是如何工作的以及它与HttpMessageConverter接口的关系?

时间:2015-04-08 14:30:20

标签: java spring spring-mvc java-ee annotations

我正在研究Spring如何处理 REST Web服务,我对 HttpMessageConverter 的概念有些怀疑。

在我可以阅读的官方文件中:

  

策略接口,指定可以转换的转换器   以及HTTP请求和响应。

所以 HttpMessageConverter 似乎是一个界面,但究竟什么是策略界面?是否与策略模式相关?

因此,根据我的理解,当使用 @EnableWebMvc

时,Spring会自动提供默认注册的一些实现

但这些实施到底是什么?你能给我一个实际的例子吗?

我认为它以这种方式起作用:

例如客户端执行HttpRequest在此请求的主体中放入 JSON 消息(我不太实际,但我认为我可以做这样的事情),然后处理的控制器此HttpRequst使用 HttpMessageConverter 的实现将此JSON消息转换为模型对象。我认为这也是事实,反之亦然。

我的推理是正确的还是我错过了什么?

另一个疑问与 @RequestBody 注释有关(我认为它与前一主题相关)。

我有这个例子:

@RequestMapping(value="/orders/{id}", method=RequestMethod.PUT)
@ResponseStatus(HttpStatus.NO_CONTENT) // 204
public void updateOrder(@RequestBody Order updatedOrder, @PathVariable("id") long id) {
    // process updated order data and return empty response
    orderManager.updateOrder(id, updatedOrder);
}

所以我认为 @RequestBody Order updatedOrder 从HttpRequest的主体中获取 updatedOrder 输入参数的值,然后将其转换为命令使用 HttpMessageConverter 的实现的对象。

是对还是我错过了什么?如果是对的,怎么选择合适的转换器呢?

例如,我在这里找到了另一个与上一个类似的例子:http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html

@Controller
@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")
public void addPet(@RequestBody Pet pet, Model model) {
    // implementation omitted
}

我认为在这里明确指出它必须使用JSON到MODEL OBJECT转换器。为什么在前面的例子中没有指定?如何选择合适的转换器?

TNX

1 个答案:

答案 0 :(得分:11)

Handler方法参数由Spring HandlerMethodArgumentResolver生成,处理程序方法返回值由Spring HandlerMethodReturnValueHandler处理。处理@ResponseBody@RequestBody的实施是RequestResponseBodyMethodProcessor

其中一个默认情况下(@EnableWebMvc配置)注册了HttpMessageConverter个实例的默认列表。这是在WebMvcConfigurationSupport#addDefaultHttpMessageConverters(List)中完成的。您可以找到源代码并查看添加的源代码和顺序。

当Spring为@RequestBody参数生成参数时,它会循环遍历HttpMessageConverter个实例,检查该实例HttpMessageConverter#canRead是否在请求中给出了内容类型,并且可以生成参数类型的实例。如果可以,Spring将使用HttpMessageConverter来产生一个参数。如果它不能,Spring将跳过它并尝试下一个实例,直到它用完为止。此时,它将抛出异常。

对于@ResponseBody,过程是相同的,除了Spring现在使用HttpMessageConverter#canWrite。它将检查HttpMessageConverter是否可以序列化返回类型并生成适合响应中预期的内容类型的响应内容(在Accept请求标头中给出)。

consumes

@RequestParam属性
@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")

与上面宣布的策略无关。 consumes在这里做的唯一事情就是限制处理程序的映射。例如,拿这两个处理程序

@RequestMapping(value = "/pets", method = RequestMethod.POST)

@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")

第一个可以使用任何内容类型处理对/pets的任何请求。第二个只能使用内容类型/pets处理application/json的请求。