如何在Spring Rest控制器中动态设置响应内容类型？

Question

我实现了一个API，它将根据客户的请求返回JSON和XML(即接受请求中的头)。它像预期的那样工作。

这里的问题是：即使用户发送接受标头，在一些特殊情况下（即业务逻辑），我们也需要动态发送响应内容类型。我试图使用HttpHeaders实现它，但它不起作用。

@GetMapping
public ResponseEntity<Response> getQueries(){
...............

    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_JSON);
    //headers.add("Content-Type", "application/json");  
    return new ResponseEntity<Response>(response, headers, HttpStatus.OK);
}

我将HTTP状态设置为200，但响应为错误，即，

Unexpected '<'

如何解决这个问题？

Answer 1

你的问题是关于内容协商，这是一种允许消费者(你的用户代理)和提供者(你的控制器)从一开始就同意响应的媒体类型的能力

首先，由APi消费者来指示它将接受哪种媒体类型的响应。这是通过将接受标头设置为所需的类型来完成的。因此，在消费者期望响应类型为JSON的情况下，应该为XML（或每种类型的任何特定变体，例如“应用程序/xhtml xml”等）配置接受标头。

在控制器端，您需要使用“产生”注释属性指定支持的响应媒体类型。还有一个兄弟“消费”属性指定支持的请求媒体类型。所以...我们的映射应该如下所示：

@GetMapping(value="someEndpoint",
        produces={"application/json","application/xml"})
public ResponseEntity<Page<Person>> getPersons(
        @RequestParam(value = "page", required = true) Integer pPage,
        @RequestParam(value = "size", required = true) Integer pSize) 
{
    Page<Person>  result;
    result = personService.getPersons(new PageRequest(pPage, pSize));
    return new ResponseEntity<>(result, HttpStatus.OK);
}

现在有趣的是，您不必为响应格式而烦恼，因为Spring将能够根据超文本传输协议请求接受标头的值检测消费者所需的响应媒体类型。

更好的是，使用正确的配置，您可以在请求中没有接受标头的情况下设置默认响应mediaType。因此，通过将默认响应内容类型设置为“Application/json”，任何没有接受标头的请求都将在JSON中得到服务，而消费者必须添加一个Accep：“Application/xml”才能将响应类型设置为xml。

有关此主题和配置设置的示例和变体，请参阅本Spring指南。

希望这有帮助，

杰克