也称为DTO(Data Transfer Object)，将返回的结果统一通过一个包装类来返回，可以包括状态码code，描述信息msg，和返回的对象data。这里的data可以使用泛型来表示。

示例1

  1. import lombok.Data;
  3. /**
  4.  * @author zhanghuiwen
  5.  * http返回值
  6.  */
  7. @Data
  8. public class Result<T> {
  10.     public Result(boolean success, int code) {
  11.         this.setSuccess(success);
  12.         this.setCode(code);
  13.     }
  15.     public Result(boolean success, int code, T data) {
  16.         this.setSuccess(success);
  17.         this.setCode(code);
  18.         this.setData(data);
  19.     }
  21.     public Result(boolean success, int code, String msg) {
  22.         this.setSuccess(success);
  23.         this.setCode(code);
  24.         this.setData(data);
  25.     }
  28.     /**
  29.      * 请求是否成功
  30.      * true:成功
  31.      * false：失败
  32.      */
  33.     private boolean success;
  35.     /**
  36.      * 状态码
  37.      * 成功：200
  38.      * 失败：其他
  39.      */
  40.     private int code;
  42.     /**
  43.      * 失败状态码描述
  44.      * 如果成功不返回
  45.      * 失败返回状态码对应的msg消息
  46.      */
  47.     private String msg;
  49.     /**
  50.      * 请求数据的结果
  51.      */
  52.     private T data;
  55.     public static <T> Result<T> success() {
  56.         return new Result<T>(true, 200);
  57.     }
  59.     public static <T> Result<T> success(T data) {
  60.         return new Result<T>(true, 200, data);
  61.     }
  64.     public static <T> Result<T> fail(HttpStatusEnum httpStatusEnum) {
  65.         return new Result<T>(false, httpStatusEnum.code(), httpStatusEnum.reasonPhraseUS());
  66.     }
  68.     public static <T> Result<T> fail(HttpStatusEnum httpStatusEnum, String msg) {
  69.         return new Result<T>(false, httpStatusEnum.code(), msg);
  70.     }
  73. }

