diff --git a/LOG.md b/LOG.md index 9204cf4..d0ae676 100644 --- a/LOG.md +++ b/LOG.md @@ -8,6 +8,9 @@ :star: New Features - 新增 Boolean 结果类型响应类:`BooleanResponse` +- `com.fengwenyi.api.result.StringUtils` 改为只为本包使用 +- `Builder` -> `IBuilder` +- `Result` -> `IResult` :memo: Document diff --git a/src/main/java/com/fengwenyi/api/result/Builder.java b/src/main/java/com/fengwenyi/api/result/IBuilder.java similarity index 88% rename from src/main/java/com/fengwenyi/api/result/Builder.java rename to src/main/java/com/fengwenyi/api/result/IBuilder.java index c7a1d8e..e04618b 100644 --- a/src/main/java/com/fengwenyi/api/result/Builder.java +++ b/src/main/java/com/fengwenyi/api/result/IBuilder.java @@ -6,7 +6,7 @@ * @author Erwin Feng * @since 2.5.2 */ -public interface Builder { +public interface IBuilder { /** * 构建一个对象 diff --git a/src/main/java/com/fengwenyi/api/result/Result.java b/src/main/java/com/fengwenyi/api/result/IResult.java similarity index 83% rename from src/main/java/com/fengwenyi/api/result/Result.java rename to src/main/java/com/fengwenyi/api/result/IResult.java index 3c803c5..ae080fd 100644 --- a/src/main/java/com/fengwenyi/api/result/Result.java +++ b/src/main/java/com/fengwenyi/api/result/IResult.java @@ -8,7 +8,7 @@ * @author Erwin Feng * @since 2.7.0 */ -public interface Result { +public interface IResult { /** * 结果码 @@ -25,13 +25,13 @@ public interface Result { /** * 默认 */ - class Default implements Result { + class Default implements IResult { /* -----------------成功---------------------------- */ - public static final Result SUCCESS = new Default("SUCCESS", "Success"); + public static final IResult SUCCESS = new Default("SUCCESS", "Success"); /* ------------------错误--------------------------- */ - public static final Result ERROR = new Default("ERROR", "错误"); + public static final IResult ERROR = new Default("ERROR", "错误"); /** 结果码 */ private final String code; diff --git a/src/main/java/com/fengwenyi/api/result/PageTemplate.java b/src/main/java/com/fengwenyi/api/result/PageTemplate.java index 929e3bf..325e862 100644 --- a/src/main/java/com/fengwenyi/api/result/PageTemplate.java +++ b/src/main/java/com/fengwenyi/api/result/PageTemplate.java @@ -149,7 +149,7 @@ public PageTemplate setTotalPage(long totalPage) { * PageResponse构造者,可通过该类构造出PageResponseVo * @param 范型 */ - public static class Builder implements com.fengwenyi.api.result.Builder> { + public static class Builder implements IBuilder> { // PageResponseVo 对象 private final PageTemplate pageTemplate; diff --git a/src/main/java/com/fengwenyi/api/result/ResultTemplate.java b/src/main/java/com/fengwenyi/api/result/ResultTemplate.java index cb387d9..799a5dd 100644 --- a/src/main/java/com/fengwenyi/api/result/ResultTemplate.java +++ b/src/main/java/com/fengwenyi/api/result/ResultTemplate.java @@ -98,12 +98,12 @@ public class ResultTemplate implements Serializable { /** * 默认操作成功 */ - private static final Result SUCCESS = Result.Default.SUCCESS; + private static final IResult SUCCESS = IResult.Default.SUCCESS; /** * 默认操作失败 */ - private static final Result ERROR = Result.Default.ERROR; + private static final IResult ERROR = IResult.Default.ERROR; /** * 构造方法:无参数 @@ -176,11 +176,11 @@ public static ResultTemplate fail(String msg) { /** * 操作失败 * - * @param returnCode {@link Result} + * @param returnCode {@link IResult} * @param {@link Void} * @return 响应封装类 {@link ResultTemplate} */ - public static ResultTemplate fail(Result returnCode) { + public static ResultTemplate fail(IResult returnCode) { return new ResultTemplate() .setCode(returnCode.getCode()) .setMsg(returnCode.getMsg()) @@ -190,13 +190,13 @@ public static ResultTemplate fail(Result returnCode) { /** * 操作失败 * - * @param returnCode {@link Result} + * @param returnCode {@link IResult} * @param msg 描述信息 * @param {@link Void} * @return 响应封装类 {@link ResultTemplate} */ @SuppressWarnings("all") - public static ResultTemplate fail(Result returnCode, String msg) { + public static ResultTemplate fail(IResult returnCode, String msg) { msg = StringUtils.isBlank(msg) ? returnCode.getMsg() : msg; return new ResultTemplate() .setCode(returnCode.getCode()) diff --git a/src/main/java/com/fengwenyi/api/result/StringUtils.java b/src/main/java/com/fengwenyi/api/result/StringUtils.java index 0630f42..0004d6a 100644 --- a/src/main/java/com/fengwenyi/api/result/StringUtils.java +++ b/src/main/java/com/fengwenyi/api/result/StringUtils.java @@ -5,14 +5,14 @@ * @author Erwin Feng * @since 2.5.2 */ -public class StringUtils { +class StringUtils { /** * 字符串判空 * @param str 待判断的字符串 * @return 判断结果 */ - public static boolean isBlank(String str) { + static boolean isBlank(String str) { if (null == str) { return true; } diff --git a/src/test/java/com/fengwenyi/api/result/MyResult.java b/src/test/java/com/fengwenyi/api/result/MyResult.java index ac4088d..dc7b388 100644 --- a/src/test/java/com/fengwenyi/api/result/MyResult.java +++ b/src/test/java/com/fengwenyi/api/result/MyResult.java @@ -4,7 +4,7 @@ * @author Erwin Feng * @since 2022-07-14 */ -public class MyResult extends Result.Default { +public class MyResult extends IResult.Default { /** * 构造方法 @@ -16,6 +16,6 @@ public class MyResult extends Result.Default { super(code, msg); } - public static final Result BIZ_ERROR = new MyResult("BIZ_ERROR", "业务异常"); + public static final IResult BIZ_ERROR = new MyResult("BIZ_ERROR", "业务异常"); } diff --git a/src/test/java/com/fengwenyi/api/result/ResultEnum.java b/src/test/java/com/fengwenyi/api/result/ResultEnum.java index 141eaab..721fd47 100644 --- a/src/test/java/com/fengwenyi/api/result/ResultEnum.java +++ b/src/test/java/com/fengwenyi/api/result/ResultEnum.java @@ -4,7 +4,7 @@ * @author Erwin Feng * @since 2021-07-02 */ -public enum ResultEnum implements Result { +public enum ResultEnum implements IResult { CUSTOM_ERROR("CUSTOM_ERROR", "自定义错误") diff --git a/src/test/java/com/fengwenyi/api/result/util/StringUtilsTests.java b/src/test/java/com/fengwenyi/api/result/StringUtilsTests.java similarity index 89% rename from src/test/java/com/fengwenyi/api/result/util/StringUtilsTests.java rename to src/test/java/com/fengwenyi/api/result/StringUtilsTests.java index 3b8e843..8e5c67c 100644 --- a/src/test/java/com/fengwenyi/api/result/util/StringUtilsTests.java +++ b/src/test/java/com/fengwenyi/api/result/StringUtilsTests.java @@ -1,6 +1,5 @@ -package com.fengwenyi.api.result.util; +package com.fengwenyi.api.result; -import com.fengwenyi.api.result.StringUtils; import org.junit.Test; /**