xyz.zhouxy.plusone.commons.exception

Interface IMultiTypesException<T extends IExceptionType<?>>

Type Parameters:

T - 异常场景

All Known Implementing Classes:

InvalidInputException, ParsingFailureException

public interface IMultiTypesException<T extends IExceptionType<?>>

IMultiTypesException

异常在不同场景下被抛出，可以用不同的枚举值，表示不同的场景类型。

异常实现 IMultiTypesException 的 getType() 方法，返回对应的场景类型。

表示场景类型的枚举实现 IExceptionType，各个枚举值本身就是该场景的异常的工厂实例， 使用其中的工厂方法用于创建对应类型的异常。

 public final class LoginException
         extends RuntimeException
         implements IMultiTypesException<LoginException.Type> {
     private static final long serialVersionUID = 881293090625085616L;
     private final Type type;
     private LoginException(@Nonnull Type type, @Nonnull String message) {
         super(message);
         this.type = type;
     }

     private LoginException(@Nonnull Type type, @Nonnull Throwable cause) {
         super(cause);
         this.type = type;
     }

     private LoginException(@Nonnull Type type,
                            @Nonnull String message,
                            @Nonnull Throwable cause) {
         super(message, cause);
         this.type = type;
     }

     @Override
     public @Nonnull Type getType() {
         return this.type;
     }

     // ...

     public enum Type implements IExceptionType<String>, IExceptionFactory<LoginException> {
         DEFAULT("00", "当前会话未登录"),
         NOT_TOKEN("10", "未提供token"),
         INVALID_TOKEN("20", "token无效"),
         TOKEN_TIMEOUT("30", "token已过期"),
         BE_REPLACED("40", "token已被顶下线"),
         KICK_OUT("50", "token已被踢下线"),
         ;

         @Nonnull
         private final String code;
         @Nonnull
         private final String defaultMessage;

         Type(@Nonnull String code, @Nonnull String defaultMessage) {
             this.code = code;
             this.defaultMessage = defaultMessage;
         }

         @Override
         public @Nonnull String getCode() {
             return code;
         }

         @Override
         public @Nonnull String getDefaultMessage() {
             return defaultMessage;
         }

         @Override
         public @Nonnull LoginException create() {
             return new LoginException(this, this.defaultMessage);
         }

         @Override
         public @Nonnull LoginException create(String message) {
             return new LoginException(this, message);
         }

         @Override
         public @Nonnull LoginException create(Throwable cause) {
             return new LoginException(this, cause);
         }

         @Override
         public @Nonnull LoginException create(String message, Throwable cause) {
             return new LoginException(this, message, cause);
         }
     }
 }
 

使用时，可以使用这种方式创建并抛出异常：

 throw LoginException.Type.TOKEN_TIMEOUT.create();
 

Since:

1.0.0

Author:

ZhouXY108

Method Summary

Modifier and Type	Method and Description
T	getType() 异常类型

Method Detail

getType

@Nonnull
T getType()

异常类型

Returns:

异常类型。通常是实现了 IExceptionType 的枚举。