在使用restful api风格的接口进行开发时,后端中需要对具体的操作结果进行封装,在这个过程中,一般习惯先编写一个ResponseCode,然后编写一个ResponseResult ,用来做具体的成功or失败返回结果的封装。
一、首先定义状态信息类ResponseCode
在这个类中,编写与前端约定好的一些字段,比如code(状态码),messsge(提示信息)等。
public int id;
public String msg;
public ResponseCode(int id, String msg) {
this.id = id;
this.msg = msg;
}
/**
* 系统通用
* */
public static ResponseCode SERVER_SUCCESS = new ResponseCode(500000,"操作成功!");
public static ResponseCode SERVER_ERROR = new ResponseCode(500001,"服务器异常");
二、编写ResponseResult类
这个类就是对返回数据的一个具体具体封装类,这里需要定义ResponseCode中的信息,并且添加一个不确定的data字段,但也有一些人喜欢将不同的方法体重新见一个ResultUtil类,这个根据这人的习惯就好。
public class ResponseResult<T> {
private int code;
private String msg;
private T data;
/**
* 不同的data数据类型对应不同的ResponseResult的类型
* */
/**
*返回 code message data 方法构造器
* */
public ResponseResult(ResponseCode rc,T data) {
this.data = data;
this.msg = rc.msg;
this.code = rc.id;
}
/**
* successful
* */
public static <T> ResponseResult<T> success(T data){
return new ResponseResult<T>(ResponseCode.SERVER_SUCCESS,data);
}
/**
* error
* */
public static <T> ResponseResult<T> error(T data){
return new ResponseResult<T>(ResponseCode.SERVER_ERROR,data);
}
}
这里要注意类中泛型和变量中泛型的使用,这里只写了两个方法,是个上面的两个构造器对应的。具体的成功/失败/其他的方法的构造器可以自己进行定义。