统一结果封装解决方案

已于 2022-07-20 17:30:28 修改
阅读量410 收藏
点赞数 1
分类专栏： Java相关 文章标签： 数据库
于 2022-07-17 09:00:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Java__EE/article/details/125798701
版权

统一结果封装解决方案

之所以这么做，想必凡是工作过的后端程序员应该都是了解的，为了前后端交互简单，统一格式返回便于前端解析。

一 、表现层与前端数据传输协议定义

大体分两类一种是分页返回、非分页返回。

1.1、非分页返回大体实现思路

（可以按需所取，没必要全部都有）

为了封装返回的结果数据:创建结果模型类，封装数据到data属性中
为了封装返回的数据是何种操作及是否操作成功:封装操作结果到code属性中
操作失败后为了封装返回的错误信息:封装特殊消息到message(msg)属性中
操作失败后为了便于排查问题封装返回的debug错误信息:封装特殊消息到debugMessage(debugMsg)属性中
为了记录封装返回元数据信息:封装元数据信息到metadata属性中
1.2、分页返回大体实现思路

（可以按需所取，没必要全部都有）

为了封装返回的当前页码:pageNum
为了封装返回的页大小:pageSize
为了封装返回的总记录条数:total
为了封装返回的结果数据:list

二、 表现层与前端数据传输协议实现

2.1、非分页实现之–使用Object：
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import org.springframework.http.HttpStatus;
import java.io.Serializable;
import java.util.Map;

/**
 * @author ：
 * @date ：Created in 2022/04/23
 * @description ：返回结果信息
 * @version: 1.0
 */
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class Result implements Serializable {
    
    /**
     * 返回结果，true为成功，false为失败
     */
    private Integer code;
    
    /**
     * 返回结果信息
     */
    private String message;
    
    /**
     * 返回debug信息
     */
    private String debugMsg;
    
    /**
     * 元数据
     */
    private Map<?, ?> metadata;
    
    /**
     * 返回结果数据
     */
    private Object data;


    public Result(Boolean status, String message) {
        this.code = status ? HttpStatus.OK.value() : HttpStatus.INTERNAL_SERVER_ERROR.value();
        this.message = message;
    }

    public Result(Boolean status, String message, Object data) {
        this.code = status ? HttpStatus.OK.value() : HttpStatus.INTERNAL_SERVER_ERROR.value();
        this.message = message;
        this.data = data;
    }

    public Result(HttpStatus httpStatus, String message, Object data) {
        this.code = httpStatus.value();
        this.message = message;
        this.data = data;
    }

    public Result(Integer code, String message) {
        this.code = code;
        this.message = message;
    }
    
}
2.2、非分页实现之–使用泛型：

注;缺少异常code枚举类导包ExceptionCodeEnum（可以去我写的通用异常解决方案文章里面去复制）


import com.google.common.base.Strings;
import lombok.Data;
import javax.annotation.Nullable;
import java.util.Map;

/**
 * @author ：
 * @date ：Created in 2022/04/23
 * @description ：返回结果信息
 * @version: 1.0
 */
@Data
public final class Result<T> {

    /**
     * 响应码
     */
    private final int code;

    /**
     * 具体内容
     */
    private final T data;

    /**
     * 消息
     */
    private final String message;

    /**
     * 元数据
     */
    private final Map<?, ?> metadata;

    /**
     * debug错误信息
     */
    private String debugMessage;

    public Result(int code, T data, String message, Map<?, ?> metadata, String debugMessage) {
        this.code = code;
        this.data = data;
        this.message = message;
        this.metadata = metadata;
        this.debugMessage = debugMessage;
    }

    private Result(int code, @Nullable String message, @Nullable T data, @Nullable Map<?, ?> metadata) {
        this.code = code;
        this.message = message;
        this.data = data;
        this.metadata = metadata;
    }

    public static <Response> Result<Response> of(int code, String message, Response data, Map<?, ?> metadata) {
        return new Result<>(code, message, data, metadata);
    }

    public static <Response> Result<Response> of(int code, String message) {
        return new Result<>(code, message, null, null);
    }

    public static <Response> Result<Response> of(ExceptionCodeEnum retCode) {
        return new Result<>(retCode.getCode(), retCode.getDesc(), null, null);
    }

    public static <Response> Result<Response> of(ExceptionCodeEnum retCode, String message) {
        if (Strings.isNullOrEmpty(message)) {
            message = retCode.getDesc();
        }
        return new Result<>(retCode.getCode(), message, null, null);
    }


    public static <Response> Result<Response> of(ExceptionCodeEnum retCode, @Nullable String message, Response data) {
        if (Strings.isNullOrEmpty(message)) {
            message = retCode.getDesc();
        }
        return new Result<>(retCode.getCode(), message, data, null);
    }