这里还需要配合一个枚举类

  1. /**
  2. * http所有状态码枚举
  3. */
  4. public enum HttpStatusEnum {
  5.     /**
  6.     * http状态码枚举所有状态码注解
  7.     */
  8.     CONTINUE(100, "Continue", "请继续发送请求的剩余部分"),
  9.     SWITCHING_PROTOCOLS(101, "Switching Protocols", "协议切换"),
  10.     PROCESSING(102, "Processing", "请求将继续执行"),
  11.     CHECKPOINT(103, "Checkpoint", "可以预加载"),
  12.     OK(200, "OK", "请求已经成功处理"),
  13.     CREATED(201, "Created", "请求已经成功处理，并创建了资源"),
  14.     ACCEPTED(202, "Accepted", "请求已经接受，等待执行"),
  15.     NON_AUTHORITATIVE_INFORMATION(203, "Non-Authoritative Information", "请求已经成功处理，但是信息不是原始的"),
  16.     NO_CONTENT(204, "No Content", "请求已经成功处理，没有内容需要返回"),
  17.     RESET_CONTENT(205, "Reset Content", "请求已经成功处理，请重置视图"),
  18.     PARTIAL_CONTENT(206, "Partial Content", "部分Get请求已经成功处理"),
  19.     MULTI_STATUS(207, "Multi-Status", "请求已经成功处理，将返回XML消息体"),
  20.     ALREADY_REPORTED(208, "Already Reported", "请求已经成功处理，一个DAV的绑定成员被前一个请求枚举，并且没有被再一次包括"),
  21.     IM_USED(226, "IM Used", "请求已经成功处理，将响应一个或者多个实例"),
  22.     MULTIPLE_CHOICES(300, "Multiple Choices", "提供可供选择的回馈"),
  23.     MOVED_PERMANENTLY(301, "Moved Permanently", "请求的资源已经永久转移"),
  24.     FOUND(302, "Found", "请重新发送请求"),
  25.     // MOVED_TEMPORARILY(302, "Moved Temporarily", "") 已经过时
  26.     SEE_OTHER(303, "See Other", "请以Get方式请求另一个URI"),
  27.     NOT_MODIFIED(304, "Not Modified", "资源未改变"),
  28.     USE_PROXY(305, "Use Proxy", "请通过Location域中的代理进行访问"),
  29.     // 306在新版本的规范中被弃用
  30.     TEMPORARY_REDIRECT(307, "Temporary Redirect", "请求的资源临时从不同的URI响应请求"),
  31.     RESUME_INCOMPLETE(308, "Resume Incomplete", "请求的资源已经永久转移"),
  32.     BAD_REQUEST(400, "Bad Request", "请求错误，请修正请求"),
  33.     UNAUTHORIZED(401, "Unauthorized", "没有被授权或者授权已经失效"),
  34.     PAYMENT_REQUIRED(402, "Payment Required", "预留状态"),
  35.     FORBIDDEN(403, "Forbidden", "请求被理解，但是拒绝执行"),
  36.     NOT_FOUND(404, "Not Found", "资源未找到"),
  37.     METHOD_NOT_ALLOWED(405, "Method Not Allowed", "请求方法不允许被执行"),
  38.     NOT_ACCEPTABLE(406, "Not Acceptable", "请求的资源不满足请求者要求"),
  39.     PROXY_AUTHENTICATION_REQUIRED(407, "Proxy Authentication Required", "请通过代理进行身份验证"),
  40.     REQUEST_TIMEOUT(408, "Request Timeout", "请求超时"),
  41.     CONFLICT(409, "Conflict", "请求冲突"),
  42.     GONE(410, "Gone", "请求的资源不可用"),
  43.     LENGTH_REQUIRED(411, "Length Required", "Content-Length未定义"),
  44.     PRECONDITION_FAILED(412, "Precondition Failed", "不满足请求的先决条件"),
  45.     REQUEST_ENTITY_TOO_LARGE(413, "Request Entity Too Large", "请求发送的实体太大"),
  46.     REQUEST_URI_TOO_LONG(414, "Request-URI Too Long", "请求的URI超长"),
  47.     UNSUPPORTED_MEDIA_TYPE(415, "Unsupported Media Type", "请求发送的实体类型不受支持"),
  48.     REQUESTED_RANGE_NOT_SATISFIABLE(416, "Requested range not satisfiable", "Range指定的范围与当前资源可用范围不一致"),
  49.     EXPECTATION_FAILED(417, "Expectation Failed", "请求头Expect中指定的预期内容无法被服务器满足"),
  50.     // I_AM_A_TEAPOT(418, "I'm a teapot", ""), 该代码没有被服务器实现
  52.     // INSUFFICIENT_SPACE_ON_RESOURCE(419, "Insufficient Space On Resource", ""),  已经过时
  54.     // METHOD_FAILURE(420, "Method Failure", ""),  已经过时
  56.     // DESTINATION_LOCKED(421, "Destination Locked", ""),  已经过时
  57.     UNPROCESSABLE_ENTITY(422, "Unprocessable Entity", "请求格式正确，但是由于含有语义错误，无法响应"),
  58.     LOCKED(423, "Locked", "当前资源被锁定"),
  59.     FAILED_DEPENDENCY(424, "Failed Dependency", "由于之前的请求发生错误，导致当前请求失败"),
  60.     UPGRADE_REQUIRED(426, "Upgrade Required", "客户端需要切换到TLS1.0"),
  61.     PRECONDITION_REQUIRED(428, "Precondition Required", "请求需要提供前置条件"),
  62.     TOO_MANY_REQUESTS(429, "Too Many Requests", "请求过多"),
  63.     REQUEST_HEADER_FIELDS_TOO_LARGE(431, "Request Header Fields Too Large", "请求头超大，拒绝请求"),
  64.     INTERNAL_SERVER_ERROR(500, "Internal Server Error", "服务器内部错误"),
  65.     NOT_IMPLEMENTED(501, "Not Implemented", "服务器不支持当前请求的部分功能"),
  66.     BAD_GATEWAY(502, "Bad Gateway", "响应无效"),
  67.     SERVICE_UNAVAILABLE(503, "Service Unavailable", "服务器维护或者过载，拒绝服务"),
  68.     GATEWAY_TIMEOUT(504, "Gateway Timeout", "上游服务器超时"),
  69.     HTTP_VERSION_NOT_SUPPORTED(505, "HTTP Version not supported", "不支持的HTTP版本"),
  70.     VARIANT_ALSO_NEGOTIATES(506, "Variant Also Negotiates", "服务器内部配置错误"),
  71.     INSUFFICIENT_STORAGE(507, "Insufficient Storage", "服务器无法完成存储请求所需的内容"),
  72.     LOOP_DETECTED(508, "Loop Detected", "服务器处理请求时发现死循环"),
  73.     BANDWIDTH_LIMIT_EXCEEDED(509, "Bandwidth Limit Exceeded", "服务器达到带宽限制"),
  74.     NOT_EXTENDED(510, "Not Extended", "获取资源所需的策略没有被满足"),
  75.     NETWORK_AUTHENTICATION_REQUIRED(511, "Network Authentication Required", "需要进行网络授权");
  77.     private final int code;
  78.     private final String reasonPhraseUS;
  79.     private final String reasonPhraseCN;
  81.     private static final int
  82.         INFORMATIONAL = 1,
  83.     SUCCESSFUL = 2,
  84.     REDIRECTION = 3,
  85.     CLIENT_ERROR = 4,
  86.     SERVER_ERROR = 5;
  88.     HttpStatusEnum(int code, String reasonPhraseUS, String reasonPhraseCN) {
  89.         this.code = code;
  90.         this.reasonPhraseUS = reasonPhraseUS;
  91.         this.reasonPhraseCN = reasonPhraseCN;
  92.     }
  94.     public int code() {
  95.         return code;
  96.     }
  98.     public String reasonPhraseUS() {
  99.         return reasonPhraseUS;
  100.     }
  102.     public String reasonPhraseCN() {
  103.         return reasonPhraseCN;
  104.     }
  106.     public static HttpStatusEnum valueOf(int code) {
  107.         for (HttpStatusEnum httpStatus : values()) {
  108.             if (httpStatus.code() == code) {
  109.                 return httpStatus;
  110.             }
  111.         }
  112.         throw new IllegalArgumentException("No matching constant for [" + code + "]");
  113.     }
  115.     public boolean is1xxInformational() {
  116.         return type() == INFORMATIONAL;
  117.     }
  119.     public boolean is2xxSuccessful() {
  120.         return type() == SUCCESSFUL;
  121.     }
  123.     public boolean is3xxRedirection() {
  124.         return type() == REDIRECTION;
  125.     }
  127.     public boolean is4xxClientError() {
  128.         return type() == CLIENT_ERROR;
  129.     }
  131.     public boolean is5xxServerError() {
  132.         return type() == SERVER_ERROR;
  133.     }
  135.     private int type() {
  136.         return (int) code / 100;
  137.     }
  138. }

