全局统一返数据类型封装记录

全局统一返回值封装

​ 在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;}//@Overloadspublic 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方法,方便链式编程* */@Overridepublic ApiResult put(String key,Object value){super.put(key,value);return this;}
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/791528.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

达梦配置ODBC连接

达梦配置ODBC连接

达梦配置ODBC连接 基础环境 操作系统&#xff1a;Red Hat Enterprise Linux Server release 7.9 (Maipo) 数据库版本&#xff1a;DM Database Server 64 V8 架构&#xff1a;单实例1 下载ODBC包 下载网址&#xff1a;https://www.unixodbc.org/ unixODBC-2.3.0.tar.gz2 编译并…
阅读更多...
python-django物流仓储进销存配送管理系统flask_1ea2k

python-django物流仓储进销存配送管理系统flask_1ea2k

实现了一个完整的物流管理系统&#xff0c;其中主要有站点信息模块、物流进度模块、用户表模块、司机模块、入库信息模块、签收信息模块、类型模块、快递信息模块、客户模块、客服模块、公告信息模块、服务类型模块、配置文件模块、出库信息模块、车辆信息模块、仓管模块、账户…
阅读更多...
生成式AI的情感实验——AI能否产生思想和情感？

生成式AI的情感实验——AI能否产生思想和情感？

机器人能感受到爱吗&#xff1f;这是一个很好的问题&#xff0c;也是困扰了科学家们很多年的科学未解之谜。虽然我们尚未准备好向智能机器赋予情感&#xff0c;但智能机器却已经可以借助生成式人工智能&#xff08;AI&#xff09;来帮助我们表达自己的情感。 自然情感表达 AI正…
阅读更多...
risc-v向量扩展strlen方法学习

risc-v向量扩展strlen方法学习

riscv向量文档中给出了strlen的实现&#xff0c; 大概是这么一个思路&#xff0c; 加载向量: 使用向量加载指令&#xff08;如 vload&#xff09;从内存中加载一个向量长度的字符。比较向量与零: 使用向量比较指令&#xff08;如 vmask 或 vcmpeq&#xff09;来检查向量中的每…
阅读更多...
Linux网络协议栈从应用层到内核层④

Linux网络协议栈从应用层到内核层④

文章目录 1、网卡接受数据2、网络设备层接收数据3、ip层接受数据4、tcp层接受数据5、上层应用读取数据6、数据从网卡到应用层的整体流程 1、网卡接受数据 当网卡收到数据时&#xff0c;会触发一个中断&#xff0c;然后就会调用对应的中断处理函数&#xff0c;再做进一步处理。…
阅读更多...
pycharm

pycharm

✅作者简介&#xff1a;CSDN内容合伙人、阿里云专家博主、51CTO专家博主、新星计划第三季python赛道Top1&#x1f3c6; &#x1f4c3;个人主页&#xff1a;hacker707的csdn博客 &#x1f525;系列专栏&#xff1a;零基础学Python &#x1f4ac;个人格言&#xff1a;不断的翻越一…
阅读更多...
企业计算机服务器中了mallox勒索病毒怎么办？Mallox勒索病毒解密流程步骤

企业计算机服务器中了mallox勒索病毒怎么办？Mallox勒索病毒解密流程步骤

网络技术的不断应用与发展&#xff0c;为企业的生产运营带来了极大便利&#xff0c;企业通过网络办公开展各项工作业务已经成为常态&#xff0c;网络为企业的发展带来了更多机遇&#xff0c;但随之而来的网络数据安全威胁也在不断增加。近期&#xff0c;云天数据恢复中心接到山…
阅读更多...
19k star, 导出微信聊天记录，生成 HTML、Word、CSV等格式，并分析聊天数据，做成可视化年报

19k star, 导出微信聊天记录，生成 HTML、Word、CSV等格式，并分析聊天数据，做成可视化年报

19k star, 导出微信聊天记录&#xff0c;生成 HTML、Word、CSV等格式&#xff0c;并分析聊天数据&#xff0c;做成可视化年报 分类 开源分享 项目名: 留痕 -- 一款强大的微信聊天管理工具 Github 开源地址&#xff1a;https://github.com/LC044/WeChatMsg Gitee 开源地址&…
阅读更多...
分布式架构中一些常用算法的理解

分布式架构中一些常用算法的理解

对分布式算法 - 一致性Hash算法的理解 一致性哈希算法是一种分布式算法&#xff0c;用于解决数据分布和负载均衡问题。它通过将数据和节点映射到一个哈希环上&#xff0c;实现了数据在节点之间的均匀分布和最小化数据迁移。 一致性哈希算法的核心思想是将数据和节点都映射到哈…
阅读更多...
百度行驶证C++离线SDK V1.1 C#接入

百度行驶证C++离线SDK V1.1 C#接入

