直接流到Spring MVC 3.1控制器的处理程序方法中的响应输出流

Question

我有一个处理ajax调用并返回JSON的控制器方法。我正在使用json.org的JSON库来创建JSON。

我能做到以下几点：

@RequestMapping(method = RequestMethod.POST) 
@ResponseBody 
public String getJson() 
{ 
    JSONObject rootJson = new JSONObject(); 

    // Populate JSON 

    return rootJson.toString(); 
} 

但它是无效的放在一起JSON字符串，只有有春天它写入响应的输出流。

相反，我可以直接把它写像这样的响应输出流：

@RequestMapping(method = RequestMethod.POST) 
public void getJson(HttpServletResponse response) 
{ 
    JSONObject rootJson = new JSONObject(); 

    // Populate JSON 

    rootJson.write(response.getWriter()); 
} 

但似乎会有一个更好的方式来做到这一点不必求助于经过HttpServletResponse进入处理程序方法。

是否有另一个类或接口可以从我可以使用的处理程序方法返回，以及@ResponseBody注释？

Answer 1

您可以将Output Stream或Writer作为控制器方法的参数。

@RequestMapping(method = RequestMethod.POST) 
public void getJson(Writer responseWriter) { 
    JSONObject rootJson = new JSONObject(); 
    rootJson.write(responseWriter); 
} 

@see Spring Reference Documentation 3.1 Chapter 16.3.3.1 Supported method argument types

附：我觉得利用OutputStream或Writer作为一个参数仍然是更容易在测试中比HttpServletResponse使用 - 和感谢关注what I have written ;-)

Answer 2

最后，我写了这样的一个HttpMessageConverter。有了它，我可以做到以下几点：

@RequestMapping(method = RequestMethod.POST) 
@ResponseBody 
public JSONObject getJson() 
    throws JSONException 
{ 
    JSONObject rootJson = new JSONObject(); 

    // Populate JSON 

    return rootJson; 
} 

这里是我HttpMessageConverter类：

package com.example; 

import java.io.IOException; 
import java.io.OutputStreamWriter; 
import java.io.PrintWriter; 
import java.nio.charset.Charset; 
import org.json.JSONException; 
import org.json.JSONObject; 
import org.springframework.http.HttpInputMessage; 
import org.springframework.http.HttpMessage; 
import org.springframework.http.HttpOutputMessage; 
import org.springframework.http.MediaType; 
import org.springframework.http.converter.AbstractHttpMessageConverter; 
import org.springframework.http.converter.HttpMessageNotReadableException; 
import org.springframework.http.converter.HttpMessageNotWritableException; 

public class JsonObjectHttpMessageConverter 
    extends AbstractHttpMessageConverter<JSONObject> 
{ 
    private static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8"); 

    public JsonObjectHttpMessageConverter() 
    { 
     super(new MediaType("application", "json"), new MediaType("text", "javascript")); 
    } 

    @Override 
    protected boolean supports(Class<?> clazz) 
    { 
     return JSONObject.class.equals(clazz); 
    } 

    @Override 
    protected JSONObject readInternal(Class<? extends JSONObject> clazz, 
             HttpInputMessage   inputMessage) 
     throws IOException, 
       HttpMessageNotReadableException 
    { 
     throw new UnsupportedOperationException(); 
    } 

    @Override 
    protected void writeInternal(JSONObject  jsonObject, 
           HttpOutputMessage outputMessage) 
     throws IOException, 
       HttpMessageNotWritableException 
    { 
     PrintWriter writer = new PrintWriter(new OutputStreamWriter(outputMessage.getBody(), 
                    getContentTypeCharset(outputMessage))); 

     try 
     { 
      jsonObject.write(writer); 
      writer.flush(); 
     } 
     catch (JSONException e) 
     { 
      throw new HttpMessageNotWritableException(e.getMessage(), e); 
     } 
    } 

    private Charset getContentTypeCharset(HttpMessage message) 
    { 
     MediaType contentType = message.getHeaders().getContentType(); 

     Charset charset = (contentType != null) ? contentType.getCharSet() : null; 

     return (charset != null) ? charset : DEFAULT_CHARSET; 
    } 
} 

的HttpMessageConverter必须使用Spring进行注册。这可以在dispatcher-servlet.xml文件就像这样：

<beans ...> 

    ...  

    <mvc:annotation-driven conversion-service="conversionService" validator="validator"> 
     <mvc:argument-resolvers> 
      ... 
     </mvc:argument-resolvers> 
     <mvc:message-converters> 
      <bean class="org.springframework.http.converter.StringHttpMessageConverter"> 
       <property name="supportedMediaTypes"> 
        <list> 
         <value>text/plain;charset=UTF-8</value> 
         <value>application/json;charset=UTF-8</value> 
         <value>*/*</value> 
        </list> 
       </property> 
       <property name="writeAcceptCharset" value="false" /> 
      </bean> 
      <bean class="com.example.JsonObjectHttpMessageConverter" /> 
      <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"> 
       <property name="objectMapper" ref="jacksonObjectMapper" /> 
      </bean> 
     </mvc:message-converters> 
    </mvc:annotation-driven> 

    ... 

</beans> 

正如你所看到的，我已经注册过其他HttpMessageConverter对象。订单确实很重要。

Answer 3

请注意，如果您使用OutputStream或Writer，它需要您自己编写标题。

一种解决方法是使用的InputStreamResource/ResourceHttpMessageConverter