plusone/plusone-commons
1
1
Fork 1
Code Issues Pull Requests Projects Releases 7 Activity

Merge remote-tracking branch 'origin/dev' into dev

Browse Source 
# Conflicts:
#	pom.xml
#	src/main/java/xyz/zhouxy/plusone/commons/util/ArrayUtil.java
#	src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java
#	src/main/java/xyz/zhouxy/plusone/commons/util/RestfulResult.java
#	src/test/java/xyz/zhouxy/plusone/commons/EnumerationTests.java
#	src/test/java/xyz/zhouxy/plusone/commons/util/RestfulResultTest.java
This commit is contained in:
ZhouXY108
2023-04-15 21:52:15 +08:00
parent 96784e1263 1959d1b2cb
commit 728fab165e
9 changed files with 312 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/main/java/xyz/zhouxy/plusone/commons/util/EnumUtil.java
View File

@@ -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 extends Enum<?>> E valueOf(Class<E> clazz, int ordinal) {
public static <E extends Enum<?>> E valueOf(@Nonnull Class<E> 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 extends Enum<?>> E getValueOrDefault(Class<E> clazz, Integer ordinal) {
public static <E extends Enum<?>> E getValueOrDefault(@Nonnull Class<E> 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 extends Enum<?>> E getValueNullable(Class<E> clazz, Integer ordinal) {
public static <E extends Enum<?>> E getValueNullable(@Nonnull Class<E> 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 <E extends Enum<?>> Integer checkOrdinal(Class<E> clazz, Integer ordinal) {
if (ordinal == null) {
throw new IllegalArgumentException("ordinal 不能为空");
}
public static <E extends Enum<?>> Integer checkOrdinal(@Nonnull Class<E> 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 <E extends Enum<?>> Integer checkOrdinalNullable(Class<E> clazz, Integer ordinal) {
if (Objects.isNull(ordinal)) {
public static <E extends Enum<?>> Integer checkOrdinalNullable(@Nonnull Class<E> clazz, @Nullable Integer ordinal) {
if (ordinal == null) {
return null;
}
return checkOrdinal(clazz, ordinal);
}
public static <E extends Enum<?>> Integer checkOrdinalOrDefault(Class<E> clazz, Integer ordinal) {
if (Objects.isNull(ordinal)) {
public static <E extends Enum<?>> Integer checkOrdinalOrDefault(@Nonnull Class<E> clazz, @Nullable Integer ordinal) {
if (ordinal == null) {
return 0;
}
return checkOrdinal(clazz, ordinal);

10
src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java
View File

@@ -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<T extends Enumeration<T>> implements Comparabl
return id;
}
@Nonnull
public final String getName() {
return name;
}
@@ -68,7 +68,6 @@ public abstract class Enumeration<T extends Enumeration<T>> implements Comparabl
}
@Override
@Nonnull
public final String toString() {
return getClass().getSimpleName() + '(' + id + ":" + name + ')';
}
@@ -87,14 +86,13 @@ public abstract class Enumeration<T extends Enumeration<T>> 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<T> getValues() {
return Objects.requireNonNull(this.values.values());
return this.values.values();
}
}
}

10
src/main/java/xyz/zhouxy/plusone/commons/util/NumberUtil.java
View File

@@ -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;

22
src/main/java/xyz/zhouxy/plusone/commons/util/PageDTO.java
View File

@@ -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 <a href="https://gitee.com/zhouxy108">ZhouXY</a>
* @see PagingAndSortingQueryParams
*/
@ToString
@Setter
public class PageDTO<T> {
private Long total;
private List<T> content;
@Nonnull
private final Long total;
@Nonnull
private final List<T> content;
private PageDTO(List<T> content, Long total) {
private PageDTO(@Nonnull List<T> content, @Nonnull Long total) {
this.content = content;
this.total = total;
}
public static <T> PageDTO<T> of(List<T> content, Long total) {
@Nonnull
public static <T> PageDTO<T> of(@Nonnull List<T> content, @Nonnull Long total) {
return new PageDTO<>(content, total);
}
@Nonnull
public Long getTotal() {
return total;
}
@Nonnull
public List<T> getContent() {
return content;
}
@Override
public String toString() {
return "PageDTO [total=" + total + ", content=" + content + "]";
}
}

22
src/main/java/xyz/zhouxy/plusone/commons/util/PagingAndSortingQueryParams.java
View File

@@ -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 <a href="https://gitee.com/zhouxy108">ZhouXY</a>
* @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
}

119
src/main/java/xyz/zhouxy/plusone/commons/util/RestfulResult.java
View File

@@ -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 <a href="https://gitee.com/zhouxy108">ZhouXY</a>
*/
@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<RestfulResult> success,
final Supplier<RestfulResult> error) {
@Nonnull final Supplier<RestfulResult> success,
@Nonnull final Supplier<RestfulResult> error) {
return isSuccess ? success.get() : error.get();
}
public static RestfulResult of(
final BooleanSupplier isSuccess,
final Supplier<RestfulResult> success,
final Supplier<RestfulResult> error) {
@Nonnull final BooleanSupplier isSuccess,
@Nonnull final Supplier<RestfulResult> success,
@Nonnull final Supplier<RestfulResult> 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<RestfulResult> success;
public Builder(final BooleanSupplier booleanSupplier, final Supplier<RestfulResult> 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 + "]";
}
}

34
src/test/java/xyz/zhouxy/plusone/commons/util/RestfulResultTest.java
View File

@@ -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());
}
}