springmvc/springboot下怎么统一设置响应格式?

Question

我们知道, 通过统一异常处理机制, 可以在controller抛异常的情况下, 也能使用我们定义的统一标准的响应数据集返回. 但是, 当在其他地方, 比如过滤器中抛了异常, springboot 是以默认的格式返回的(如下). 怎么将这种情况下, 也能使用定制的响应数据集格式呢?

{
"path":"/api/agency/v2/agented_grade/idcard_phone",
"error":"Internal Server Error",
"message":"java.lang.NullPointerException",
"timestamp":"2019-04-28T07:33:06.373+0000",
"status":500
}

Answer 1

可以通过继承DefaultErrorAttributes类，并重写getErrorAttributes方法的方式自定义错误响应字段：

@Component
public class MyCustomErrorAttributes extends DefaultErrorAttributes {

    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest,
                                                  boolean includeStackTrace) {
        
        Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);
        // errorAttributes 是错误信息，可以通过新增或覆盖原有信息实现自定义格式。
        return errorAttributes;
    }
}

具体实现方法可参考SpringBoot的Restful接口异常返回增加字段