接口开发规范:统一接口返回值

为什么要统一接口返回值

第一是可以节省前后端的沟通时间,前端默认后端接口返回的都是同一种结构,第二是接口有很好的可读性,干净,整齐,易于形成好的写代码习惯。

统一返回值的代码编写:

1、定义一个基础类

import lombok.Data;

@Data
public class BaseResponse {
    private int code = 200;
    private String message;

    public BaseResponse(int status, String message) {
        this.code = status;
        this.message = message;
    }

    public BaseResponse() {
    }
}

2、 定义统一返回值类:

public class ObjectRestResponse<T> extends BaseResponse {

    T data;
    boolean rel;

    public boolean isRel() {
        return rel;
    }

    public void setRel(boolean rel) {
        this.rel = rel;
    }


    public ObjectRestResponse rel(boolean rel) {
        this.setRel(rel);
        return this;
    }


    public ObjectRestResponse data(T data) {
        this.setData(data);
        return this;
    }
    public T getData() {
        return data;
    }

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

    public static ObjectRestResponse ok(Object data) {
        ObjectRestResponse r = new ObjectRestResponse();
        r.setData(data);
        return r;
    }
    public static ObjectRestResponse ok(Object data,String msg) {
        ObjectRestResponse r = new ObjectRestResponse();
        r.setData(data);
        r.setMessage(msg);
        return r;
    }
    public static ObjectRestResponse error(int code,String msg) {
        ObjectRestResponse r = new ObjectRestResponse();
        r.setCode(code);
        r.setMessage(msg);
        return r;
    }
    public static ObjectRestResponse error(Object data,int code,String msg) {
        ObjectRestResponse r = new ObjectRestResponse();
        r.setCode(code);
        r.setMessage(msg);
        r.setData(data);
        return r;
    }


}

使用:

ObjectRestResponse.ok(data);

把数据返回给前端。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值