From 592d914668698cbdb248ec1de9eb15ed8eec8233 Mon Sep 17 00:00:00 2001 From: maxf Date: Thu, 18 Sep 2025 18:05:58 +0800 Subject: [PATCH] =?UTF-8?q?[update]=201.5.5-jre11=EF=BC=88=E6=9C=AA?= =?UTF-8?q?=E5=8F=91=E5=B8=83=EF=BC=89=201.=20=E5=88=A0=E9=99=A4ApiVO?= =?UTF-8?q?=EF=BC=8C=E6=96=B0=E5=A2=9EResponseVO,ObjectResponseVO,ListResp?= =?UTF-8?q?onseVO=E7=94=A8=E6=9D=A5=E5=A4=84=E7=90=86=E8=BF=94=E5=9B=9E?= =?UTF-8?q?=E5=8F=82=E6=95=B0=202.=20DateConsts=20=E5=A2=9E=E5=8A=A0?= =?UTF-8?q?=E5=B8=B8=E9=87=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- UPDATE.md | 6 + .../com/yexuejc/base/constant/DateConsts.java | 2 + .../java/com/yexuejc/base/pojo/ApiVO.java | 187 ------------------ .../com/yexuejc/base/pojo/ListResponseVO.java | 104 ++++++++++ .../yexuejc/base/pojo/ObjectResponseVO.java | 101 ++++++++++ .../com/yexuejc/base/pojo/ResponseVO.java | 139 +++++++++++++ 6 files changed, 352 insertions(+), 187 deletions(-) delete mode 100644 src/main/java/com/yexuejc/base/pojo/ApiVO.java create mode 100644 src/main/java/com/yexuejc/base/pojo/ListResponseVO.java create mode 100644 src/main/java/com/yexuejc/base/pojo/ObjectResponseVO.java create mode 100644 src/main/java/com/yexuejc/base/pojo/ResponseVO.java diff --git a/UPDATE.md b/UPDATE.md index 014f56b..f1c9c4f 100644 --- a/UPDATE.md +++ b/UPDATE.md @@ -1,5 +1,11 @@ yexuejc-base 更新记录 ------------------ +#### version :1.5.5-jre11 +**time: **
+**branch:** jre11
+**update:**
+1. 删除ApiVO,新增ResponseVO,ObjectResponseVO,ListResponseVO用来处理返回参数 +2. DateConsts 增加常量 #### version :1.5.4-jre11 **time: 2025-8-27 19:45:33**
diff --git a/src/main/java/com/yexuejc/base/constant/DateConsts.java b/src/main/java/com/yexuejc/base/constant/DateConsts.java index 9f30617..16ba549 100644 --- a/src/main/java/com/yexuejc/base/constant/DateConsts.java +++ b/src/main/java/com/yexuejc/base/constant/DateConsts.java @@ -20,4 +20,6 @@ public class DateConsts { public static final String DATE_TIME_MS_PATTERN = "yyyy-MM-dd HH:mm:ss.SSS"; public static final String ISO_8601_PATTERN = "yyyy-MM-dd'T'HH:mm:ssxxx"; public static final String ISO_8601_MS_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSSxxx"; + public static final String DATE_YYYYMMDD_PATTERN = "yyyyMMdd"; + } diff --git a/src/main/java/com/yexuejc/base/pojo/ApiVO.java b/src/main/java/com/yexuejc/base/pojo/ApiVO.java deleted file mode 100644 index a43e1a4..0000000 --- a/src/main/java/com/yexuejc/base/pojo/ApiVO.java +++ /dev/null @@ -1,187 +0,0 @@ -package com.yexuejc.base.pojo; - - -import com.yexuejc.base.util.JsonUtil; -import com.yexuejc.base.util.StrUtil; - -import java.io.Serializable; - -/** - * 接口交互APi - * - * @PackageName: com.mcworle.ecentm.api.user.web.vo - * @Description: - * @author: maxf - * @date: 2018/1/17 11:36 - */ -public class ApiVO implements Serializable { - public ApiVO() { - } - - public ApiVO(STATUS status) { - this.status = status; - } - - /** - * 使用默认返回code - * - * @param status - * @param msg - */ - public ApiVO(STATUS status, String msg) { - this.status = status; - this.msgs = StrUtil.isNotEmpty(msg) ? new String[]{msg} : null; - } - - /** - * 使用默认返回code - * - * @param status - * @param msg - */ - public ApiVO(STATUS status, String[] msg) { - this.status = status; - this.msgs = msg; - } - - public ApiVO(STATUS status, String code, String msg) { - this.status = status; - this.code = code; - this.msgs = StrUtil.isNotEmpty(msg) ? new String[]{msg} : null; - } - - public ApiVO(STATUS status, String code, String[] msg) { - this.status = status; - this.code = code; - this.msgs = msg; - } - - public ApiVO setStatus(STATUS status, String code, String msg) { - this.status = status; - this.code = code; - this.msgs = StrUtil.isNotEmpty(msg) ? new String[]{msg} : null; - return this; - } - - public ApiVO setStatus(STATUS status, String code, String[] msg) { - this.status = status; - this.code = code; - this.msgs = msg; - return this; - } - - public enum STATUS { - /** - * 成功 - */ - S, - /** - * 失败 - */ - F, - /** - * 错误 - */ - E - } - - /** - * 状态 - */ - private STATUS status = STATUS.S; - /** - * code - */ - private String code; - /** - * 消息 - */ - private String[] msgs; - - - /** - * 值1 - */ - private Object object1; - /** - * 值2 - */ - private Object object2; - - public ApiVO setObject1(T obj) { - object1 = obj; - return this; - } - - public T getObject1(Class clazz) { - return (T) object1; - } - - public ApiVO setObject2(T obj) { - object2 = obj; - return this; - } - - public T getObject2(Class clazz) { - return (T) object2; - } - - public boolean isSucc() { - if (STATUS.S.name().equals(status.name())) { - return true; - } - return false; - } - - public boolean isErr() { - if (STATUS.E.name().equals(status.name())) { - return true; - } - return false; - } - - public ApiVO setMsg(String msg) { - this.msgs = StrUtil.isNotEmpty(msg) ? new String[]{msg} : null; - return this; - } - - public boolean isFail() { - return !isSucc(); - } - - public String getCode() { - return code; - } - - public ApiVO setCode(String code) { - this.code = code; - return this; - } - - @Override - public String toString() { - return JsonUtil.obj2Json(this); - } - - public STATUS getStatus() { - return status; - } - - public ApiVO setStatus(STATUS status) { - this.status = status; - return this; - } - - public ApiVO setMsgs(String[] msgs) { - this.msgs = msgs; - return this; - } - - public String[] getMsgs() { - return msgs; - } - - public String getMsg() { - return msgs == null ? "" : msgs[0]; - } -} diff --git a/src/main/java/com/yexuejc/base/pojo/ListResponseVO.java b/src/main/java/com/yexuejc/base/pojo/ListResponseVO.java new file mode 100644 index 0000000..e412191 --- /dev/null +++ b/src/main/java/com/yexuejc/base/pojo/ListResponseVO.java @@ -0,0 +1,104 @@ +package com.yexuejc.base.pojo; + +import java.util.List; + +import com.yexuejc.base.constant.SymbolicConsts; + + +/** + * API結果が戻りする、集合型 + * + * @author ISC + * @date 2023/08/18 + */ + +public class ListResponseVO extends ResponseVO { + + private List data; + + public ListResponseVO() { + super(); + } + + public ListResponseVO(List data) { + this.data = data; + setMessage(SymbolicConsts.EMPTY); + setCode(Codes.SUCCESS.code); + } + + public ListResponseVO(List data, String code, String msg) { + super(code, msg); + this.data = data; + } + + public List getData() { + return data; + } + + public ListResponseVO setData(List data) { + this.data = data; + return this; + } + + /** + * 创建成功结果 + * @param data + * @return + * @param + */ + public static ListResponseVO success(List data) { + return new ListResponseVO<>(data); + } + + /** + * 创建失败并设定message,默认code + * @param message + * @return + */ + public static ListResponseVO fail(String message) { + ListResponseVO vo = new ListResponseVO<>(); + vo.setCode(Codes.SYSTEM_ERROR.code).setMessage(message); + return vo; + } + + /** + * 创建失败并设定message,code + * @param errorCode + * @param message + * @return + */ + public static ListResponseVO fail(String errorCode, String message) { + ListResponseVO vo = new ListResponseVO<>(); + vo.setCode(errorCode).setMessage(message); + return vo; + } + + @Override + public ListResponseVO setCode(String code) { + super.setCode(code); + return this; + } + + @Override + public ListResponseVO setMessage(String message) { + super.setMessage(message); + return this; + } + + @Override + public ListResponseVO setBizCode(String errCode) { + super.setBizCode(errCode); + return this; + } + + @Override + public ListResponseVO setBizMessage(String errCodeDes) { + super.setBizMessage(errCodeDes); + return this; + } + + @Override + public String toString() { + return super.toString(); + } +} diff --git a/src/main/java/com/yexuejc/base/pojo/ObjectResponseVO.java b/src/main/java/com/yexuejc/base/pojo/ObjectResponseVO.java new file mode 100644 index 0000000..165aaf5 --- /dev/null +++ b/src/main/java/com/yexuejc/base/pojo/ObjectResponseVO.java @@ -0,0 +1,101 @@ +package com.yexuejc.base.pojo; + + +import com.yexuejc.base.constant.SymbolicConsts; + +/** + * API結果が戻りする、対象型 + * + * @author ISC + * @date 2023/08/18 + */ +public class ObjectResponseVO extends ResponseVO { + + private T data; + + public ObjectResponseVO() { + } + + public ObjectResponseVO(T data) { + this.data = data; + setMessage(SymbolicConsts.EMPTY); + setCode(Codes.SUCCESS.code); + } + + public ObjectResponseVO(T data, String code, String msg) { + super(code, msg); + this.data = data; + } + + + public T getData() { + return data; + } + + public ObjectResponseVO setData(T data) { + this.data = data; + return this; + } + + /** + * 创建成功结果 + * @param data + * @return + * @param + */ + public static ObjectResponseVO success(T data) { + return new ObjectResponseVO<>(data); + } + + /** + * 创建失败并设定message,默认code + * @param message + * @return + */ + public static ObjectResponseVO fail(String message) { + ObjectResponseVO vo = new ObjectResponseVO<>(); + vo.setCode(Codes.SYSTEM_ERROR.code).setMessage(message); + return vo; + } + + /** + * 创建失败并设定message,code + * @param errorCode + * @param message + * @return + */ + public static ObjectResponseVO fail(String errorCode, String message) { + ObjectResponseVO vo = new ObjectResponseVO<>(); + vo.setCode(errorCode).setMessage(message); + return vo; + } + + @Override + public ObjectResponseVO setCode(String code) { + super.setCode(code); + return this; + } + + @Override + public ObjectResponseVO setMessage(String message) { + super.setMessage(message); + return this; + } + + @Override + public ObjectResponseVO setBizCode(String bizCode) { + super.setBizCode(bizCode); + return this; + } + + @Override + public ObjectResponseVO setBizMessage(String bizMessage) { + super.setBizMessage(bizMessage); + return this; + } + + @Override + public String toString() { + return super.toString(); + } +} diff --git a/src/main/java/com/yexuejc/base/pojo/ResponseVO.java b/src/main/java/com/yexuejc/base/pojo/ResponseVO.java new file mode 100644 index 0000000..7ffe9b4 --- /dev/null +++ b/src/main/java/com/yexuejc/base/pojo/ResponseVO.java @@ -0,0 +1,139 @@ +package com.yexuejc.base.pojo; + +import java.io.Serializable; + +import com.yexuejc.base.constant.SymbolicConsts; + +/** + * API結果が戻りする + * + * @author ISC + * @date 2023/08/18 + */ +public class ResponseVO implements Serializable { + + public static enum Codes { + /** 处理成功 */ SUCCESS("S"), + /** 处理失败 */ FAIL("F"), + /** 系统异常 */ SYSTEM_ERROR("E"); + + public final String code; + + Codes(String code) { + this.code = code; + } + + } + + /** 请求code */ + private String code; + + /** 请求消息 */ + private String message; + + /** 业务异常 */ + private String bizCode; + + /** 业务异常 */ + private String bizMessage; + + public ResponseVO() { + } + + public ResponseVO(String code, String msg) { + this.code = code; + this.message = msg; + } + + public String getCode() { + return code; + } + + public ResponseVO setCode(String code) { + this.code = code; + return this; + } + + public String getMessage() { + return message; + } + + public ResponseVO setMessage(String message) { + this.message = message; + return this; + } + + public String getBizCode() { + return bizCode; + } + + public ResponseVO setBizCode(String bizCode) { + this.bizCode = bizCode; + return this; + } + + public String getBizMessage() { + return bizMessage; + } + + public ResponseVO setBizMessage(String bizMessage) { + this.bizMessage = bizMessage; + return this; + } + + /** + * 单纯成功 + * + * @return + */ + public static ResponseVO success() { + return new ResponseVO(Codes.SUCCESS.code, SymbolicConsts.EMPTY); + } + + /** + * 成功并自定义message + * + * @param message + * @return + */ + public static ResponseVO success(String message) { + return new ResponseVO(Codes.SUCCESS.code, message); + } + + /** + * 处理失败 默认 code + * + * @param message + * @return + */ + public static ResponseVO fail(String message) { + return new ResponseVO(Codes.SYSTEM_ERROR.code, message); + } + + /** + * 处理失败,只定义 code + * + * @param errorCode + * @return + */ + public static ResponseVO fail4Code(String errorCode) { + return new ResponseVO(errorCode, SymbolicConsts.EMPTY); + } + + + /** + * 处理失败,定义 code 和 message + * + * @param errorCode + * @param message + * @return + */ + public static ResponseVO fail(String errorCode, String message) { + return new ResponseVO(errorCode, message); + } + + @Override + public String toString() { + return super.toString(); + } +}