百度行驶证C离线SDK V1.1 C#接入 目录 说明 效果 项目 代码 下载 说明 自己根据SDK封装了动态库&#xff0c;然后C#调用。 SDK包结构 效果 项目 代码 using Newtonsoft.Json; using System; using System.Drawing; using System.Runtime.InteropServices; using System…
阅读更多...
LeetCode-94. 二叉树的中序遍历【栈 树 深度优先搜索 二叉树】

LeetCode-94. 二叉树的中序遍历【栈 树 深度优先搜索 二叉树】

LeetCode-94. 二叉树的中序遍历【栈 树 深度优先搜索 二叉树】 题目描述&#xff1a;解题思路一&#xff1a;递归解题思路二&#xff1a;迭代解题思路三&#xff1a;0 题目描述&#xff1a; 给定一个二叉树的根节点 root &#xff0c;返回 它的 中序 遍历 。 示例 1&#xff1…
阅读更多...
基于Python深度学习的中文情感分析系统(V2.0)

基于Python深度学习的中文情感分析系统(V2.0)

博主介绍&#xff1a;✌程序员徐师兄、7年大厂程序员经历。全网粉丝12w、csdn博客专家、掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java技术领域和毕业项目实战✌ &#x1f345;文末获取源码联系&#x1f345; &#x1f447;&#x1f3fb; 精彩专栏推荐订阅&#x1f447;…
阅读更多...
信息安全就是国家安全，带大家了解一下安全算法

信息安全就是国家安全，带大家了解一下安全算法

信息安全就是国家安全&#xff01; 今天这编文章就带大家了解一下安全算法吧&#xff0c;个人理解仅供参考&#xff01; 对安全算法 - 摘要算法的理解 摘要算法是一种将任意长度的数据转换为固定长度字节串的算法。它具有以下特点和应用。 首先&#xff0c;摘要算法能够生成…
阅读更多...
文件操作详解（三）--fsee -- ftell -- rewind -- feof函数 -- ferror函数

文件操作详解（三）--fsee -- ftell -- rewind -- feof函数 -- ferror函数

目录 一.文件的随机读写1.fseek2.ftell3.rewind 二.文件读写结束的判定1.feof函数&#xff08;不是用来判定文件结束的&#xff09;2.ferror函数 三.文件缓冲区 一.文件的随机读写 1.fseek int fseek(FILE* stream,long int offset,int origin); //第一个参数文件流 //第二个…
阅读更多...
excel统计分析——协方差分析的作用

excel统计分析——协方差分析的作用

参考资料&#xff1a;生物统计学 1、协变量与试验因素的区别 如果把协方差分析资料中的协变量看作多因素方差分析资料中的一个因素&#xff0c;则两类资料有相似之处&#xff0c;但两类资料有本质的不同。在方差分析中&#xff0c;各因素的水平时人为控制的&#xff0c;即使是…
阅读更多...
学透Spring Boot — 004. Spring Boot Starter机制和自动配置机制

学透Spring Boot — 004. Spring Boot Starter机制和自动配置机制

如果你项目中一直用的是 Spring Boot&#xff0c;那么恭喜你没有经历过用 Spring 手动集成其它框架的痛苦。 都说 Spring Boot 大大简化了 Spring 框架开发 Web 应用的难度&#xff0c;这里我们通过配置 Hibernate 的两种方式来深刻体会这一点&#xff1a; 使用 Spring 框架集…
阅读更多...
MT3017 上色

MT3017 上色

思路&#xff1a;使用分治&#xff0c;在每个连续区域递归调用heng()和shu() #include <bits/stdc.h> using namespace std; int n, m; int h[5005];int shu(int l, int r) {return r - l 1; } int heng(int l, int r) {int hmin 0x3f3f3f3f;for (int i l; i < r;…
阅读更多...
【协议】RPC

【协议】RPC

文章目录 概述与web service/web api/wcf区别简介区别和联系 grpc.Net Core示例 参考 概述 与web service/web api/wcf区别 简介 RPC&#xff08;Remote Procedure Call Protocol&#xff09;即远程过程调用协议&#xff0c;是分布式系统间通信的一种协议。通过网络从远程计…
阅读更多...
【Apache Doris】周FAQ集锦：第 2 期

【Apache Doris】周FAQ集锦：第 2 期

【Apache Doris】周FAQ集锦&#xff1a;第 2 期 SQL问题数据操作问题运维常见问题其它问题关于社区 欢迎查阅本周的 Apache Doris 社区 FAQ 栏目&#xff01; 在这个栏目中&#xff0c;每周将筛选社区反馈的热门问题和话题&#xff0c;重点回答并进行深入探讨。旨在为广大用户和…
阅读更多...
关键字：static

关键字：static

回顾类中的实例变量&#xff08;即非static的成员变量&#xff09; class Circle{ private double radius; public Circle(double radius){ this.radiusradius; } public double findArea(){ return Math.PI*radius*radius; } } 创建两个C…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023