    public static <Response> Result<Response> of(ExceptionCodeEnum retCode, Response data) {
        return new Result<>(retCode.getCode(), retCode.getDesc(), data, null);
    }

    public static <Response> Result<Response> success(Response data) {
        return new Result<>(ExceptionCodeEnum.SUCCESS.getCode(), ExceptionCodeEnum.SUCCESS.getDesc(), data, null);
    }

    public static <Response> Result<Response> success() {
        return new Result<>(ExceptionCodeEnum.SUCCESS.getCode(), ExceptionCodeEnum.SUCCESS.getDesc(), null, null);
    }

    public static <Response> Result<Response> nestedOf(ExceptionCodeEnum retCode, Result<?> nestedResult) {
        String msg = (Strings.isNullOrEmpty(nestedResult.message) ? retCode.getDesc() : nestedResult.message);
        return new Result<>(retCode.getCode(), msg, null, null);
    }


}
2.3、分页实现之–使用总记录条数和当前页：

import java.io.Serializable;
import java.util.List;

/**
 * @author ：
 * @date ：Created in 2022/04/28
 * @description ：分页结果实体类
 * @version: 1.0
 */
public class PageResult implements Serializable {

	/**
	 * 总记录条数
	 */
	private Long total;

	/**
	 * 当前页结果
	 */
	private List rows;

	public PageResult(Long total, List rows) {
		super();
		this.total = total;
		this.rows = rows;
	}

	public Long getTotal() {
		return total;
	}

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

	public List getRows() {
		return rows;
	}

	public void setRows(List rows) {
		this.rows = rows;
	}
	
}
2.4、分页实现之–使用Pagehelper：

import com.github.pagehelper.Page;
import com.github.pagehelper.PageInfo;
import lombok.Data;
import javax.annotation.Nullable;
import javax.validation.constraints.NotNull;
import java.util.Collections;
import java.util.List;
import java.util.Optional;

/**
 * @author ：
 * @date ：Created in 2022/04/28
 * @description ：分页结果实体类
 * @version: 1.0
 */
@Data
public final class PageResult<T> {

    /**
     * 当前页码
     */
    private final Integer pageNum;

    /**
     * 页大小
     */
    private final Integer pageSize;

    /**
     * 总记录条数
     */
    private final Long total;

    /**
     * 存放数据
     */
    private final List<T> list;

    private PageResult(@NotNull Integer pageNum, @NotNull Integer pageSize, @NotNull Long total, @Nullable List<T> list) {
        this.pageNum = pageNum;
        this.pageSize = pageSize;
        this.total = total;
        this.list = list;
    }


    public static <T> PageResult<T> restPage(@NotNull Integer pageNum, @NotNull Integer pageSize, @NotNull Long total, @Nullable List<T> list) {
        return new PageResult<>(pageNum, pageSize, total, Optional.ofNullable(list).orElse(Collections.emptyList()));
    }

    /**
     * 分页结果转化为通用结果
     */
    public static <T> PageResult<T> restPage(@NotNull Page<T> page) {
        return new PageResult<>(page.getPageNum(), page.getPageSize(), page.getTotal(), page.getResult());
    }

    /**
     * 分页结果转化为通用结果
     */
    public static <T> PageResult<T> restPage(@NotNull PageInfo<T> page) {
        return new PageResult<>(page.getPageNum(), page.getPageSize(), page.getTotal(), page.getList());
    }

    /**
     * 将Jpa分页结果转化为通用结果
     */
    public static <T> PageResult<T> restPage(@NotNull org.springframework.data.domain.Page<T> page) {
        return new PageResult<>(page.getNumber()+1, page.getSize(), page.getTotalElements(), page.getContent());
    }

}
2.5、定义返回码Code类
/**
 * @author ：
 * @date ：Created in 2022/04/29
 * @description ：状态码
 * @version: 1.0
 */
public class Code {
    public static final Integer SAVE_OK = 20011;
    public static final Integer DELETE_OK = 20021;
    public static final Integer UPDATE_OK = 20031;
    public static final Integer GET_OK = 20041;

    public static final Integer SAVE_ERR = 20010;
    public static final Integer DELETE_ERR = 20020;
    public static final Integer UPDATE_ERR = 20030;
    public static final Integer GET_ERR = 20040;
}

注意: code类中的常量设计也不是固定的，可以根据需要自行增减，例如将查询再进行细分为GET_OK,GET_ALL_OK,GET_PAGE_OK等。

