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

refactor!: 重命名多类型异常相关接口

Browse Source 
- 将 MultiTypesException 重命名为 IMultiTypesException
- 将 ExceptionType 重命名为 IExceptionType
- 将 ExceptionFactory 重命名为 IExceptionFactory
This commit is contained in:
zhouxy108 2025-06-09 11:37:16 +08:00
parent 577b73874b
commit ce56f297f3
6 changed files with 30 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -68,16 +68,16 @@ System.out.println(result); // Output: Return string
`RegexConsts` 包含常见正则表达式；`PatternConsts` 包含对应的 `Pattern` 对象
## 五、exception - 异常
### 1. MultiTypesException - 多类型异常
### 1. IMultiTypesException - 多类型异常
异常在不同场景下被抛出，可以用不同的枚举值，表示不同的场景类型。
异常实现 `MultiTypesException` 的 `MultiTypesException#getType` 方法，返回对应的场景类型。
异常实现 `IMultiTypesException` 的 `IMultiTypesException#getType` 方法，返回对应的场景类型。
表示场景类型的枚举实现 `MultiTypesException.ExceptionType`，其中的工厂方法用于创建对应类型的异常。
表示场景类型的枚举实现 `IMultiTypesException.IExceptionType`，其中的工厂方法用于创建对应类型的异常。
```java
public final class LoginException
extends RuntimeException
implements MultiTypesException<LoginException, LoginException.Type> {
implements IMultiTypesException<LoginException, LoginException.Type> {
private final Type type;
private LoginException(@Nonnull Type type, @Nonnull String message) {
super(message);
@ -103,7 +103,7 @@ public final class LoginException
// ...
public enum Type implements ExceptionType {
public enum Type implements IExceptionType<LoginException> {
DEFAULT("00", "当前会话未登录"),
NOT_TOKEN("10", "未提供token"),
INVALID_TOKEN("20", "token无效"),

2
plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/ExceptionFactory.java → plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionFactory.java
View File

@ -22,7 +22,7 @@ import javax.annotation.Nonnull;
*
* @author ZhouXY
*/
public interface ExceptionFactory<X extends Exception> {
public interface IExceptionFactory<X extends Exception> {
/**
* 创建异常
*

22
plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/MultiTypesException.java → plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IMultiTypesException.java
View File

@ -20,22 +20,22 @@ import javax.annotation.Nonnull;
import xyz.zhouxy.plusone.commons.base.IWithCode;
/**
* MultiTypesException
* IMultiTypesException
*
* <p>
* 异常在不同场景下被抛出，可以用不同的枚举值，表示不同的场景类型。
*
* <p>
* 异常实现 {@link MultiTypesException} 的 {@link #getType} 方法，返回对应的场景类型。
* 异常实现 {@link IMultiTypesException} 的 {@link #getType} 方法，返回对应的场景类型。
*
* <p>
* 表示场景类型的枚举实现 {@link ExceptionType}，各个枚举值本身就是该场景的异常的工厂实例，
* 表示场景类型的枚举实现 {@link IExceptionType}，各个枚举值本身就是该场景的异常的工厂实例，
* 使用其中的工厂方法用于创建对应类型的异常。
*
* <pre>
* public final class LoginException
* extends RuntimeException
* implements MultiTypesException&lt;LoginException, LoginException.Type&gt; {
* implements IMultiTypesException&lt;LoginException, LoginException.Type&gt; {
* private final Type type;
* private LoginException(&#64;Nonnull Type type, &#64;Nonnull String message) {
* super(message);
@ -61,7 +61,7 @@ import xyz.zhouxy.plusone.commons.base.IWithCode;
*
* // ...
*
* public enum Type implements ExceptionType&lt;LoginException&gt; {
* public enum Type implements IExceptionType&lt;LoginException&gt; {
* DEFAULT("00", "当前会话未登录"),
* NOT_TOKEN("10", "未提供token"),
* INVALID_TOKEN("20", "token无效"),
@ -118,17 +118,19 @@ import xyz.zhouxy.plusone.commons.base.IWithCode;
* throw LoginException.Type.TOKEN_TIMEOUT.create();
* </pre>
*
* @param <X> 具体异常类
* @param <T> 异常场景
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0
*/
public interface MultiTypesException<
public interface IMultiTypesException<
X extends Exception,
T extends MultiTypesException.ExceptionType<X>> {
T extends IMultiTypesException.IExceptionType<X>> {
/**
* 异常类型
*
* @return 异常类型。通常是实现了 {@link ExceptionType} 的枚举。
* @return 异常类型。通常是实现了 {@link IExceptionType} 的枚举。
*/
@Nonnull
T getType();
@ -145,8 +147,8 @@ public interface MultiTypesException<
/**
* 异常类型
*/
public static interface ExceptionType<X extends Exception>
extends IWithCode<String>, ExceptionFactory<X> {
public static interface IExceptionType<X extends Exception>
extends IWithCode<String>, IExceptionFactory<X> {
/**
* 默认异常信息

6
plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/ParsingFailureException.java
View File

@ -21,7 +21,7 @@ import java.time.format.DateTimeParseException;
import javax.annotation.Nonnull;
import xyz.zhouxy.plusone.commons.exception.business.RequestParamsException;
import xyz.zhouxy.plusone.commons.exception.MultiTypesException.ExceptionType;
import xyz.zhouxy.plusone.commons.exception.IMultiTypesException.IExceptionType;
/**
* 解析失败异常
@ -39,7 +39,7 @@ import xyz.zhouxy.plusone.commons.exception.MultiTypesException.ExceptionType;
*/
public final class ParsingFailureException
extends RuntimeException
implements MultiTypesException<ParsingFailureException, ParsingFailureException.Type> {
implements IMultiTypesException<ParsingFailureException, ParsingFailureException.Type> {
private final Type type;
@ -170,7 +170,7 @@ public final class ParsingFailureException
/** XML 解析失败 */
public static final Type XML_PARSING_FAILURE = Type.XML_PARSING_FAILURE;
public enum Type implements ExceptionType<ParsingFailureException> {
public enum Type implements IExceptionType<ParsingFailureException> {
DEFAULT("00", "解析失败"),
NUMBER_PARSING_FAILURE("10", "数字转换失败"),
DATE_TIME_PARSING_FAILURE("20", "时间解析失败"),

8
plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/InvalidInputException.java
View File

@ -18,8 +18,8 @@ package xyz.zhouxy.plusone.commons.exception.business;
import javax.annotation.Nonnull;
import xyz.zhouxy.plusone.commons.exception.MultiTypesException.ExceptionType;
import xyz.zhouxy.plusone.commons.exception.MultiTypesException;
import xyz.zhouxy.plusone.commons.exception.IMultiTypesException.IExceptionType;
import xyz.zhouxy.plusone.commons.exception.IMultiTypesException;
/**
* InvalidInputException
@ -35,7 +35,7 @@ import xyz.zhouxy.plusone.commons.exception.MultiTypesException;
*/
public final class InvalidInputException
extends RequestParamsException
implements MultiTypesException<InvalidInputException, InvalidInputException.Type> {
implements IMultiTypesException<InvalidInputException, InvalidInputException.Type> {
private final Type type;
@ -108,7 +108,7 @@ public final class InvalidInputException
return this.type;
}
public enum Type implements ExceptionType<InvalidInputException> {
public enum Type implements IExceptionType<InvalidInputException> {
DEFAULT("00", "用户输入内容非法"),
CONTAINS_ILLEGAL_AND_MALICIOUS_LINKS("01", "包含非法恶意跳转链接"),
CONTAINS_ILLEGAL_WORDS("02", "包含违禁敏感词"),

10
plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/package-info.java
View File

@ -17,21 +17,21 @@
/**
* <h2>异常</h2>
*
* <h3>1. {@link MultiTypesException} - 多类型异常</h3>
* <h3>1. {@link IMultiTypesException} - 多类型异常</h3>
* <p>
* 异常在不同场景下被抛出，可以用不同的枚举值，表示不同的场景类型。
*
* <p>
* 异常实现 {@link MultiTypesException} 的 {@link MultiTypesException#getType} 方法，返回对应的场景类型。
* 异常实现 {@link IMultiTypesException} 的 {@link IMultiTypesException#getType} 方法，返回对应的场景类型。
*
* <p>
* 表示场景类型的枚举实现 {@link MultiTypesException.ExceptionType}，各个枚举值本身就是该场景的异常的工厂实例，
* 表示场景类型的枚举实现 {@link IMultiTypesException.IExceptionType}，各个枚举值本身就是该场景的异常的工厂实例，
* 使用其中的工厂方法用于创建对应类型的异常。
*
* <pre>
* public final class LoginException
* extends RuntimeException
* implements MultiTypesException&lt;LoginException, LoginException.Type&gt; {
* implements IMultiTypesException&lt;LoginException, LoginException.Type&gt; {
* private final Type type;
* private LoginException(&#64;Nonnull Type type, &#64;Nonnull String message) {
* super(message);
@ -57,7 +57,7 @@
*
* // ...
*
* public enum Type implements ExceptionType&lt;LoginException&gt; {
* public enum Type implements IExceptionType&lt;LoginException&gt; {
* DEFAULT("00", "当前会话未登录"),
* NOT_TOKEN("10", "未提供token"),
* INVALID_TOKEN("20", "token无效"),