全局统一返回值封装
在Spring Boot中，实现全局统一返回值封装是一种常见的做法，它有助于保持API的一致性，并简化前端对响应数据的处理。创建一个响应体类，包含状态码、消息、数据等字段。这个类可以作为所有控制器返回值的通用格式。
下面通过三种类型的统一返回响应体来实现全局统一返回值的封装！（大同小异）
这里做个记录文档方便下次开发使用！！
一、返回自定义类型(常用)
1.1 封装响应状态码枚举Enum类
这里的枚举类型可以自己封装。也可以使用 Hutool 工具包类中的枚举类型，针对Http响应，Hutool封装了一个类用于保存Http状态码。
在Hutool工具类中， HttpStatus 是一个枚举类，它用于表示HTTP响应的状态码及其对应的描述。HttpStatus 类中定义了很多常见的HTTP状态码，如200、404、500等，并提供了方便的方法来获取状态码和描述。
-
使用Hutool包中的枚举
要使用Hutool的 HttpStatus ，首先确保你已经将Hutool的依赖添加到了你的项目中。如果你使用的是Maven，可以在 pom.xml 文件中添加如下依赖：
<!-- Hutool Java工具类库 -->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.8.18</version>
</dependency>
直接使用Hutool工具包中的枚举类型:
- 自定义封装Http状态码枚举类 ResultCodeEnum
/**
* @author: AD_Liu
* @Description: 响应状态码
* @ClassName: HttpStatus
*/
@Getter
public enum ResultCodeEnums {
SUCCESS(200, "操作成功"),
CREATED(201, "对象创建成功"),
ACCEPTED(202, "请求已经被接受"),
NO_CONTENT(204, "操作已经执行成功，但是没有返回数据"),
MOVED_PERMANENTLY(301, "请求的URL已经移走"),
SEE_OTHER(302, "请求的URL已经改变"),
NOT_MODIFIED(304, "资源没有被修改"),
BAD_REQUEST(400, "参数列表错误（缺少，格式不匹配）"),
UNAUTHORIZED(401, "未授权"),
FORBIDDEN(403, "访问受限，授权过期"),
NOT_FOUND(404, "资源，服务未找到"),
BAD_METHOD(405, "不支持当前请求方法"),
CONFLICT(409, "资源冲突，或者资源被锁"),
UNSUPPORTED_TYPE(415, "不支持的数据，媒体类型"),
ERROR(500, "系统内部错误"),
NOT_IMPLEMENTED(501, "接口未实现"),
WARN(601, "系统警告");
private final int code;
private final String message;
ResultCodeEnums(Integer code, String message) {
this.code = code;
this.message = message;
}
}
1.2 统一响应体类
PS注：需要指定响应数据data的类型
package com.ainuoshengwu.answspringboot.common;
import com.ainuoshengwu.answspringboot.common.enums.HttpStatusEnums;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import java.io.Serializable;
/**
* @ClassName : R
* @Description : 全局响应数据结构 视图对象
* @Author : AD
*/
@Data
@NoArgsConstructor
@AllArgsConstructor
/** chain:支持链式编程 fluent：忽略get/set前缀 */
@Accessors(chain = true,fluent = true)
public class R<T> implements Serializable {
/** 业务响应状态 */
private Integer code;
/** 响应消息：一般为请求处理失败后返回的错误提示 */
private String msg;
/** 响应中的数据 */
private T data;
/**
* 返回成功消息
* */
public static R success(String msg,Object date){
return new R(HttpStatusEnums.SUCCESS.getCode(),msg,date);
}
public static R success(String msg){
return R.success(msg,null);
}
public static R success(Object date){
return R.success(HttpStatusEnums.SUCCESS.getMessage(),date);
}
public static R success(){
return R.success(HttpStatusEnums.SUCCESS.getMessage());
}
/**
* 返回警告信息
* */
public static R warn(String msg,Object data) {
return new R(HttpStatusEnums.WARN.getCode(), msg, data);
}
public static R warn(String msg){
return R.warn(msg,null);
}
public static R warn(Object data){
return R.warn(HttpStatusEnums.WARN.getMessage(),data);
}
public static R warn(){
return R.warn(HttpStatusEnums.WARN.getMessage());
}
/**
* 返回错误信息
* */
public static R error(String msg,Object data){
return new R(HttpStatusEnums.ERROR.getCode(),msg,data);
}
public static R error(){
return R.error(HttpStatusEnums.ERROR.getMessage(),null);
}
public static R error(String msg){
return R.error(msg,null);
}
public static R error(int code,String msg){
return new R(code,msg,null);
}
}
二、返回JSONObject类型
2.1 响应体封装
package cn.zhidasifang.camundaproject.utils;
import com.alibaba.fastjson.JSONObject;
import kotlin.jvm.JvmOverloads;
/**
* @Description: 统一返回值工具类
* @ClassName: R
*/
public class R extends JSONObject {
/**
*@Description--请求操作成功！！
*@Param [msg, resultObj]
*@return cn.zhidasifang.camundaproject.utils.R
*/
public static R ok(String msg,Object resultObj){
R jsonObject = new R();
jsonObject.put("result","ok");
jsonObject.put("msg",msg);
jsonObject.put("resultObj",resultObj);
return jsonObject;
}
//@Overloads
public static R ok(String msg){
R jsonObject = new R();
jsonObject.put("result","ok");
jsonObject.put("msg",msg);
jsonObject.put("resultObj",null);
return jsonObject;
}
/**
*@Description--请求错误返回数据！
*@Param [msg, resultObj]
*@return cn.zhidasifang.camundaproject.utils.R
*/
public static R error(String msg,Object resultObj){
R r = new R();
r.put("result","error");
r.put("msg",msg);
r.put("resultObj",resultObj);
return r;
}
/**
*@Description--请求获取数据失败的返回参数
*@Param [msg, resultObj]
*@return cn.zhidasifang.camundaproject.utils.R
*/
public static R fail(String msg,Object resultObj){
R r = new R();
r.put("result","fail");
r.put("msg",msg);
r.put("resultObj",resultObj);
return r;
}
}
三、返回HashMap类型(推荐使用)
3.1 响应状态码枚举类型封装
/**
* @author: AD_Liu
* @Description: 响应状态码
* @ClassName: HttpStatus
*/
@Getter
public enum HttpStatusEnum {
SUCCESS(200, "操作成功"),
CREATED(201, "对象创建成功"),
ACCEPTED(202, "请求已经被接受"),
NO_CONTENT(204, "操作已经执行成功，但是没有返回数据"),
MOVED_PERMANENTLY(301, "请求的URL已经移走"),
SEE_OTHER(302, "请求的URL已经改变"),
NOT_MODIFIED(304, "资源没有被修改"),
BAD_REQUEST(400, "参数列表错误（缺少，格式不匹配）"),
UNAUTHORIZED(401, "未授权"),
FORBIDDEN(403, "访问受限，授权过期"),
NOT_FOUND(404, "资源，服务未找到"),
BAD_METHOD(405, "不支持当前请求方法"),
CONFLICT(409, "资源冲突，或者资源被锁"),
UNSUPPORTED_TYPE(415, "不支持的数据，媒体类型"),
ERROR(500, "系统内部错误"),
NOT_IMPLEMENTED(501, "接口未实现"),
WARN(601, "系统警告");
private final int code;
private final String message;
HttpStatusEnum(Integer code, String message) {
this.code = code;
this.message = message;
}
}
3.2 统一返回值实体类封装
import cn.hutool.core.util.ObjectUtil;
import cn.zhidasifang.common.enums.HttpStatusEnum;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Objects;
/**
* @author: AD_Liu
* @Description: 同一响应数据类型
* @ClassName: ApiResult
*/
public class ApiResult<T> extends HashMap<String, Object> implements Serializable {
/**
* 状态码
*/
public static final String CODE_TAG = "code";
/**
* 返回内容
*/
public static final String MSG_TAG = "msg";
/**
* 数据对象
*/
public static final String DATA_TAG = "data";
/**
* 构造器
* */
public ApiResult() {}
public ApiResult(int code, String msg) {
super.put(CODE_TAG, code);
super.put(MSG_TAG, msg);
}
public ApiResult(int code, String msg,Object data) {
super.put(CODE_TAG, code);
super.put(MSG_TAG, msg);
if (ObjectUtil.isNotNull(data)) {
super.put(DATA_TAG, data);
}
}
/**
* 返回成功消息
* */
public static ApiResult success(String msg,Object date){
return new ApiResult(HttpStatusEnum.SUCCESS.getCode(),msg,date);
}
public static ApiResult success(String msg){
return ApiResult.success(msg,null);
}
public static ApiResult success(Object date){
return ApiResult.success(HttpStatusEnum.SUCCESS.getMessage(),date);
}
public static ApiResult success(){
return ApiResult.success(HttpStatusEnum.SUCCESS.getMessage());
}
/**
* 返回警告信息
* */
public static ApiResult warn(String msg,Object data) {
return new ApiResult(HttpStatusEnum.WARN.getCode(), msg, data);
}
public static ApiResult warn(String msg){
return ApiResult.warn(msg,null);
}
/**
* 返回错误信息
* */
public static ApiResult error(String msg,Object data){
return new ApiResult(HttpStatusEnum.ERROR.getCode(),msg,data);
}
public static ApiResult error(){
return ApiResult.error(HttpStatusEnum.ERROR.getMessage(),null);
}
public static ApiResult error(String msg){
return ApiResult.error(msg,null);
}
public static ApiResult error(int code,String msg){
return new ApiResult(code,msg,null);
}
/**
* 检验消息类型
* */
public boolean isSuccess() {
return Objects.equals(HttpStatusEnum.SUCCESS.getCode(), this.get(CODE_TAG));
}
public boolean isWarn() {
return Objects.equals(HttpStatusEnum.WARN.getCode(), this.get(CODE_TAG));
}
public boolean isError(){
return Objects.equals(HttpStatusEnum.ERROR.getCode(), this.get(CODE_TAG));
}
/**
* 从写HashMap的put方法,方便链式编程
* */
@Override
public ApiResult put(String key,Object value){
super.put(key,value);
return this;
}
}
