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

小编典典

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

json

我已经使用像这样的控制器构建了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();
    }
}

它工作正常，但现在我需要修改所有响应，并向所有响应添加“状态”和“消息”字段。我已经阅读了一些解决方案：

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

如果我想将控制器方法返回的值包装到类的对象中，可以提出其他一些通用且正确的解决方案：

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
}

阅读 226

2020-07-27

共1个答案

小编典典

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

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

您的过滤器必须实现javax.servlet.Filter接口并重写三个方法：

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（request，responseWrapper）方法调用链中的下一个过滤器，或者如果调用的过滤器是链中的最后一个过滤器，则调用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);
}
}

要使用FilterServletOutputStream类，应实现一个可用作响应对象的类。该包装对象将代替Servlet生成的原始响应发送回客户端。

ResponseWrapper类：

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();
}
}

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

请问一个问题，如果不清楚，请纠正我，如果我错了。

2020-07-27