Java实战 - 结果集封装

一. ResponseResult

package com.example.vo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.http.HttpStatus;

import java.io.Serializable;

/**
 * @author :zhangbocong
 * @version :V1.0
 * @program :spring_boot_demo
 * @date :Created in 2021年1月15日 10:40
 * @description : 响应客户端工具类
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ResponseResult<T> implements Serializable {
    /**
     * 序列化时为了保持版本的兼容性,即在版本升级时反序列化保持对象的唯一性
     */
    private static final long serialVersionUID = -8145865776285690954L;

    /**
     * 状态码
     */
    private int code;

    /**
     * 消息描述
     */
    private String message;

    /**
     * 返回内容
     */
    private T data;

    /**
     * 有参构造函数
     */
    public ResponseResult(int code, String message) {
        this.code = code;
        this.message = message;
    }

    /**
     * 响应结果成功
     * 返回状态码和描述,data为null
     */
    public static <T> ResponseResult<T> success(){
        return new ResponseResultBuilder<T>(HttpStatus.OK.value(),
                                               HttpStatus.OK.getReasonPhrase()).build();
    }

    /**
     * 响应结果成功
     * 返回状态码、描述和结果集
     */
    public static <T> ResponseResult<T> success(T data){
        return new ResponseResultBuilder<T>(HttpStatus.OK.value(),
                                     HttpStatus.OK.getReasonPhrase()).setData(data).build();
    }

    /**
     * 响应结果错误
     * 返回状态码和描述,data为null
     */
    public static <T> ResponseResult<T> error() {
        return new ResponseResultBuilder<T>(110, "系统异常").build();
    }

    /**
     * 响应结果错误
     * 返回状态码和描述,data为null
     */
    public static <T> ResponseResult<T> error(int code, String message) {
        return new ResponseResultBuilder<T>(code, message).build();
    }
}

二. ResponseResultBuilder

package com.example.vo;

import lombok.Data;
import org.springframework.http.HttpStatus;

/**
 * @author :zhangbocong
 * @version :V1.0
 * @program :spring_boot_demo
 * @date :Created in 2021年1月15日
 * @description : ResponseResult 建设者
 */
@Data
public class ResponseResultBuilder<T> {
    private int code = HttpStatus.OK.value();
    private String message = HttpStatus.OK.getReasonPhrase();
    private T data;

    /**
     * 无参构造函数
     */
    public ResponseResultBuilder() {
        super();
    }

    /**
     * 有参构造函数
     * @param code    响应码
     * @param message 响应消息
     */
    public ResponseResultBuilder(int code, String message) {
        super();
        this.code = code;
        this.message = message;
    }

    public ResponseResultBuilder<T> setCode(int code) {
        this.code = code;
        return this;
    }

    public ResponseResultBuilder<T> setData(T data) {
        this.data = data;
        return this;
    }

    public ResponseResultBuilder<T> setMessage(String message) {
        this.message = message;
        return this;
    }

    /**
     * 返回带状态码、描述、数据的方法
     *
     * @return 默认响应体
     */
    public ResponseResult build() {
        return new ResponseResult<>(code, message, data);
    }

}

三. 测试

public static void main(String[] args){
    System.out.println(ResponseResult.error());
    System.out.println(ResponseResult.error(10010,"请求参数错误"));
    System.out.println(ResponseResult.success());
    System.out.println(ResponseResult.success("数据结果集"));
}
输出:

四. 配合枚举使用

  • 创建枚举类
package com.example.vo;

import lombok.Getter;
import org.springframework.http.HttpStatus;

/**
 * @author :zhangbocong
 * @version :V1.0
 * @program :spring_boot_demo
 * @date :Created in 2021年1月15日 15:33
 * @description :Http 响应状态码枚举类,便于出错时能快速准确定位问题,同时也是为了向开发人员传递一些暗语(出于系统安全的考虑,系统级或服务级的错误是不能直接返回给客户端)
 *  异常编码统一格式:AA-B-CCC
 *  A:两位AA代表项目编码,第一为顶级项编码, 第二位子项目编码,两位都采用1-9个数字表示,如果没有子项目默认使用0表示,如:10
 *  目前项目简码:
 *  10 --> System main platform 系统主平台
 *  20 --> Project System 项目子系统
 *  30 --> Finance System 财务子系统
 *  40 --> Warehouse System 库存子系统
 *  50 --> Service System 后台服务子系统
 *  当前项目简码:10
 *  B:错误级别,1代表系统错误,5代表服务级错误,4代表客户端错误;
 *  系统错误:是指由于系统不稳定导致的错误,常见原因是由于硬件故障导致的异常,如网络异常,IO异常,驱动加载失败,内存溢出,文件占用,
 *  接口超时等等,这些错误一般都不能直接向客户端返回真实原因,需要通过友情提示让客户重试或联系管理员。
 *  服务错误:是指由于服务端逻辑错误引发的错误。如脏数据引发的数据不一致或数据错误,
 *  客户端错误:是指由于客户端传参不正确引起的错误,常见的有参数类型错误,参数为空,非法如入参等等。
 *  C:具体错误编号,自增即可,一个项目999种错误应该够用,不够三位,用零补齐
 */
@Getter
public enum HttpStatusEnums {
    /*
     * 响应成功状态码
     */
    SUCCESS(HttpStatus.OK.value(), "成功"),

    /*
     * 系统级错误,以前缀SYS_ERR_开头
     */
    SYS_ERR_OUT_OF_HEAP(101001, "堆内存溢出"),

    /*
     * 服务级错误,以前缀SER_ERR_开头
     */
    SER_ERR_DATA_INCONSISTENT(105001, "系统内数据不一致异常"),

    /*
     * 客户端错误,以前缀CLI_ERR_开头
     */
    CLI_ERR_EMPTY_PARAM(104001, "请求参数为空");


    /**
     * 错误编码
     */
    private final int code;

    /**
     * 错误描述
     */
    private final String msg;

    HttpStatusEnums(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

五. 调用枚举测试

public static void main(String[] args){
    System.out.println(ResponseResult.error(HttpStatusEnums.CLI_ERR_EMPTY_PARAM.getCode(),
                                                HttpStatusEnums.CLI_ERR_EMPTY_PARAM.getMsg()));
}
输出: