SpringBoot通用处理结果类/前端使用结果类 Result

已于 2022-04-24 08:53:39 修改
阅读量2.4k 收藏 1
点赞数
分类专栏： SpringMVC Vue3 # vue3项目实例 文章标签： 前端 vue java
于 2022-04-07 09:03:53 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fatfish517/article/details/124004764
版权

文章目录

大家实现的java web项目返回给前端的结果类，结构基本相同，但又各有不同。通过学习，发现以下几点关注点：

  • 错误代码枚举类真的有必要那么繁杂吗？
  • 错误代码实用还是文字信息实用？
  • 返回数据统一定义为Object，直观吗？便于类型检查吗？
  • 返回数据为Map类型时，怎样使用才方便？
  • 高频使用的分页查询列表的满足记录总数，实际记录数为什么不能固定在返回数据中？

对应解决：

  • 错误代码没有文字信息直观（对于程序员同样），基本代码仅四类足够日常使用（正常、用户输入错误，系统错误、其他错误）。善于利用标准定义的web状态码枚举类（org.springframework.http.HttpStatus）
  • 使用泛型绑定返回数据data类型，利于编码规范化。
  • 泛型绑定为Map时，使用链式编程方式，灵活添加不同Map元素
  • 为返回数据data，定义count(计数器)，total(满足查询条件的记录总数)
  • 自动属性success，使前端使用时不必要判断状态码分类
package com.muyi.common.core.domain;

import com.muyi.common.enums.StatusCode;
import io.swagger.annotations.ApiModel;
import org.springframework.http.HttpStatus;

import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/**
 * 通用处理结果
 * <pre>
 *     1 默认成功状态，msg=""
 *     2 data为空时，可使用实例链式编程put(String,Object)添加Map集合
 * </pre>
 *
 * @author MuYi
 * @version 1.0
 * @date 2022/4/2 13:43
 **/
@ApiModel(value = "类Result", description = "通用处理结果")
public class Result<T> implements Serializable {
    private static final int OK_CODE_VALUE        = HttpStatus.OK.value();
    private static final int FIRST_ERR_CODE_VALUE = HttpStatus.BAD_REQUEST.value();

    /**
     * 是否成功、只读
     */
    private boolean success;
    /**
     * 状态码
     * <pre>
     *     以HttpStatus为主架构，原有定义不得乱用。
     *     正常返回代码为200,即HttpStatus.OK.value()
     *
     *     用户自定义错误代码需大于1000
     * </pre>
     *
     * @see org.springframework.http.HttpStatus
     */
    private int     code  = HttpStatus.OK.value();
    /**
     * 当data为null时为0；为Map、list、Array时，获取其长度；其他类型为1
     */
    private int     count = 0;
    /**
     * 信息
     */
    private String  msg;
    /**
     * 结果数据
     */
    private T       data;
    /**
     * 满足查询条件的记录总数
     */
    private long    total = 0;

    public long getTotal() {
        return total;
    }

    public void setTotal(long total) {
        this.total = total;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
        this.success = code >= OK_CODE_VALUE && code < FIRST_ERR_CODE_VALUE;

    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
        count = obtainDataCount(data);
    }

    /**
     * 根据code判断是否成功
     * <pre>
     *     code大于等于200 小于400
     * </pre>
     *
     * @return 是否
     * @see #error(String)
     */
    public boolean isSuccess() {
        return this.success;
    }

    /**
     * 根据code判断是否成功
     * <pre>
     *     code大于等于200 小于400
     * </pre>
     *
     * @return 是否
     * @see #error(String)
     */
    public boolean getSuccess() {
        return this.success;
    }

    public int getCount() {
        return count;
    }

    /**
     * 构造
     *
     * @param code 状态码
     * @param data 结果数据
     * @param msg  信息。为空且处理成功时，前台不显示
     */
    private Result(Integer code, T data, String msg) {
        init(code, data, msg);
    }

    /**
     * 构造
     *
     * @param code 状态码
     * @param data 结果数据
     * @param msg  信息。为空且处理成功时，前台不显示
     */
    private Result(StatusCode code, T data, String msg) {
        init(code.getValue(), data, msg);
    }

    /**
     * 构造
     *
     * @param code 状态码
     * @param data 结果数据
     * @param msg  信息。为空且处理成功时，前台不显示
     */
    private Result(HttpStatus code, T data, String msg) {
        init(code.value(), data, msg);
    }

    private void init(Integer code, T data, String msg) {
        setCode(code);
        setMsg(msg);
        setData(data);
    }

    /**
     * 初始化成功/失败新实例
     *
     * @param code 代码200、300系列一般为成功;400、500系列为失败
     * @param data 处理结果
     * @param msg  信息。为空且且处理成功时，前台可不显示
     * @return 新实例
     */
    public static <T> Result<T> build(Integer code, T data, String msg) {
        if (!isSuccessCode(code)) code = OK_CODE_VALUE;
        return new Result<T>(code, data, msg);
    }

    /**
     * 初始化成功/失败新实例
     *
     * @param code 代码
     * @param data 处理结果
     * @param msg  信息。为空且处理成功时，前台不显示
     * @return 新实例
     */
    public static <T> Result<T> build(StatusCode code, T data, String msg) {
        return build(code.getValue(), data, msg);
    }

    /**
     * 初始化成功/失败新实例
     *
     * @param code 代码200、300系列一般为成功;400、500系列为失败
     * @param data 处理结果
     * @param msg  信息。为空且且处理成功时，前台可不显示
     * @return 新实例
     */
    public static <T> Result<T> build(HttpStatus code, T data, String msg) {
        return build(code.value(), data, msg);
    }

    /**
     * 初始化成功新实例
     * <pre>
     * Result.<Map<String, Object>>success(),可随后使用链式编程.put添加Map数据
     * </pre>
     *
     * @param msg 信息。为空且处理成功时，前台不显示
     * @return 新实例
     */
    public static <T> Result<T> success(String msg) {
        return build(OK_CODE_VALUE, null, msg);
    }

    /**
     * 初始化成功新实例
     * <pre>
     * Result.<Map<String, Object>>success(),可随后使用链式编程.put添加Map数据
     * </pre>
     *
     * @return 新实例
     */
    public static <T> Result<T> success() {
        return build(OK_CODE_VALUE, null, "");
    }


    /**
     * 初始化成功新实例
     *
     * @param data 处理结果
     * @param msg  信息。为空且处理成功时，前台不显示
     * @return 新实例
     */
    public static <T> Result<T> success(T data, String msg) {
        return build(StatusCode.OK.getValue(), data, msg);
    }

    /**
     * 初始化成功新实例
     *
     * @param data 处理结果
     * @return 新实例
     */
    public static <T> Result<T> success(T data) {
        return build(StatusCode.OK.getValue(), data, "");
    }

    /**
     * 初始化失败新实例
     *
     * @param code 代码非200、300系列时自动设置为400 BAD_REQUEST
     * @param data 处理结果
     * @param msg  信息。为空且处理成功时，前台不显示
     * @return 新实例
     */
    public static <T> Result<T> error(Integer code, T data, String msg) {
        if (!isSuccessCode(code)) code = FIRST_ERR_CODE_VALUE;
        return new Result<T>(code, data, msg);
    }


    /**
     * 初始化失败新实例
     *
     * @param code 代码为非200、300系列
     * @param msg  信息。为空且处理成功时，前台不显示
     * @return 新实例
     */
    public static <T> Result<T> error(HttpStatus code, String msg) {
        return build(code, null, msg);
    }

    /**
     * 初始化失败新实例
     *
     * @param code 代码为非OK
     * @param msg  信息。为空且处理成功时，前台不显示
     * @return 新实例
     */
    public static <T> Result<T> error(StatusCode code, String msg) {
        return build(code, null, msg);
    }

    /**
     * 初始化失败新实例
     * <pre>code=StatusCode.SYSTEM_ERR</pre>
     *
     * @param msg 信息。为空且处理成功时，前台不显示
     * @return 新实例
     */
    public static <T> Result<T> error(String msg) {
        return build(StatusCode.SYSTEM_ERR, null, msg);
    }

    /**
     * 初始化失败新实例
     * <pre>msg由代码定义获得</pre>
     *
     * @param code 代码应为非OK
     * @return 新实例
     */
    public static <T> Result<T> error(StatusCode code) {
        return build(code, null, code.getDesc());
    }

