|
|
|
@ -8,18 +8,27 @@ import lombok.Getter;
|
|
|
|
|
* @CONTACT 317758022@qq.com
|
|
|
|
|
* @DESC 基本的返回状态描述
|
|
|
|
|
*/
|
|
|
|
|
// 使用lombok的@Getter注解,由于这是一个枚举类型,该注解会自动为枚举中的成员变量(这里的code和desc)生成对应的Getter方法,方便在其他地方获取这些变量的值,这样在使用该枚举时,能够便捷地获取到每个枚举实例所对应的状态码和描述信息,避免手动编写Getter方法的重复代码,使代码更加简洁。
|
|
|
|
|
@Getter
|
|
|
|
|
// 定义了一个名为ResponseEnum的枚举类型,在Java中枚举常用于表示一组固定的常量值,这里它主要用于统一管理各种响应相关的状态码和对应的描述信息,方便在整个应用中根据不同的业务场景使用合适的枚举实例来表示响应情况。
|
|
|
|
|
public enum ResponseEnum {
|
|
|
|
|
// 定义了一个名为SUCCESS的枚举实例,传入参数0和"SUCCESS",分别对应状态码和描述信息,意味着在业务处理成功的场景下,可以使用这个枚举实例来表示成功的响应状态,通过其Getter方法可以获取对应的状态码0以及描述信息"SUCCESS",便于在接口返回数据等场景中进行统一的状态标识和信息传递。
|
|
|
|
|
SUCCESS(0,"SUCCESS"),
|
|
|
|
|
// 定义了一个名为ERROR的枚举实例,传入参数1和"ERROR",用于表示出现错误的响应状态,当业务处理过程中发生一般性错误时,可以使用这个枚举实例来传达错误信息,外部通过获取其状态码1和描述信息"ERROR"来知晓出现了错误情况,进而进行相应的处理,比如展示错误提示给用户等。
|
|
|
|
|
ERROR(1,"ERROR"),
|
|
|
|
|
// 定义了一个名为ILLEGAL_ARGUMENTS的枚举实例,传入参数2和"ILLEGAL_ARGUMENTS",通常用于表示接收到的请求参数不符合要求、不合法的情况,例如参数格式错误、缺少必要参数等场景下,可使用该枚举实例来反馈这种参数非法的响应状态,方便调用者根据状态码2和描述信息"ILLEGAL_ARGUMENTS"判断是参数问题并进行相应的参数修正等操作。
|
|
|
|
|
ILLEGAL_ARGUMENTS(2,"ILLEGAL_ARGUMENTS"),
|
|
|
|
|
// 定义了一个名为NEED_LOGIN的枚举实例,传入参数10和"NEED_LOGIN",主要应用在需要用户登录但用户未登录的场景下,比如访问受登录保护的接口时,若用户未登录,就可以返回这个枚举实例所对应的状态码10和描述信息"NEED_LOGIN",提示客户端(如前端页面)需要用户进行登录操作后才能继续访问相应资源。
|
|
|
|
|
NEED_LOGIN(10,"NEED_LOGIN");
|
|
|
|
|
|
|
|
|
|
// 定义一个私有整型成员变量code,用于存储每个枚举实例对应的状态码,通过构造函数进行赋值,在具体的业务逻辑中,可以通过对应的枚举实例获取这个状态码来进行不同的处理操作,比如根据状态码判断业务流程的走向等。
|
|
|
|
|
private int code;
|
|
|
|
|
// 定义一个私有字符串成员变量desc,用于存储每个枚举实例对应的描述信息,同样通过构造函数进行赋值,在需要向客户端或者用户展示具体的响应提示内容时,可以获取这个描述信息进行展示,让用户更直观地了解响应的具体含义。
|
|
|
|
|
private String desc;
|
|
|
|
|
|
|
|
|
|
// 定义了一个构造函数,接收一个整型参数code和一个字符串参数desc,用于初始化枚举实例对应的状态码和描述信息,在每个枚举实例声明时(如SUCCESS(0,"SUCCESS")等)传入的参数会通过这个构造函数来给对应的成员变量赋值,确保每个枚举实例都有正确的状态码和描述信息与之对应。
|
|
|
|
|
ResponseEnum(int code,String desc){
|
|
|
|
|
this.code = code;
|
|
|
|
|
this.desc = desc;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|