diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/pom.xml b/pom.xml index 3c3373a..5acaab4 100644 --- a/pom.xml +++ b/pom.xml @@ -14,16 +14,10 @@ 1.8 1.18.24 2.13.4 - 3.0.2 31.1-jre - - com.google.code.findbugs - jsr305 - ${google-jsr305.version} - com.google.guava guava diff --git a/src/main/java/xyz/zhouxy/plusone/commons/util/EnumUtil.java b/src/main/java/xyz/zhouxy/plusone/commons/util/EnumUtil.java index 7135319..30ad4ab 100644 --- a/src/main/java/xyz/zhouxy/plusone/commons/util/EnumUtil.java +++ b/src/main/java/xyz/zhouxy/plusone/commons/util/EnumUtil.java @@ -18,6 +18,9 @@ package xyz.zhouxy.plusone.commons.util; import java.util.Objects; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; + /** * 枚举工具类 * @@ -37,7 +40,7 @@ public final class EnumUtil { * @param ordinal 数据库中对应的数值 * @return 枚举对象 */ - public static > E valueOf(Class clazz, int ordinal) { + public static > E valueOf(@Nonnull Class clazz, int ordinal) { E[] values = clazz.getEnumConstants(); try { return values[ordinal]; @@ -54,11 +57,12 @@ public final class EnumUtil { * @param ordinal 数据库中对应的数值 * @return 枚举对象 */ - public static > E getValueOrDefault(Class clazz, Integer ordinal) { + public static > E getValueOrDefault(@Nonnull Class clazz, @Nullable Integer ordinal) { E[] values = clazz.getEnumConstants(); try { return Objects.nonNull(ordinal) ? values[ordinal] : values[0]; } catch (IndexOutOfBoundsException e) { + Objects.requireNonNull(ordinal); throw new EnumConstantNotPresentException(clazz, Integer.toString(ordinal)); } } @@ -71,19 +75,17 @@ public final class EnumUtil { * @param ordinal 数据库中对应的数值 * @return 枚举对象 */ - public static > E getValueNullable(Class clazz, Integer ordinal) { + public static > E getValueNullable(@Nonnull Class clazz, @Nullable Integer ordinal) { E[] values = clazz.getEnumConstants(); try { return Objects.nonNull(ordinal) ? values[ordinal] : null; } catch (IndexOutOfBoundsException e) { + Objects.requireNonNull(ordinal); throw new EnumConstantNotPresentException(clazz, Integer.toString(ordinal)); } } - public static > Integer checkOrdinal(Class clazz, Integer ordinal) { - if (ordinal == null) { - throw new IllegalArgumentException("ordinal 不能为空"); - } + public static > Integer checkOrdinal(@Nonnull Class clazz, @Nonnull Integer ordinal) { E[] values = clazz.getEnumConstants(); if (ordinal >= 0 && ordinal < values.length) { return ordinal; @@ -91,15 +93,15 @@ public final class EnumUtil { throw new EnumConstantNotPresentException(clazz, Integer.toString(ordinal)); } - public static > Integer checkOrdinalNullable(Class clazz, Integer ordinal) { - if (Objects.isNull(ordinal)) { + public static > Integer checkOrdinalNullable(@Nonnull Class clazz, @Nullable Integer ordinal) { + if (ordinal == null) { return null; } return checkOrdinal(clazz, ordinal); } - public static > Integer checkOrdinalOrDefault(Class clazz, Integer ordinal) { - if (Objects.isNull(ordinal)) { + public static > Integer checkOrdinalOrDefault(@Nonnull Class clazz, @Nullable Integer ordinal) { + if (ordinal == null) { return 0; } return checkOrdinal(clazz, ordinal); diff --git a/src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java b/src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java index 3be8c8b..f2dca80 100644 --- a/src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java +++ b/src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java @@ -21,6 +21,7 @@ import java.util.Map; import java.util.Objects; import java.util.concurrent.ConcurrentHashMap; +import javax.annotation.CheckForNull; import javax.annotation.Nonnull; /** @@ -40,7 +41,6 @@ public abstract class Enumeration> implements Comparabl return id; } - @Nonnull public final String getName() { return name; } @@ -68,7 +68,6 @@ public abstract class Enumeration> implements Comparabl } @Override - @Nonnull public final String toString() { return getClass().getSimpleName() + '(' + id + ":" + name + ')'; } @@ -87,14 +86,13 @@ public abstract class Enumeration> implements Comparabl this.values.put(value.getId(), value); } - @Nonnull + @CheckForNull public T get(final int id) { - return Objects.requireNonNull(this.values.get(id)); + return this.values.get(id); } - @Nonnull public Collection getValues() { - return Objects.requireNonNull(this.values.values()); + return this.values.values(); } } } diff --git a/src/main/java/xyz/zhouxy/plusone/commons/util/NumberUtil.java b/src/main/java/xyz/zhouxy/plusone/commons/util/NumberUtil.java index 088e005..1395050 100644 --- a/src/main/java/xyz/zhouxy/plusone/commons/util/NumberUtil.java +++ b/src/main/java/xyz/zhouxy/plusone/commons/util/NumberUtil.java @@ -27,7 +27,7 @@ public class NumberUtil { throw new IllegalStateException("Utility class"); } - public static int sum(short... numbers) { + public static int sum(final short... numbers) { int result = 0; for (short number : numbers) { result += number; @@ -35,7 +35,7 @@ public class NumberUtil { return result; } - public static long sum(int... numbers) { + public static long sum(final int... numbers) { int result = 0; for (int number : numbers) { result += number; @@ -43,7 +43,7 @@ public class NumberUtil { return result; } - public static long sum(long... numbers) { + public static long sum(final long... numbers) { long result = 0; for (long number : numbers) { result += number; @@ -51,7 +51,7 @@ public class NumberUtil { return result; } - public static double sum(float... numbers) { + public static double sum(final float... numbers) { double result = 0; for (double number : numbers) { result += number; @@ -59,7 +59,7 @@ public class NumberUtil { return result; } - public static double sum(double... numbers) { + public static double sum(final double... numbers) { double result = 0; for (double number : numbers) { result += number; diff --git a/src/main/java/xyz/zhouxy/plusone/commons/util/PageDTO.java b/src/main/java/xyz/zhouxy/plusone/commons/util/PageDTO.java index fbd265a..e737013 100644 --- a/src/main/java/xyz/zhouxy/plusone/commons/util/PageDTO.java +++ b/src/main/java/xyz/zhouxy/plusone/commons/util/PageDTO.java @@ -18,8 +18,7 @@ package xyz.zhouxy.plusone.commons.util; import java.util.List; -import lombok.Setter; -import lombok.ToString; +import javax.annotation.Nonnull; /** * 返回分页查询的结果 @@ -29,28 +28,35 @@ import lombok.ToString; * @author ZhouXY * @see PagingAndSortingQueryParams */ -@ToString -@Setter public class PageDTO { - private Long total; - private List content; + @Nonnull + private final Long total; + @Nonnull + private final List content; - private PageDTO(List content, Long total) { + private PageDTO(@Nonnull List content, @Nonnull Long total) { this.content = content; this.total = total; } - public static PageDTO of(List content, Long total) { + @Nonnull + public static PageDTO of(@Nonnull List content, @Nonnull Long total) { return new PageDTO<>(content, total); } + @Nonnull public Long getTotal() { return total; } + @Nonnull public List getContent() { return content; } + @Override + public String toString() { + return "PageDTO [total=" + total + ", content=" + content + "]"; + } } diff --git a/src/main/java/xyz/zhouxy/plusone/commons/util/PagingAndSortingQueryParams.java b/src/main/java/xyz/zhouxy/plusone/commons/util/PagingAndSortingQueryParams.java index fb15ca6..cdfe472 100644 --- a/src/main/java/xyz/zhouxy/plusone/commons/util/PagingAndSortingQueryParams.java +++ b/src/main/java/xyz/zhouxy/plusone/commons/util/PagingAndSortingQueryParams.java @@ -20,8 +20,6 @@ import java.util.Arrays; import java.util.Collections; import java.util.List; -import lombok.Setter; - /** * 分页排序查询参数 * @@ -33,7 +31,6 @@ import lombok.Setter; * @author ZhouXY * @see PageDTO */ -@Setter public class PagingAndSortingQueryParams { protected String orderBy; @@ -50,6 +47,8 @@ public class PagingAndSortingQueryParams { this.sortableColNames = Arrays.asList(sortableColNames); } + // Getters + public String getOrderBy() { return orderBy != null && sortableColNames.contains(orderBy) ? orderBy : null; } @@ -66,4 +65,21 @@ public class PagingAndSortingQueryParams { return (getPageNum() - 1) * getSize(); } + // Getters end + + // Setters + + public void setOrderBy(String orderBy) { + this.orderBy = orderBy; + } + + public void setSize(Integer size) { + this.size = size; + } + + public void setPageNum(Long pageNum) { + this.pageNum = pageNum; + } + + // Setters end } diff --git a/src/main/java/xyz/zhouxy/plusone/commons/util/RestfulResult.java b/src/main/java/xyz/zhouxy/plusone/commons/util/RestfulResult.java index da6dee6..efe7b8b 100644 --- a/src/main/java/xyz/zhouxy/plusone/commons/util/RestfulResult.java +++ b/src/main/java/xyz/zhouxy/plusone/commons/util/RestfulResult.java @@ -19,12 +19,10 @@ package xyz.zhouxy.plusone.commons.util; import java.util.function.BooleanSupplier; import java.util.function.Supplier; -import com.fasterxml.jackson.annotation.JsonInclude; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; -import lombok.AccessLevel; -import lombok.AllArgsConstructor; -import lombok.Getter; -import lombok.ToString; +import com.fasterxml.jackson.annotation.JsonInclude; /** * 对返回给前端的数据进行封装 @@ -32,19 +30,19 @@ import lombok.ToString; * @author ZhouXY */ @JsonInclude(JsonInclude.Include.NON_NULL) -@ToString -@Getter -@AllArgsConstructor(access = AccessLevel.PRIVATE) public class RestfulResult { public static final int SUCCESS_STATUS = 2000000; public static final int DEFAULT_ERROR_STATUS = 9999999; + @Nonnull private final Object status; + @Nonnull private final String message; + @Nullable private final Object data; - private RestfulResult(final Object status, final String message) { + private RestfulResult(@Nonnull final Object status, @Nonnull final String message) { this(status, message, null); } @@ -52,11 +50,13 @@ public class RestfulResult { return new RestfulResult(SUCCESS_STATUS, "操作成功"); } - public static RestfulResult success(final String message) { + public static RestfulResult success(@Nonnull final String message) { return new RestfulResult(SUCCESS_STATUS, message); } - public static RestfulResult success(final String message, final Object data) { + public static RestfulResult success( + @Nonnull final String message, + @Nullable final Object data) { return new RestfulResult(SUCCESS_STATUS, message, data); } @@ -64,84 +64,75 @@ public class RestfulResult { return new RestfulResult(DEFAULT_ERROR_STATUS, "未知错误"); } - public static RestfulResult error(final Object status, final String message) { + public static RestfulResult error( + @Nonnull final Object status, + @Nonnull final String message) { return new RestfulResult(status, message); } - public static RestfulResult error(final Object status, final String message, final Object data) { + public static RestfulResult error( + @Nonnull final Object status, + @Nonnull final String message, + @Nullable final Object data) { return new RestfulResult(status, message, data); } - public static RestfulResult error(final Object status, final Throwable e) { - return new RestfulResult(status, e.getMessage()); + public static RestfulResult error(@Nonnull final Object status, @Nonnull final Throwable e) { + String msg = e.getMessage(); + if (msg == null) { + msg = ""; + } + return new RestfulResult(status, msg); } public static RestfulResult of( final boolean isSuccess, - final Supplier success, - final Supplier error) { + @Nonnull final Supplier success, + @Nonnull final Supplier error) { return isSuccess ? success.get() : error.get(); } public static RestfulResult of( - final BooleanSupplier isSuccess, - final Supplier success, - final Supplier error) { + @Nonnull final BooleanSupplier isSuccess, + @Nonnull final Supplier success, + @Nonnull final Supplier error) { return isSuccess.getAsBoolean() ? success.get() : error.get(); } - // Builder - public static Builder successIf(final boolean condition) { - return successIf(() -> condition); + // Constructors + + private RestfulResult( + @Nonnull final Object status, + @Nonnull final String message, + @Nullable final Object data) { + this.status = status; + this.message = message; + this.data = data; } - public static Builder successIf(final BooleanSupplier booleanSupplier) { - return new Builder(booleanSupplier, RestfulResult::success); + // Constructors end + + // Getters + + @Nonnull + public Object getStatus() { + return status; } - public static Builder successIf(final boolean condition, final String msg) { - return new Builder(() -> condition, () -> success(msg)); + @Nonnull + public String getMessage() { + return message; } - public static Builder successIf(final BooleanSupplier booleanSupplier, final String msg) { - return new Builder(booleanSupplier, () -> success(msg)); + @Nullable + public Object getData() { + return data; } - public static Builder successIf(final boolean condition, final String msg, final Object data) { - return new Builder(() -> condition, () -> success(msg, data)); - } + // Getters end - public static Builder successIf(final BooleanSupplier booleanSupplier, final String msg, final Object data) { - return new Builder(booleanSupplier, () -> success(msg, data)); - } - - public static class Builder { - private final BooleanSupplier booleanSupplier; - private final Supplier success; - - public Builder(final BooleanSupplier booleanSupplier, final Supplier success) { - this.booleanSupplier = booleanSupplier; - this.success = success; - } - - public RestfulResult orError() { - return this.booleanSupplier.getAsBoolean() - ? this.success.get() - : RestfulResult.error(); - } - - public RestfulResult orError(final Object status, final String msg) { - return orError(status, msg, null); - } - - public RestfulResult orError(final Object status, final Throwable e) { - return orError(status, e.getMessage()); - } - - public RestfulResult orError(final Object status, final String msg, final Object data) { - return this.booleanSupplier.getAsBoolean() - ? this.success.get() - : RestfulResult.error(status, msg, data); - } + @Override + public String toString() { + return "RestfulResult [status=" + status + ", message=" + message + ", data=" + data + "]"; } } diff --git a/src/test/java/xyz/zhouxy/plusone/commons/util/RestfulResultTest.java b/src/test/java/xyz/zhouxy/plusone/commons/util/RestfulResultTest.java deleted file mode 100644 index 979deb7..0000000 --- a/src/test/java/xyz/zhouxy/plusone/commons/util/RestfulResultTest.java +++ /dev/null @@ -1,34 +0,0 @@ -package xyz.zhouxy.plusone.commons.util; - -import static org.junit.jupiter.api.Assertions.assertEquals; - -import lombok.extern.slf4j.Slf4j; -import org.junit.jupiter.api.Test; - -@Slf4j -class RestfulResultTest { - - @Test - void testSuccessIf() { - String str = null; - RestfulResult result = RestfulResult.successIf(str != null).orError(); - log.info(result.toString()); - assertEquals(RestfulResult.DEFAULT_ERROR_STATUS, result.getStatus()); - - result = RestfulResult.successIf(str != null, "成功") - .orError(2333, "失败"); - log.info(result.toString()); - assertEquals(2333, result.getStatus()); - assertEquals("失败", result.getMessage()); - - str = ""; - result = RestfulResult.successIf(str != null).orError(); - log.info(result.toString()); - assertEquals(RestfulResult.SUCCESS_STATUS, result.getStatus()); - - result = RestfulResult.successIf(str != null, "成功", str) - .orError(2333, "失败"); - log.info(result.toString()); - assertEquals("成功", result.getMessage()); - } -}