    /**
     * 初始化失败新实例
     * <pre>msg由代码定义获得</pre>
     *
     * @param code 代码应为非200、300系列
     * @return 新实例
     */
    public static <T> Result<T> error(HttpStatus code) {
        return build(code, null, code.getReasonPhrase());
    }

    /**
     * 判断状态是否为成功代码
     * <pre>
     *     code大于等于200 小于400
     * </pre>
     *
     * @param code 状态码
     * @return 是否
     */
    public static boolean isSuccessCode(Integer code) {
        if (code == null) return false;
        return code >= OK_CODE_VALUE && code < FIRST_ERR_CODE_VALUE;
    }

    /**
     * 如果data为Collection、Map计算data长度。否则返回0或1
     * <pre>
     *     data为null返回0，
     * </pre>
     *
     * @param data 输入
     * @return 长度
     */
    public static int obtainDataCount(Object data) {
        if (data == null) return 0;
        if (data instanceof Map) return ((Map<?,?>) data).size();
        else if (data instanceof Collection) return ((Collection<?>) data).size();
        else return 1;
    }

    /**
     * 向data添加键值对
     * <pre>
     *     如果本实例的data不为空且不是Map<String,Object>直接返回本实例，添加无效
     * </pre>
     *
     * @param key   键名 为空直接返回本实例，否则，存在则覆盖，不存在新建
     * @param value 值
     * @return 本实例
     */
    public Result<T> put(String key, Object value) {
        if (this.data == null) this.data = (T) new HashMap<String, Object>();
        ((Map<String, Object>) this.data).put(key, value);
        count = obtainDataCount(data);
        return this;
    }

    /**
     * 向data添加键值对
     * <pre>
     *     如果本实例的data不为空且不是Map<String,Object>直接返回本实例，添加无效
     * </pre>
     *
     * @param map 值
     * @return 本实例
     */
    public Result<T> put(Map<String, Object> map) {
        if (this.data == null) this.data = (T) new HashMap<String, Object>();
        ((Map<String, Object>) this.data).putAll(map);
        count = obtainDataCount(data);
        return this;
    }

}

自定义代码枚举

package com.muyi.common.enums;

import io.swagger.annotations.ApiModel;

import java.util.ArrayList;
import java.util.List;

/**
 * 枚举：处理返回状态码
 * <pre>
 *     以HttpStatus为主架构，原有定义不得乱用。
 *     正常返回代码为200,即HttpStatus.OK.value()
 *
 *     用户自定义错误代码需大于1000
 * </pre>
 *
 * @author MuYi
 * @version 1.0
 * @date 2022/4/2 13:58
 * @see org.springframework.http.HttpStatus
 **/
@ApiModel(value = "接口StatusCode", description = "枚举：")
public enum StatusCode  {
    /**
     * 处理成功
     */
    OK(200, "处理成功"),
    /**
     * 用户输入或请求错误
     */
    REQUEST_ERR(400, "用户输入或请求错误"),
    /**
     * 系统异常
     */
    SYSTEM_ERR(500, "系统异常"),
    /**
     * 未知异常
     */
    OTHER_ERR(1000, "未知异常");
    private final Integer value;
    private final String  desc;

    StatusCode(Integer value, String desc) {
        this.desc = desc;
        this.value = value;
    }

    /**
     * 获得所有中文描述
     *
     * @return 中文描述字符串数组
     */

    public static String[] getAllDesc() {
        List<String> result = new ArrayList<>();
        for (ExchangeScopeType item : ExchangeScopeType.values()) {
            result.add(item.getDesc());
        }
        return result.toArray(new String[0]);
    }

 
    public Integer getValue() {
        return this.value;
    }

 
    public String getDesc() {
        return this.desc;
    }

    /**
     * 将数值或枚举名转换为枚举值
     * <pre>
     *     输入无效返回OTHER_ERR
     * </pre>
     *
     * @param valueOrName 枚举对应的数值value(Integer类型)或枚举项名称name(String类型)
     * @return 枚举值或或OTHER_ERR。
     */
    public static StatusCode parse(Object valueOrName) {
        if (valueOrName == null) return OTHER_ERR;
        if (valueOrName instanceof Integer) {
            for (StatusCode item : StatusCode.values()) {
                if (item.getValue() == valueOrName) return item;
            }
        } else if (valueOrName instanceof String) {
            for (StatusCode item : StatusCode.values()) {
                if (item.name().equals(valueOrName)) return item;
            }
        }
        return OTHER_ERR;
    }

