在 Spring MVC 中，如何在使用 @ResponseBody 时设置 mime 类型标头

Question

我有一个返回 JSON 字符串的 Spring MVC 控制器，我想将 mimetype 设置为 application/json。我该怎么做？

@RequestMapping(method=RequestMethod.GET, value="foo/bar")
@ResponseBody
public String fooBar(){
    return myService.getJson();
}

业务对象已作为 JSON 字符串提供，因此使用 MappingJacksonJsonView 不是我的解决方案。 @ResponseBody 很完美，但是如何设置 mimetype 呢？

Answer 1

我的现实版本。加载 HTML 文件并流式传输到浏览器。

@Controller
@RequestMapping("/")
public class UIController {

    @RequestMapping(value="index", method=RequestMethod.GET, produces = "text/html")
    public @ResponseBody String GetBootupFile() throws IOException  {
        Resource resource = new ClassPathResource("MainPage.html");
        String fileContents = FileUtils.readFileToString(resource.getFile());
        return fileContents;
    }
}

Answer 2

注册org.springframework.http.converter.json.MappingJacksonHttpMessageConverter为消息转换器，直接从方法中返回对象。

<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
  <property name="webBindingInitializer">
    <bean class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer"/>
  </property>
  <property name="messageConverters">
    <list>
      <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"/>
    </list>
  </property>
</bean>

和控制器：

@RequestMapping(method=RequestMethod.GET, value="foo/bar")
public @ResponseBody Object fooBar(){
    return myService.getActualObject();
}

这需要依赖org.springframework:spring-webmvc。

Answer 3

使用ResponseEntity 而不是ResponseBody。这样您就可以访问响应标头，并且可以设置适当的内容类型。根据Spring docs：

HttpEntity 类似于 @RequestBody 和 @ResponseBody。 除了访问请求 和响应正文，HttpEntity（以及 响应特定子类 ResponseEntity) 还允许访问 请求和响应标头

代码如下：

@RequestMapping(method=RequestMethod.GET, value="/fooBar")
public ResponseEntity<String> fooBar2() {
    String json = "jsonResponse";
    HttpHeaders responseHeaders = new HttpHeaders();
    responseHeaders.setContentType(MediaType.APPLICATION_JSON);
    return new ResponseEntity<String>(json, responseHeaders, HttpStatus.CREATED);
}

Answer 4

我会考虑重构服务以返回您的域对象而不是 JSON 字符串，并让 Spring 处理序列化（在您编写时通过 MappingJacksonHttpMessageConverter）。从 Spring 3.1 开始，实现看起来相当简洁：

@RequestMapping(produces = MediaType.APPLICATION_JSON_VALUE, 
    method = RequestMethod.GET
    value = "/foo/bar")
@ResponseBody
public Bar fooBar(){
    return myService.getBar();
}

评论：

首先，<mvc:annotation-driven /> 或 @EnableWebMvc 在您的应用程序配置中必须是 added。

接下来，@RequestMapping 注解的produces 属性用于指定响应的内容类型。因此，它应该设置为MediaType.APPLICATION_JSON_VALUE（或"application/json"）。

最后，必须添加 Jackson，以便 Spring 自动处理 Java 和 JSON 之间的任何序列化和反序列化（Spring 检测到 Jackson 依赖项，MappingJacksonHttpMessageConverter 将在引擎盖下）。

Answer 5

您可能无法使用@ResponseBody 来做到这一点，但这样的事情应该可以工作：

package xxx;

import java.io.ByteArrayOutputStream;
import java.io.IOException;

import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class FooBar {
  @RequestMapping(value="foo/bar", method = RequestMethod.GET)
  public void fooBar(HttpServletResponse response) throws IOException {
    ByteArrayOutputStream out = new ByteArrayOutputStream();
    out.write(myService.getJson().getBytes());
    response.setContentType("application/json");
    response.setContentLength(out.size());
    response.getOutputStream().write(out.toByteArray());
    response.getOutputStream().flush();
  }
}

Answer 6

我不认为你可以，除了response.setContentType(..)

Answer 7

我认为这是不可能的。似乎有一个开放的 Jira：

SPR-6702: Explicitly set response Content-Type in @ResponseBody