Spring MVC:如何修改控制器发送的json响应

Question

我用这样的控制器构建了一个json REST服务：

@Controller
@RequestMapping(value = "/scripts")
public class ScriptController {

    @Autowired
    private ScriptService scriptService;

    @RequestMapping(method = RequestMethod.GET)
    @ResponseBody
    public List<Script> get() {
        return scriptService.getScripts();
    }
}

它工作得很好，但是现在我需要修改所有的响应，并为它们添加“状态”和“消息”字段。我读过一些解决方案:

1. 从所有控制器方法返回某个特定类的对象，例如RestResponse，它将包含“状态”和“消息”字段（但这不是通用解决方案，因为我必须修改所有控制器并以新样式编写新控制器）
2. 拦截所有带有方面的控制器方法（但在这种情况下，我无法更改返回类型）

如果我想把从控制器方法返回的值包装到类的对象中，你能建议一些其他的、通用的和正确的解决方案吗？

public class RestResponse {

    private int status;
    private String message;
    private Object data;

    public RestResponse(int status, String message, Object data) {
        this.status = status;
        this.message = message;
        this.data = data;
    }

    //getters and setters
}

Answer 1

如果使用spring 4.1或更高版本，可以在编写主体之前使用ResponseBodyAdvice自定义响应。

Answer 2

我遇到过类似的问题，建议您使用Servlet过滤器来解决它。

Servlet过滤器是Java类，可以在Servlet编程中使用，在客户端访问后端资源之前拦截客户端的请求，或者在将响应发送回客户端之前处理来自服务器的响应。

您的过滤器必须实现 javax.servlet.过滤器接口并覆盖三种方法：

public void doFilter (ServletRequest, ServletResponse, FilterChain)

每次由于客户端请求链末端的资源而通过链传递请求/响应对时，都会调用此方法。

public void init(FilterConfig filterConfig)

在过滤器投入使用之前调用，并设置过滤器的配置对象。

public void destroy()

在过滤器停止使用后调用。

可以使用任意数量的过滤器，并且执行顺序将与web.xml中定义它们的顺序相同。

web.xml：

...
<filter>
    <filter-name>restResponseFilter</filter-name>
    <filter-class>
        com.package.filters.ResponseFilter
    </filter-class>
</filter>

<filter>
    <filter-name>anotherFilter</filter-name>
    <filter-class>
        com.package.filters.AnotherFilter
    </filter-class>
</filter>
...

因此，这个过滤器获取控制器响应，将其转换为String，作为字段添加到RestResponse类对象（带有状态和消息字段），将其序列化为Json，并将完整的响应发送给客户端。

ResponseFilter类:

public final class ResponseFilter implements Filter {

@Override
    public void init(FilterConfig filterConfig) {
}

@Override
public void doFilter(ServletRequest request, ServletResponse response,
                     FilterChain chain) throws IOException, ServletException {

    ResponseWrapper responseWrapper = new ResponseWrapper((HttpServletResponse) response);

    chain.doFilter(request, responseWrapper);

    String responseContent = new String(responseWrapper.getDataStream());

    RestResponse fullResponse = new RestResponse(/*status*/, /*message*/,responseContent);

    byte[] responseToSend = restResponseBytes(fullResponse);

    response.getOutputStream().write(responseToSend);

}

@Override
public void destroy() {
}

private byte[] restResponseBytes(RestResponse response) throws IOException {
    String serialized = new ObjectMapper().writeValueAsString(response);
    return serialized.getBytes();
}
}

chain.doFilter方法调用链中的下一个过滤器，或者如果调用过滤器是链中的最后一个过滤器，则调用servlet逻辑。

HTTP servlet响应包装器使用一个定制的servlet输出流，让包装器在servlet写完响应数据后操作它。通常，在servlet输出流关闭后(本质上，在servlet提交输出流后)，这是不可能的。这就是对ServletOutputStream类实现特定于过滤器的扩展的原因。

FilterServletOutputStream类:

public class FilterServletOutputStream extends ServletOutputStream {

DataOutputStream output;
public FilterServletOutputStream(OutputStream output) {
    this.output = new DataOutputStream(output);
}

@Override
public void write(int arg0) throws IOException {
    output.write(arg0);
}

@Override
public void write(byte[] arg0, int arg1, int arg2) throws IOException {
    output.write(arg0, arg1, arg2);
}

@Override
public void write(byte[] arg0) throws IOException {
    output.write(arg0);
}
}

要使用过滤器服务器输出流类，应实现一个可以充当响应对象的类。此包装器对象将发送回客户端，以代替 servlet 生成的原始响应。

响应包装类：

public class ResponseWrapper extends HttpServletResponseWrapper {

ByteArrayOutputStream output;
FilterServletOutputStream filterOutput;
HttpResponseStatus status = HttpResponseStatus.OK;

public ResponseWrapper(HttpServletResponse response) {
    super(response);
    output = new ByteArrayOutputStream();
}

@Override
public ServletOutputStream getOutputStream() throws IOException {
    if (filterOutput == null) {
        filterOutput = new FilterServletOutputStream(output);
    }
    return filterOutput;
}

public byte[] getDataStream() {
    return output.toByteArray();
}
}

我认为这种方法将是解决您的问题的好方法。

如果有不清楚的地方，请提问，如果我说错了，请纠正我。