ResultUtil 返回结果统一格式处理

作为一个好的接口,肯定需要一个美观的统一返回格式。
那么,这是怎么做到的呢?

  1. 创建Result工具类,编写接口调用成功失败返回方法,通常code、message、data这三部分组成
  2. 为了更规范、美观,让自己的项目更有逼格,code通常用枚举代替直接赋值。当然了,从技术层面这也是有必要性的,通常我们项目编译成class文件的话是看不到直接赋值的,如果定义成枚举,那别人可以通过查看枚举来看到具体内容,同样对于自己而言,这也有利于代码的可读性、可维护性。

ResultUtil




import lombok.Data;

@Data
public class ResultUtil {

        private String code;

        private String msg;

        private Object data;

        public static ResultUtil success(Object data) {
            return resultData(CodeEnum.SUCCESS.val(), CodeEnum.SUCCESS.msg(), data);
        }

        public static ResultUtil success(Object data, String msg) {
            return resultData(CodeEnum.SUCCESS.val(), msg, data);
        }

        public static ResultUtil fail(String code, String msg) {
            return resultData(code, msg, null);
        }

        public static ResultUtil fail(String code, String msg, Object data) {
            return resultData(code, msg, data);
        }

        private static ResultUtil resultData(String code, String msg, Object data) {
            ResultUtil resultData = new ResultUtil();
            resultData.setCode(code);
            resultData.setMsg(msg);
            resultData.setData(data);
            return resultData;
        }

}

CodeEnum



public enum CodeEnum {
    /** 成功 */
    SUCCESS("200", "成功"),

    /** 操作失败 */
    ERROR("500", "操作失败");

     CodeEnum(String value, String msg){
        this.val = value;
        this.msg = msg;
    }

    public String val() {
        return val;
    }

    public String msg() {
        return msg;
    }

    private String val;
    private String msg;
}


你可能感兴趣的:(技术)