示例2

  1. package com.learn.utils;
  3. import com.fasterxml.jackson.annotation.JsonIgnore;
  4. import com.fasterxml.jackson.databind.ObjectMapper;
  6. /**
  7.  * 
  8.  * @Title: JSONResult.java
  9.  * @Package com.learn.utils
  10.  * @Description: 自定义响应数据结构
  11.  *                 本类可提供给 H5/ios/安卓/公众号/小程序 使用
  12.  *                 前端接受此类数据（json object)后，可自行根据业务去实现相关功能
  13.  * 
  14.  *                 200：表示成功
  15.  *                 500：表示错误，错误信息在msg字段中
  16.  *                 501：bean验证错误，不管多少个错误都以map形式返回
  17.  *                 502：拦截器拦截到用户token出错
  18.  *                 555：异常抛出信息
  19.  *                 556: 用户qq校验异常
  21.  * @version V1.0
  22.  */
  23. public class JSONResult {
  25.     // 定义jackson对象
  26.     private static final ObjectMapper MAPPER = new ObjectMapper();
  28.     // 响应业务状态
  29.     private Integer status;
  31.     // 响应消息
  32.     private String msg;
  34.     // 响应中的数据
  35.     private Object data;
  37.     @JsonIgnore
  38.     private String ok;    // 不使用
  40.     public static JSONResult build(Integer status, String msg, Object data) {
  41.         return new JSONResult(status, msg, data);
  42.     }
  44.     public static JSONResult build(Integer status, String msg, Object data, String ok) {
  45.         return new JSONResult(status, msg, data, ok);
  46.     }
  48.     public static JSONResult ok(Object data) {
  49.         return new JSONResult(data);
  50.     }
  52.     public static JSONResult ok() {
  53.         return new JSONResult(null);
  54.     }
  56.     public static JSONResult errorMsg(String msg) {
  57.         return new JSONResult(500, msg, null);
  58.     }
  60.     public static JSONResult errorMap(Object data) {
  61.         return new JSONResult(501, "error", data);
  62.     }
  64.     public static JSONResult errorTokenMsg(String msg) {
  65.         return new JSONResult(502, msg, null);
  66.     }
  68.     public static JSONResult errorException(String msg) {
  69.         return new JSONResult(555, msg, null);
  70.     }
  72.     public static JSONResult errorUserQQ(String msg) {
  73.         return new JSONResult(556, msg, null);
  74.     }
  76.     public JSONResult() {
  78.     }
  80.     public JSONResult(Integer status, String msg, Object data) {
  81.         this.status = status;
  82.         this.msg = msg;
  83.         this.data = data;
  84.     }
  86.     public JSONResult(Integer status, String msg, Object data, String ok) {
  87.         this.status = status;
  88.         this.msg = msg;
  89.         this.data = data;
  90.         this.ok = ok;
  91.     }
  93.     public JSONResult(Object data) {
  94.         this.status = 200;
  95.         this.msg = "OK";
  96.         this.data = data;
  97.     }
  99.     public Boolean isOK() {
  100.         return this.status == 200;
  101.     }
  103.     public Integer getStatus() {
  104.         return status;
  105.     }
  107.     public void setStatus(Integer status) {
  108.         this.status = status;
  109.     }
  111.     public String getMsg() {
  112.         return msg;
  113.     }
  115.     public void setMsg(String msg) {
  116.         this.msg = msg;
  117.     }
  119.     public Object getData() {
  120.         return data;
  121.     }
  123.     public void setData(Object data) {
  124.         this.data = data;
  125.     }
  127.     public String getOk() {
  128.         return ok;
  129.     }
  131.     public void setOk(String ok) {
  132.         this.ok = ok;
  133.     }
  135. }

示例3

  1. package com.learn.videoservice.dto;
  3. import lombok.Data;
  6. /**
  7.  * 用于封装返回类型
  8.  * @author wujinhao
  9.  * @param <T>
  10.  */
  11. @Data
  12. public class ResponseObject<T> {
  13.     private String  code;
  14.     private String msg;
  15.     private T object;
  17.     public ResponseObject(T... data) {
  19.         this.code = "200";
  20.         this.msg = "成功";
  21.         if (data.length>0){
  22.             this.object = data[0];
  23.         }
  24.     }
  26.     /**
  27.      * 仅返回code和msg
  28.      * @param code
  29.      * @param msg
  30.      */
  31.     public ResponseObject(String  code, String msg){
  32.         this.code=code;
  33.         this.msg = msg;
  34.     }
  36.     /**
  37.      * 返回全部
  38.      * @param code
  39.      * @param msg
  40.      * @param object
  41.      */
  42.     public ResponseObject(String  code, String msg, T object) {
  43.         this.code = code;
  44.         this.msg = msg;
  45.         this.object = object;
  46.     }
  47. }