SpringBoot工程自定义错误JSON字段

通常我们为了统一，和前端方便处理，写的API返回JSON会有固定的结构，比如下面这种：

{
    "code":200,
    "message":"hello world!",
    "data":{
        "user":{}
    }
}

但是当返回码为非200时，比如接口不存在404，服务器错误500，Spring默认会返回一个类似这样的结构：

{
  "timestamp": "2019-07-19 10:23:47",
  "status": 403,
  "error": "Forbidden",
  "message": "没有权限",
  "path": "/web/api/public/admin/dota/version"
}

下面进行简单配置即可实现这个JSON结构的自定义：

import cn.wycode.web.DEV
import org.springframework.boot.web.servlet.error.DefaultErrorAttributes
import org.springframework.stereotype.Component
import org.springframework.web.context.request.WebRequest

@Component
class WyErrorAttributes : DefaultErrorAttributes(DEV) { // #1
    override fun getErrorAttributes(webRequest: WebRequest?, includeStackTrace: Boolean): MutableMap<String, Any> {
        val errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace) // #2
        errorAttributes["success"] = false // #3
        errorAttributes["error"] = errorAttributes["message"] // #4
        errorAttributes["data"] = errorAttributes["exception"]  // #5
        return errorAttributes
    }
}

Spring默认的DefaultErrorAttributes就写的挺好，我们继承并扩展一下就可以了，当然你也可以删除或者完全替换里面的结构。
先使用默认的方法构建一个errorAttributes。
添加一个success属性，既然是ErrorAttributes当然是false了。
覆盖error属性，改为message。
添加data属性，在DEV环境时会添加错误的类信息。

做了这个配置之后，错误信息的JSON会变成下面这样：

{
  "timestamp": "2019-07-19 16:56:41",
  "status": 500,
  "error": "/ by zero",
  "exception": "java.lang.ArithmeticException",
  "message": "/ by zero",
  "path": "/web/api/public/admin/dota/version",
  "success": false,
  "data": "java.lang.ArithmeticException"
}

SpringBoot工程自定义错误JSON字段

评论区