统一响应实体

最新推荐文章于 2023-08-11 16:39:19 发布

loop.fu

最新推荐文章于 2023-08-11 16:39:19 发布

阅读量246

点赞数

分类专栏：分布式系统设计文章标签： restful java

本文链接：https://blog.csdn.net/qq_21683643/article/details/120784168

版权

本文探讨了在RESTful API设计中如何实现统一的响应实体，以提高接口的规范性和易用性。通过定义标准的状态码，确保客户端能够清晰地理解服务器的返回信息。

摘要由CSDN通过智能技术生成

统一响应实体

import java.io.Serializable;

/**
 * 统一响应实体
 * <p>
 * <br/>
 * 格式如下
 *
 * <pre>
 * {
 *     "content": "自定义业务Response",
 *     "message": "操作成功",
 *     "state": 1,
 *     "uiMessage": "自定义消息，用于前端显示"
 * }
 * </pre>
 */
public class ResponseResult<T> implements Serializable {
   

    private static final long serialVersionUID = 1L;

    /**
     * 操作状态
     */
    private int code;

    /**
     * 状态附加消息
     */
    private String msg;

    /**
     * 响应内容
     */
    private T data;

    public ResponseResult() {
   
    }

    public ResponseResult(int code, String msg, T data) {
   
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public static <T> ResponseResult<T> response(int code, String msg, T data) {
   
        ResponseResult<T> responseDTO = new ResponseResult<>();
        responseDTO.setCode(code);
        responseDTO.setMsg(msg);
        responseDTO.setData(data);
        return responseDTO;
    }

    public static