    public boolean isError() {
        return this != OK;
    }
}

调用片段

   @GetMapping("/list")
    @ModelViewExceptionProcess
    public Result<List<SysConfig>> list(SysConfig config) {
        PageUtils.startPage();
        Result<List<SysConfig>> result = configService.selectByCondition(config);
        PageUtils.setTotal(result);
        return result;
    }

    @Override
    public Result<Boolean> configKeyIsUnique(String configKey, Long id) {
        if (StringUtils.isBlank(configKey))
           return Result.build(StatusCode.REQUEST_ERR,false,"输入的参数键名称为空字符串");
        Long existingId = baseMapper.selectIdByKey(configKey);
        return Result.success(existingId == null || existingId.equals(id));
    }

SysUser user=new SysUser();
  Result<Map<String, Object>> result = Result.<Map<String, Object>>success()
                .put("key1", 1)
                .put("key2", 2)
                .put("key3","111")
                .put("user",user);
muyi517
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Spring Boot配置统一格式Result返回值（一）
weixin_44874115的博客
01-16 2252
在Web开发中，前后端分离开发已经深入人心，这样的开发模式对于开发优雅美观的web应用非常有益。我在网上查阅了一些资料，学习了在Spring Boot开发中使用有利于前端小伙伴合作开发的统一格式返回值，在这里总结一下： 在这里，我用到了一个辅助框架Lombok，它可以通过少量简洁的注解来实现Class的Getter/Setter方法需求，以及无参/有参构造器及Builder实现，而不需要实际编写它...
springboot统返回结果集工具类demo
03-15
springboot统返回结果集工具类demo
Struts2学习笔记(9)-Result配置全局结果集
09-02
主要介绍Struts2中使用Result配置全局结果集的方法，希望能给大家做一个参考。
秋招Java开发----牛客刷题错题总结
snh48renhaoduo的博客
09-12 2万+
刷完了牛客Java题，整理了自己做错的题，希望可以帮助到各位突破0ffer，获得Offer。
Java300集-第九章容器练习题及答案
LL的博客
04-12 324
Java300集，第九章容器练习题及答案
Spring的学习笔记
weixin_51608690的博客
12-08 90
Spring的IOC 和AOP的基本思想 以及Spring的注解开发 和事务
Springboot 通用返回类Result
qq_43649937的博客
04-17 1421
【代码】Springboot 通用返回类Result。
常用的返回码...结果信息
link123link的博客
12-14 489
        public static final int OK=20000;//成功         public static final int ERROR =20001;//失败         public static final int LOGINERROR =20002;//用户名或密码错误         public static final int ACCESSERRO...
