[开发测试]返回接口调用结果类

使用背景:

后台接口返回数据给(网页/app)时, 一般都是按照以下格式进行返回.

{
    "code": "200",
    "msg": "查询成功",
    "data": {}
}

其中, code 为状态码, msg 为提示文字, data 为具体返回数据.

首先明确: 这三种数据不是固定的.?

比如: msg字段值, 一定会随着项目需求的增加, 不断的进行新增/修改.?

最初, 我创建?一个 枚举类, 在该枚举类中定义一些错误提示, 项目最开始需求不多, 错误提示在这一个枚举类中并不算多.

可随着后续项目的不断变化, 提示语句/状态码越来越多.

这时候如果都在这一个 枚举类中进行新增/修改, 且不说效率如何, 光是代码看着就让人极不舒适.?

另外还有一点: 在多个单服务项目中, 一般都会创建不同的提示枚举类...

这里记录一个目前找到的比较可以接收的结果集封装方法:

1. 定义一个接口

public interface ResultCode {

    String getCode();

    String getMsg();

}

2. 创建 提示枚举类, 实现该接口

public enum ResultMsg implements ResultCode {
    /**
     * 返回状态: 成功200, 失败非200
     */
    CODE_SUCCESS("200", "操作成功"),
    CODE_ERROR("0", "操作失败"),
    ;

    public String code;
    public String msg;

    ResultMsg(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    @Override
    public String getCode() {
        return code;
    }

    @Override
    public String getMsg() {
        return msg;
    }

}

3. 创建 返回对象

public class ResultVO<T> {
    private String code;
    private String msg;
    private T data;

    public ResultVO() {
    }

    public ResultVO(String code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public ResultVO(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public ResultVO(String msg, T data) {
        this.msg = msg;
        this.data = data;
    }

    public ResultVO(ResultCode resultCode) {
        this.code = resultCode.getCode();
        this.msg = resultCode.getMsg();
    }

    public ResultVO(ResultCode resultCode, T data) {
        this.code = resultCode.getCode();
        this.msg = resultCode.getMsg();
        this.data = data;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

4. 最终调用方法

public class Rd {

    /**
     * 成功/失败 - 返回状态码+提示语句+数据展示
     *
     * @param resultCode
     * @param data
     * @return
     */
    public static ResultVO result(ResultCode resultCode, Object data) {
        return new ResultVO(resultCode.getCode(), resultCode.getMsg(), data);
    }

    /**
     * 成功/失败 - 返回状态码+提示语句
     *
     * @param resultCode
     * @return
     */
    public static ResultVO result(ResultCode resultCode) {
        return new ResultVO(resultCode.getCode(), resultCode.getMsg());
    }


}

5. 使用示例

@RequestMapping("/test")
@RestController
public class TestController {

    @RequestMapping("/test1")
    public ResultVO<String> test1() {
        return Rd.result(ResultMsg.CODE_SUCCESS);
    }

    @RequestMapping("/test2")
    public ResultVO<Date> test2() {
        return Rd.result(ResultMsg.CODE_SUCCESS, new Date());
    }

    @RequestMapping("/test3")
    public ResultVO test3() {
        return Rd.result(ResultMsg.CODE_SUCCESS, new Date());
    }
    

}

之后, 只要你创建 [提示枚举类], 只需要? implements ResultCode , 即可在接口返回时, 调用:

Rd.result(ResultMsg.CODE_SUCCESS)...