《历史代码分析》2、接口结果封装

​

​
本系列《历史代码分析》为工作中遇到具有代表性的代码，已做脱敏处理。今天我们讲一下接口结果封装，制定统一结构的接口返回结果，便于和前端快速对接。
代码如下：

1. package tech.xueyao.common;
4. import tech.xueyao.contant.enums.ResponseStatus;
5. import java.io.Serializable;
7. public class BaseResponse implements Serializable {
9.         private Integer code = 10000;
10.         private String msg = "操作完成";
11.         private Object data;
13.         public Integer getCode() {
14.                 return code;
15.         }
17.         public void setCode(Integer code) {
18.                 this.code = code;
19.         }
21.         public String getMsg() {
22.                 return msg;
23.         }
25.         public void setMsg(String msg) {
26.                 this.msg = msg;
27.         }
29.         public Object getData() {
30.                 return data;
31.         }
33.         public void setData(Object data) {
34.                 this.data = data;
35.         }
37.         public void setStatus(ResponseStatus status) {
38.                 this.code = status.code();
39.                 this.msg = status.msg();
40.         }
42.         public BaseResponse(Integer code, String msg) {
43.                 this.code = code;
44.                 this.msg = msg;
45.         }
47.         public BaseResponse(ResponseStatus status) {
48.                 this.code = status.code();
49.                 this.msg = status.msg();
50.         }
52.         public BaseResponse(Integer code, String msg,Object data) {
53.                 this.code = code;
54.                 this.msg = msg;
55.                 this.data=data;
56.         }
58.         public BaseResponse() {
59.         }
60. }

复制代码

以下是对这段 Java 代码的分析：
1. 代码概述

这段代码定义了一个名为 BaseResponse​ 的基础类，它是一个通用的响应类，用于封装接口返回的结果。
2. 成员变量

1. private Integer code = 10000;
2. private String msg = "操作完成";
3. private Object data;

复制代码

• ​code​：表示响应的状态码，默认为 10000​，。
  
• ​msg​：表示响应的消息，默认为 "操作完成"，错误信息也放在这个变量中。
  
• ​data​：表示响应返回的数据，定义为 Object​，可以是任意类型的数据。
  

3. 构造函数

1. public BaseResponse(Integer code, String msg) {
2.     this.code = code;
3.     this.msg = msg;
4. }
6. public BaseResponse(ResponseStatus status) {
7.     this.code = status.code();
8.     this.msg = status.msg();
9. }
11. public BaseResponse(Integer code, String msg, Object data) {
12.     this.code = code;
13.     this.msg = msg;
14.     this.data = data;
15. }
17. public BaseResponse() {
18. }

复制代码

• 提供了多个构造函数，可以创建不同参数的 BaseResponse​ 对象：
  
  
  
  • ​BaseResponse(Integer code, String msg)​：通过状态码和消息创建对象。
    
  • ​BaseResponse(ResponseStatus status)​：通过 ResponseStatus​ 枚举类创建对象。
    
  • ​BaseResponse(Integer code, String msg, Object data)​：通过状态码、消息和数据创建对象。
    
  • ​BaseResponse()​：无参构造函数，使用默认的状态码和消息。
    
  
  

4. 总结

​BaseResponse​ 类是一个通用的响应类，提高了代码的可读性。同时，使用 ResponseStatus​ 枚举类来管理响应状态。
补充

ResponseStatus代码如下：

1. package tech.xueyao.contant.enums;
4. public enum ResponseStatus {
5.         SUCCESS(10000, "成功"),
6.         INVALID_SIGNATURE(20002, "无效签名"),
7.         SEND_SMS_MAXIMUM(20003, "短信发送次数达到上限"),
8.         SEND_SMS_FAIL(20004,"短信发送失败"),
9.     BAD_REQUEST(40000,"请求有误"),
10.         BADPARAM(40001, "参数错误"),
11.         UNAUTHORIZED(40401, "用户未身份认证"),
12.         NO_PERMISSION(40403, "没有接口权限"),
13.         NO_PERMISSION_DATE(40404, "没有接口数据权限"),
14.     NOT_FOUND(40404,"您所访问的资源不存在"),
15.     Method_NOT_ALLOWED(40405,"方法不被允许"),
16.         EXCEPTION(50000, "业务处理失败，请稍后再试");
18.         Integer code;
19.         String msg;
21.         ResponseStatus(Integer code, String msg) {
22.                 this.code = code;
23.                 this.msg = msg;
24.         }
26.         public Integer code() {
27.                 return this.code;
28.         }
30.         public String msg() {
31.                 return this.msg;
32.         }
33. }

复制代码

如果返回的结果涉及到分页，我们可以使用下面这个类：

1. package tech.xueyao.common;
3. import tech.xueyao.contant.enums.ResponseStatus;
5. public class PageResponse extends BaseResponse {
6.     private int pageIndex;//当前页数
7.     private int pageSize;//分页条数
8.     private long count;//总条数
10.     public PagedResponse() {
11.     }
13.     public PagedResponse(ResponseStatus responseStatus) {
14.         super(responseStatus);
15.     }
17.     public int getPageIndex() {
18.         return pageIndex;
19.     }
21.     public void setPageIndex(int pageIndex) {
22.         this.pageIndex = pageIndex;
23.     }
25.     public int getPageSize() {
26.         return pageSize;
27.     }
29.     public void setPageSize(int pageSize) {
30.         this.pageSize = pageSize;
31.     }
33.     public long getCount() {
34.         return count;
35.     }
37.     public void setCount(long count) {
38.         this.count = count;
39.     }
40. }

复制代码

‍

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！