状态码封装枚举类
使用枚举的好处是把状态码和状态信息结合到了一起,当然不使用枚举类用静态成员变量也行,状态码信息需要单独封装。
/**
* 方法执行状态工具类
* @author lqc
*/
public enum ResultCode {
SUCCESS(200, "操作成功"),
FAILED(500, "操作失败"),
FORBIDDEN(403, "没有权限执行"),
PARAMETER_ERROR(404, "传递参数有误~"),
UNAUTHORIZED(403, "暂未登录或token已经过期");
private int code;
private String msg;
ResultCode(int code, String msg) {
this.code = code;
this.msg = msg;
}
public int getCode() {
return code;
}
public String getMsg() {
return msg;
}
}
返回结果封装类
import java.io.Serializable;
import java.util.HashMap;
/**
* @author lqc
*/
public class CommonResult implements Serializable {
/**
* 状态码
*/
private int code = 0;
/**
* 提示信息
*/
private String msg;
/**
* json数据域
*/
private Object data = null;
public CommonResult() {
}
public CommonResult(int code,String msg,Object data) {
this.code = code;
this.msg = msg;
this.data = data;
}
public static CommonResult newInstance(int code,String msg,Object data){
return new CommonResult(code,msg,data);
}
public static CommonResult newInstance(int code,String msg){
return new CommonResult(code,msg,null);
}
/**
* 在map中存放多个数据
* @param key
* @param data
*/
public CommonResult putData(String key, Object data) {
if (this.data == null || !(data instanceof HashMap)) {
this.data = new HashMap<String, Object>();
}
((HashMap<String, Object>) this.data).put(key, data);
return this;
}
/**
* 在map中清除数据
* @param key
*/
public CommonResult removeData(String key){
if(data != null && data instanceof HashMap){
((HashMap<String,Object>)data).remove(key);
}
return this;
}
/**
* 设置错误的状态码
* @param CODE
*/
public CommonResult setCode(ResultCode CODE) {
this.code = CODE.getCode();
this.msg = CODE.getMsg();
return this;
}
/**
* 设置状态码和数据
* @param CODE
* @param data
*/
public CommonResult setCode(ResultCode CODE, Object data) {
this.code = CODE.getCode();
this.msg = CODE.getMsg();
this.data = data;
return this;
}
public CommonResult setException(Exception e){
if(e != null) {
this.setCode(ResultCode.FAILED.getCode());
this.setMsg(e.getMessage());
}
return this;
}
public static CommonResult success(){
return new CommonResult(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getMsg(),null);
}
public static CommonResult success(Object data){
return new CommonResult(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getMsg(),data);
}
public static CommonResult success(Object data,String msg){
return new CommonResult(ResultCode.SUCCESS.getCode(),msg,data);
}
public static CommonResult failed(){
return new CommonResult(ResultCode.FAILED.getCode(),ResultCode.FAILED.getMsg(),null);
}
public static CommonResult failed(String msg){
return new CommonResult(ResultCode.FAILED.getCode(),msg,null);
}
public static CommonResult failed(int code,String msg){
return new CommonResult(code,msg,null);
}
public static CommonResult parameterError(){
return new CommonResult(ResultCode.PARAMETER_ERROR.getCode(),ResultCode.PARAMETER_ERROR.getMsg(),null);
}
public static CommonResult forbidden(){
return new CommonResult(ResultCode.FORBIDDEN.getCode(),ResultCode.FORBIDDEN.getMsg(),null);
}
public int getCode() {
return code;
}
public CommonResult setCode(int code) {
this.code = code;
return this;
}
public String getMsg() {
return msg;
}
public CommonResult setMsg(String msg) {
this.msg = msg;
return this;
}
public Object getData() {
return data;
}
public CommonResult setData(Object data) {
this.data = data;
return this;
}
}
使用示例
//设置状态码并存入数据,可以连续put多个数据
return CommonResult.newInstance(200, "ok").putData("user", user);
return CommonResult.newInstance(200, "ok").putData("user", user).putData("deptList",deptList);
// 直接返回成功
return CommonResult.success("ok");
// 直接返回操作失败
return CommonResult.failed();
本站文章版权归原作者及原出处所有 。内容为作者个人观点, 并不代表本站赞同其观点和对其真实性负责,本站只提供参考并不构成任何投资及应用建议。本站是一个个人学习交流的平台,网站上部分文章为转载,并不用于任何商业目的,我们已经尽可能的对作者和来源进行了通告,但是能力有限或疏忽,造成漏登,请及时联系我们,我们将根据著作权人的要求,立即更正或者删除有关内容。本站拥有对此声明的最终解释权。