Spring Boot的通用返回类Result
热门推荐
StillTogether的博客
08-11 2万+
先构建一个格式确定下来的Result类 public class Result&lt;T&gt; { private Integer code; private String msg; private T data; public Result() { super(); } public Result(Integer code...
result类
qq_43381763的博客
09-11 1156
//在java后端返回是 需要用到 这个类 Result 返回 返回值为 （boolean,String，data） public class Result implements Serializable{ private boolean flag;//执行结果，true为执行成功 false为执行失败 private String message;//返回结果信息，主要用于页面提示信息 private Object data;//返回数据 public Result(boo
jQuery前端框架easyui使用Dialog时bug处理
01-19
最近一直都在用easyui前端框架来开发设计UI，但在使用Dialog时，发现如果页面内容比较多，就会出现问题，首先看一下我的原代码： 代码如下:  <input type=”button” value=”确认预约” id=”btnconfirm” ...
基于fastjson的简约版JSON响应类
08-09
简短的json响应类，把重复书写的代码简约化，追求极简主义。使用场景依个人而定，需要更多的响应方式可以自行改造~~
MongoUtils工具类实现
08-26
封装mong关联查询api接口，... UpdateResult result = mongoTemplate.updateMulti(query, update, obj.getClass(), collectionName); return result.wasAcknowledged(); } public List<?> getAllByCollectionName
【解决NodeJS项目无法在IDEA中调试的问题】使用JetBrains IDEA 2023 调试nodejs项目
宅斗士的博客
04-23 368
项目采用Ant Design Pro + React，使用前后端分离开发方式，后端可以很容易的打断点调试，但是前端用到了React脚手架，在IDEA中加了调试断点，但是没有什么用处。
【前端】数组的常用处理函数
lcukyNwa的博客
04-22 397
item------->每个元素值 (必)index----->索引（可选）arr-------- >当前数组（可选）推荐vscode的一款插件来写以下的demo，该插件可以直接在js文件中显示结果，搜 Quokka.js用这个插件去新建一个js文件，直接就运行在node上了forEach不会返回一个新的数组，里面改值会影响原数组，其他方法不影响原数组map可以返回新数组 用于映射，如每个元素都加倍或执行其他转换操作every返回一布尔值，需数组中全部满足。
C++ WebServer的细节理解
我的博客
04-22 594
在非阻塞模式下，如果 I/O 操作不能立即完成（例如，因为没有数据可读 或 写缓冲区满），系统不会让调用进程阻塞等待，而是立即返回一个错误（通常为 EAGAIN 或 EWOULDBLOCK）。先查询文件描述符 fd 当前的标志，然后将 O_NONBLOCK 标志加入其中，并通过 F_SETFL 来更新文件描述符，最终实现将该文件描述符切换为非阻塞模式。这意味着，如果没有待处理的连接请求（即没有客户端尝试连接到服务器），accept() 会一直阻塞，直到有新的连接请求到达或发生其他特定条件（如超时）为止。
SpringBoot项目打包分离高阶操作
Record Little
04-23 582
虽然传输jar包 比较大，但是安全性、稳定性比较高，不需要关注pom.xml 添加了新的依赖、更新了版本号等等影响版本功能的操作。关注maven的特性， profiles即可满足， 根据不同的activation 状态，激活不同的build操作。每次修改一小部分代码或仅仅更新某个依赖jar包时，都需要重新进行整个项目的构建、打包、上传和部署。但是当你的项目趋于稳定，只有业务上的逻辑变更时，如果使用分离版本，可以加快迭代、更新的速度。弊端： 需要配置IDE命令，修改依赖时需要同时修改2处。
webman 事务回滚失效问题记录
juan9872的博客
04-21 727
webman是一款基于workerman开发的高性能HTTP服务框架。webman用于替代传统的php-fpm架构，提供超高性能可扩展的HTTP服务。你可以用webman开发网站，也可以开发HTTP接口或者微服务。除此之外，webman还支持自定义进程，可以做workerman能做的任何事情，例如websocket服务、物联网、游戏、TCP服务、UDP服务、unix socket服务等等。
vue实现录音并转文字功能，包括PC端web，手机端web
最新发布
byebukesi的博客
04-26 347
不止vue，不限技术栈，vue2、vue3、react、.net以及原生js均可实现。
springboot Result 对返回结果数据处理，以json返回
06-01
在Spring Boot中，通常使用Result类来包装控制器方法的返回值，以便对返回结果进行统一的处理和格式化。Result类通常包含一个表示操作结果的状态码、一个表示操作结果的消息、以及一个表示操作结果的数据。可以通过自定义Result类的构造方法来设置这些信息。 以下是一个简单的Result类的示例： ``` public class Result<T> { private int code; private String message; private T data; public Result(int code, String message, T data) { this.code = code; this.message = message; this.data = data; } // 省略getter和setter方法 } ``` 在控制器方法中，可以使用这个Result类来包装方法的返回值，并使用@ResponseBody注解将其转换为JSON格式的数据，以便返回给客户端。例如： ``` @GetMapping("/user/{id}") @ResponseBody public Result<User> getUser(@PathVariable Long id) { User user = userService.getUserById(id); if (user != null) { return new Result<>(200, "success", user); } else { return new Result<>(404, "not found", null); } } ``` 在上面的示例中，控制器方法getUser返回一个Result<User>类型的对象，并使用@ResponseBody注解将其转换为JSON格式的数据。客户端可以通过解析这个JSON数据来获取操作结果的状态码、消息以及数据。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

muyi517

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值