springBoot项目设置统一响应返回

╰+哭是因爲堅強的太久メ 2022-10-15 12:54 219阅读 0赞

**一.格式选择**  
返回格式目前主流的应该只有XML、JSON两种吧，这里我们不做对比，我们使用JSON作为接口的返回格式。

**二.数据返回格式**  
数据的返回格式其实是个比较纠结的问题，在restful风格中很多文章都讲解使用的是http状态码控制请求的结果状态，例如：http状态码为200~300的时候，为正常状态，response响应体即为所需要返回的数据，404时代表没有查询到数据，响应体即为空，500为系统错误，响应体也为空等等，但是这种方式也是存在很大问题的，一是http状态码是有限的，而且每个状态码都已经被赋予特殊的含义，在企业开发中当接口遇到错误的时候，我们可能更希望将结果状态码标记的更为详细，更利于前端开发者使用，毕竟写接口的目的也是方便前端使用，这样也可以降低前后端开发人员沟通成本。  
下面给出我们在实际开发中使用的返回值统一格式：

package com.zhuma.demo.comm.result;
    import java.io.Serializable;
    import com.zhuma.demo.comm.enums.ResultCode;
    
    /** * Created by zhumaer on 17/5/24. */
     @Data
    public class Result implements Serializable { 
    
    	private static final long serialVersionUID = -3948389268046368059L;
    
    	private Integer code;
    
    	private String msg;
    
    	private Object data;
    
    	public Result() { }
    
    	public Result(Integer code, String msg) { 
    		this.code = code;
    		this.msg = msg;
    	}
    
    	public static Result success() { 
    		Result result = new Result();
    		result.setResultCode(ResultCode.SUCCESS);
    		return result;
    	}
    
    	public static Result success(Object data) { 
    		Result result = new Result();
    		result.setResultCode(ResultCode.SUCCESS);
    		result.setData(data);
    		return result;
    	}
    
    	public static Result failure(ResultCode resultCode) { 
    		Result result = new Result();
    		result.setResultCode(resultCode);
    		return result;
    	}
    
    	public static Result failure(ResultCode resultCode, Object data) { 
    		Result result = new Result();
    		result.setResultCode(resultCode);
    		result.setData(data);
    		return result;
    	}
    
    	public void setResultCode(ResultCode code) { 
    		this.code = code.code();
    		this.msg = code.message();
    	}
    }

> 备注：  
> 上面代码我们注意到其中引入了一个ResultCode枚举类，该类也是我们后面紧接着要说的，全局统一返回状态码。  
> 这里说明下字段data不是在code=1为成功的时候才会有值哦，比如当code为参数无效错误时，data可以放入更详细的错误描述，用于指明具体是哪个参数为什么导致的无效的。

**三.全局状态码**  
当你发现你的系统中错误码随意定义，没有任何规范的时候，你应该考虑下使用一个枚举全局管理下你的状态码，这对线上环境定位错误问题和后续接口文档的维护都是很有帮助的。  
下面我们在给出一个完整版代码示例，用于参考：

package com.zhuma.demo.comm.enums;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /** * API 统一返回状态码 * Created by zhumaer on 17/5/24. */
    public enum ResultCode { 
    
    	/* 成功状态码 */
    	SUCCESS(1, "成功"),
    
    	/* 参数错误：10001-19999 */
    	PARAM_IS_INVALID(10001, "参数无效"),
    	PARAM_IS_BLANK(10002, "参数为空"),
    	PARAM_TYPE_BIND_ERROR(10003, "参数类型错误"),
    	PARAM_NOT_COMPLETE(10004, "参数缺失"),
    
    	/* 用户错误：20001-29999*/
    	USER_NOT_LOGGED_IN(20001, "用户未登录"),
    	USER_LOGIN_ERROR(20002, "账号不存在或密码错误"),
    	USER_ACCOUNT_FORBIDDEN(20003, "账号已被禁用"),
    	USER_NOT_EXIST(20004, "用户不存在"),
    	USER_HAS_EXISTED(20005, "用户已存在"),
    
    	/* 业务错误：30001-39999 */
    	SPECIFIED_QUESTIONED_USER_NOT_EXIST(30001, "某业务出现问题"),
    
    	/* 系统错误：40001-49999 */
    	SYSTEM_INNER_ERROR(40001, "系统繁忙，请稍后重试"),
    
    	/* 数据错误：50001-599999 */
    	RESULE_DATA_NONE(50001, "数据未找到"),
    	DATA_IS_WRONG(50002, "数据有误"),
    	DATA_ALREADY_EXISTED(50003, "数据已存在"),
    
    	/* 接口错误：60001-69999 */
    	INTERFACE_INNER_INVOKE_ERROR(60001, "内部系统接口调用异常"),
    	INTERFACE_OUTTER_INVOKE_ERROR(60002, "外部系统接口调用异常"),
    	INTERFACE_FORBID_VISIT(60003, "该接口禁止访问"),
    	INTERFACE_ADDRESS_INVALID(60004, "接口地址无效"),
    	INTERFACE_REQUEST_TIMEOUT(60005, "接口请求超时"),
    	INTERFACE_EXCEED_LOAD(60006, "接口负载过高"),
    
    	/* 权限错误：70001-79999 */
    	PERMISSION_NO_ACCESS(70001, "无访问权限");
    
    	private Integer code;
    
    	private String message;
    
    	ResultCode(Integer code, String message) { 
    		this.code = code;
    		this.message = message;
    	}
    
    	public Integer code() { 
    		return this.code;
    	}
    
    	public String message() { 
    		return this.message;
    	}
    
    	public static String getMessage(String name) { 
    		for (ResultCode item : ResultCode.values()) { 
    			if (item.name().equals(name)) { 
    				return item.message;
    			}
    		}
    		return name;
    	}
    
    	public static Integer getCode(String name) { 
    		for (ResultCode item : ResultCode.values()) { 
    			if (item.name().equals(name)) { 
    				return item.code;
    			}
    		}
    		return null;
    	}
    
    	@Override
    	public String toString() { 
    		return this.name();
    	}
    
    	//校验重复的code值
    	public static void main(String[] args) { 
    		ResultCode[] ApiResultCodes = ResultCode.values();
    		List<Integer> codeList = new ArrayList<Integer>();
    		for (ResultCode ApiResultCode : ApiResultCodes) { 
    			if (codeList.contains(ApiResultCode.code)) { 
    				System.out.println(ApiResultCode.code);
    			} else { 
    				codeList.add(ApiResultCode.code());
    			}
    		}
    	}
    }