小白de成长之路
关注
专栏目录
SpringMVC-统一结果封装
qq_53098203的博客
03-21 551
SpringMVC-统一结果封装
超好用的统一API响应结果封装
07-30
超好用的统一API响应结果封装 包含返回成功/失败 里面返回POJO统一为泛型 可以直接拿到项目中使用
统一结果集的封装
z_2588的博客
06-23 303
统一结果集的封装
统一结果封装
Leon_Jinhai_Sun的博客
01-22 524
这里我们用到了一个Result的类，这个用于我们的异步统一返回的结果封装。一般来说，结果里面有几个要素必要的 是否成功，可用code表示（如200表示成功，400表示异常） 结果消息 结果数据 所以可得到封装如下： @Data public class Result implements Serializable { private String code; private String msg; private Object data; public static
通用结果封装
qq_39846607的博客
12-14 246
package cn.pubinfo.display.dto; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; import org.springframework.http.HttpStatus; /** * Created by zck on 2018/3/6. * 通用返回结果封装...
全局统一结果封装
tian830937的专栏
07-20 204
全局统一返回结果的封装处理主要@RestControllerAdvice注解实现 @Configuration @Slf4j public class GlobalResponse { @RestControllerAdvice("xxxx.xxxx.xxxx") static class CommonResultResponseAdvice implements ResponseBodyAdvice<Object> { @Override
企业级统一开发平台解决方案PPT课件.pptx
10-11
企业级统一开发平台解决方案PPT课件主要涵盖了企业软件开发中的关键技术和架构设计，旨在提供一个高效、统一的开发环境，以支持复杂的企业业务需求。以下是该课件中涉及的主要知识点： 1. 平台架构：平台架构由多个...
4a统一安全管理平台解决方案.pdf
10-30
【4A统一安全管理平台解决方案】 4A统一安全管理平台是一种针对移动应用系统，尤其是政府和企业无线应用系统的安全管理解决方案。4A通常指的是认证（Authentication）、授权（Authorization）、审计（Auditing）和...
双活数据中心与灾备解决方案.pptx
10-13
在这个解决方案中，资源整合封装可以将多个数据中心的资源整合到一起，提供一个统一的管理平台，简化了资源的管理和维护。 八、业务连续性解决方案 业务连续性解决方案是指保障业务的连续性和可靠性的解决方案。在...
Sql Server、Mysql数据库统一管理解决方案.pdf
09-19
本文提出了一种针对SqlServer和Mysql数据库进行统一管理的解决方案，目的是解决企业环境中多样化数据库系统的管理难题。在现代化的企业管理中，信息作为数据的载体扮演着至关重要的角色，但企业环境的复杂性导致...
4a统一安全管理平台解决方案.docx
06-04
4A统一安全管理平台解决方案主要关注的是在无线应用系统迅速发展的背景下，如何确保移动应用系统，尤其是政务系统和办公系统的安全性和资源的有效管理。这个平台旨在解决数据保密性、分散管理和成本高昂的问题，通过...
java方法通用返回结果集封装操作
08-24
主要介绍了java方法通用返回结果集封装操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
[SSM]统一结果封装
十八岁讨厌编程的博客
07-22 658
SSM整合以及功能模块开发完成后，接下来，我们在上述案例的基础上分析下有哪些问题需要我们去解决下。首先第一个问题是在Controller层增删改返回给前端的是boolean类型数据在Controller层查询单个返回给前端的是对象在Controller层查询所有返回给前端的是集合对象目前我们就已经有三种数据类型返回给前端，如果随着业务的增长，我们需要返回的数据类型会越来越多。创建结果模型类，封装数据到data属性中封装操作结果到code属性中封装特殊消息到message(msg)属性中}......
统一结果返回封装类
weixin_68967484的博客
06-06 279
基于java的前后端分离项目中，前端获取后端controller层接口返回的JSON格式的数据，并展示出来。通常为了提高代码质量，会将后端返回的数据进行统一的格式处理。修改test方法，返回统一结果。
Spring Boot3统一结果封装
蒾酒的博客
02-10 5124
Spring Boot进行统一结果封装的主要目的是提高开发效率、降低代码重复率，并且提供一致的API响应格式，从而简化前后端交互和错误处理
封装统一返回结果类
zn403的博客
06-16 120
【代码】封装统一返回结果类。
数据结果封装
jasstion的专栏
08-01 150
通常我们需要利用Action返回用户需要的一些信息，当然一些信息可能很简单，但一些信息则会很复杂；现在以一个具体事例来探讨一些复杂信息的封装。 这里所说的封装是针对于Struts标签，是为了Action返回的数据能够更好的，更方便的在用户端得到展示；比如说list,这就是个很好的信息表现方式；因为很多数据标签都为其提供了很好的支持；下面对Action中得到的复杂原始信息封装成最终的L...
Java统一返回结果自动封装组件【Response-boxing】
雨落未成曲的博客
12-05 1129
统一返回结果自动封装组件
Springboot 3封装统一返回结果+全局异常处理
最新发布
桃吱咬咬_的博客
07-13 1371
Springboot 3封装统一返回结果+全局异常处理
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

小白de成长之路

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

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

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

打赏作者

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

抵扣说明：

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

余额充值