Spring Boot 无侵入式 实现API接口统一JSON格式返回

无侵入式 统一返回JSON格式

其实本没有没打算写这篇博客的，但还是要写一下写这篇博客的起因是因为，现在呆着的这家公司居然没有统一的API返回格式?，询问主管他居然告诉我用HTTP状态码就够用了（fxxk），天哪HTTP状态码真的够用吗？

在仔细的阅读了项目源码后发现，在API请求的是居然没有业务异常（黑人问好）。好吧 居然入坑了只能遵照项目风格了，懒得吐槽了。

因为项目已经开发了半年多了, 要是全部接口都做修改工作量还是挺大的, 只能用这种无侵入式的方案来解决.

项目源代码: https://github.com/469753862/galaxy-blogs/tree/master/code/responseResult

定义JSON格式

定义返回JSON格式

后端返回给前端一般情况下使用JSON格式, 定义如下

{  
    "code": 200,  
    "message": "OK",  
    "data": {  
  
    }  
}  

• code: 返回状态码
• message: 返回信息的描述
• data: 返回值

定义JavaBean字段

定义状态码枚举类

@ToString  
@Getter  
public enum ResultStatus {  
  
    SUCCESS(HttpStatus.OK, 200, "OK"),  
    BAD_REQUEST(HttpStatus.BAD_REQUEST, 400, "Bad Request"),  
    INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, 500, "Internal Server Error"),;  
  
    /** 返回的HTTP状态码,  符合http请求 */  
    private HttpStatus httpStatus;  
    /** 业务异常码 */  
    private Integer code;  
    /** 业务异常信息描述 */  
    private String message;  
  
    ResultStatus(HttpStatus httpStatus, Integer code, String message) {  
        this.httpStatus = httpStatus;  
        this.code = code;  
        this.message = message;  
    }  
}  

状态码和信息以及http状态码就能一一对应了便于维护, 有同学有疑问了为什么要用到http状态码呀,因为我要兼容项目以前的代码, 没有其他原因, 当然其他同学不喜欢http状态码的可以吧源码中HttpStatus给删除了

定义返回体类

@Getter  
@ToString  
public class Result {  
    /** 业务错误码 */  
    private Integer code;  
    /** 信息描述 */  
    private String message;  
    /** 返回参数 */  
    private T data;  
  
    private Result(ResultStatus resultStatus, T data) {  
        this.code = resultStatus.getCode();  
        this.message = resultStatus.getMessage();  
        this.data = data;  
    }  
  
    /** 业务成功返回业务代码和描述信息 */  
    public static Result success() {  
        return new Result(ResultStatus.SUCCESS, null);  
    }  
  
    /** 业务成功返回业务代码,描述和返回的参数 */  
    public static  Result success(T data) {  
        return new Result(ResultStatus.SUCCESS, data);  
    }  
  
    /** 业务成功返回业务代码,描述和返回的参数 */  
    public static  Result success(ResultStatus resultStatus, T data) {  
        if (resultStatus == null) {  
            return success(data);  
        }  
        return new Result(resultStatus, data);  
    }  
  
    /** 业务异常返回业务代码和描述信息 */  
    public static  Result failure() {  
        return new Result(ResultStatus.INTERNAL_SERVER_ERROR, null);  
    }  
  
    /** 业务异常返回业务代码,描述和返回的参数 */  
    public static  Result failure(ResultStatus resultStatus) {  
        return failure(resultStatus, null);  
    }  
  
    /** 业务异常返回业务代码,描述和返回的参数 */  
    public static  Result failure(ResultStatus resultStatus, T data) {  
        if (resultStatus == null) {  
            return new Result(ResultStatus.INTERNAL_SERVER_ERROR, null);  
        }  
        return new Result(resultStatus, data);  
    }  
}  

因为使用构造方法进行创建对象太麻烦了, 我们使用静态方法来创建对象这样简单明了

Result实体返回测试

@RestController  
@RequestMapping("/hello")  
public class HelloController {  
  
    private static final HashMap INFO;  
  
    static {  
        INFO = new HashMap<>();  
        INFO.put("name", "galaxy");  
        INFO.put("age", "70");  
    }  
  
    @GetMapping("/hello")  
    public Map hello() {  
        return INFO;  
    }  
  
    @GetMapping("/result")  
    @ResponseBody  
    public Result> helloResult() {  
        return Result.success(INFO);  
    }  
}  

到这里我们已经简单的实现了统一JSON格式了, 但是我们也发现了一个问题了,想要返回统一的JSON格式需要返回Result