接口定义规范

Posted 2021-03-25 sharetechnologyl

同一个接口，有时候返回数组，有时候返回单个；成功的时候返回对象，失败的时候返回错误信息字符串。工作中有个系统集成就是这样定义的接口，真是辣眼睛。这个对应代码上，返回的类型是map，json，object，都是不应该的。实际工作中，我们会定义一个统一的格式，就是ResultBean，分页的有另外一个PageResultBean

@Data
public class ResultBean<T> implements Serializable {

    public static final int SUCCESS=0;

    public static final int FAIL=1;

    public static final int NO_PERMISSION=2;

    private String msg="success";

    private int code = SUCCESS;

    private T data;

    public ResultBean(){
        super();
    }

    public ResultBean(T data){
        super();
        this.data = data;
    }

    public ResultBean(Throwable e){
        super();
        this.msg = e.toString();
        this.code = FAIL;
    }
}

统一的接口规范，能帮忙规避很多无用的返工修改和可能出现的问题。能使代码可读性更加好，利于进行aop和自动化测试这些额外工作。大家一定要重视。

 原文链接：https://zhuanlan.zhihu.com/p/28708259