From 7d633941f694be72f9fea90b5cd1bdd148585de8 Mon Sep 17 00:00:00 2001 From: dftre <3066417822@qq.com> Date: Tue, 7 Jan 2025 11:37:06 +0800 Subject: [PATCH] =?UTF-8?q?EnumConstantsMustHaveCommentRule=E4=BF=AE?= =?UTF-8?q?=E5=A4=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../common/enums/OauthVerificationUse.java | 6 +++ .../com/ruoyi/common/annotation/Excel.java | 41 +++++++++++-------- .../com/ruoyi/common/enums/HttpMethod.java | 18 +++++++- .../com/ruoyi/common/enums/UserStatus.java | 7 +++- .../common/exception/job/TaskException.java | 28 ++++++++----- .../enums/DataSecurityStrategy.java | 4 ++ .../mybatisinterceptor/enums/SqlType.java | 4 ++ 7 files changed, 78 insertions(+), 30 deletions(-) diff --git a/ruoyi-auth/ruoyi-auth-common/src/main/java/com/ruoyi/auth/common/enums/OauthVerificationUse.java b/ruoyi-auth/ruoyi-auth-common/src/main/java/com/ruoyi/auth/common/enums/OauthVerificationUse.java index 14a52fa..6b44b6c 100644 --- a/ruoyi-auth/ruoyi-auth-common/src/main/java/com/ruoyi/auth/common/enums/OauthVerificationUse.java +++ b/ruoyi-auth/ruoyi-auth-common/src/main/java/com/ruoyi/auth/common/enums/OauthVerificationUse.java @@ -2,11 +2,17 @@ package com.ruoyi.auth.common.enums; public enum OauthVerificationUse { + /** 用于登录 */ LOGIN("登录", "login"), + /** 用于注册 */ REGISTER("注册", "register"), + /** 用于禁用 */ DISABLE("禁用", "disable"), + /** 用于重置信息 */ RESET("重置", "reset"), + /** 用于绑定信息 */ BIND("绑定", "bind"), + /** 其他用途 */ OTHER("其他", "other"); private String name; diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/annotation/Excel.java b/ruoyi-common/src/main/java/com/ruoyi/common/annotation/Excel.java index 2ec0bb0..536c42b 100644 --- a/ruoyi-common/src/main/java/com/ruoyi/common/annotation/Excel.java +++ b/ruoyi-common/src/main/java/com/ruoyi/common/annotation/Excel.java @@ -18,8 +18,7 @@ import com.ruoyi.common.utils.poi.ExcelHandlerAdapter; */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) -public @interface Excel -{ +public @interface Excel { /** * 导出时在excel中排序 */ @@ -86,7 +85,7 @@ public @interface Excel public String prompt() default ""; /** - * 是否允许内容换行 + * 是否允许内容换行 */ public boolean wrapText() default false; @@ -165,34 +164,42 @@ public @interface Excel */ Type type() default Type.ALL; - public enum Type - { - ALL(0), EXPORT(1), IMPORT(2); + public enum Type { + /** 导出或导入 */ + ALL(0), + /** 仅导出 */ + EXPORT(1), + /** 仅导入 */ + IMPORT(2); + private final int value; - Type(int value) - { + Type(int value) { this.value = value; } - public int value() - { + public int value() { return this.value; } } - public enum ColumnType - { - NUMERIC(0), STRING(1), IMAGE(2), TEXT(3); + public enum ColumnType { + /** 数字 */ + NUMERIC(0), + /** 字符串 */ + STRING(1), + /** 图片 */ + IMAGE(2), + /** 文本 */ + TEXT(3); + private final int value; - ColumnType(int value) - { + ColumnType(int value) { this.value = value; } - public int value() - { + public int value() { return this.value; } } diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/enums/HttpMethod.java b/ruoyi-common/src/main/java/com/ruoyi/common/enums/HttpMethod.java index be6f739..8d8eca3 100644 --- a/ruoyi-common/src/main/java/com/ruoyi/common/enums/HttpMethod.java +++ b/ruoyi-common/src/main/java/com/ruoyi/common/enums/HttpMethod.java @@ -2,6 +2,7 @@ package com.ruoyi.common.enums; import java.util.HashMap; import java.util.Map; + import org.springframework.lang.Nullable; /** @@ -11,7 +12,22 @@ import org.springframework.lang.Nullable; */ public enum HttpMethod { - GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE; + /** GET 请求 */ + GET, + /** POST 请求 */ + HEAD, + /** HEAD 请求 */ + POST, + /** PUT 请求 */ + PUT, + /** PATCH 请求 */ + PATCH, + /** DELETE 请求 */ + DELETE, + /** OPTIONS 请求 */ + OPTIONS, + /** TRACE 请求 */ + TRACE; private static final Map mappings = new HashMap<>(16); diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/enums/UserStatus.java b/ruoyi-common/src/main/java/com/ruoyi/common/enums/UserStatus.java index d7ff44a..28a43db 100644 --- a/ruoyi-common/src/main/java/com/ruoyi/common/enums/UserStatus.java +++ b/ruoyi-common/src/main/java/com/ruoyi/common/enums/UserStatus.java @@ -7,7 +7,12 @@ package com.ruoyi.common.enums; */ public enum UserStatus { - OK("0", "正常"), DISABLE("1", "停用"), DELETED("2", "删除"); + /** 正常 */ + OK("0", "正常"), + /** 停用 */ + DISABLE("1", "停用"), + /** 删除 */ + DELETED("2", "删除"); private final String code; private final String info; diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/exception/job/TaskException.java b/ruoyi-common/src/main/java/com/ruoyi/common/exception/job/TaskException.java index a567b40..7975243 100644 --- a/ruoyi-common/src/main/java/com/ruoyi/common/exception/job/TaskException.java +++ b/ruoyi-common/src/main/java/com/ruoyi/common/exception/job/TaskException.java @@ -5,30 +5,36 @@ package com.ruoyi.common.exception.job; * * @author ruoyi */ -public class TaskException extends Exception -{ +public class TaskException extends Exception { private static final long serialVersionUID = 1L; private Code code; - public TaskException(String msg, Code code) - { + public TaskException(String msg, Code code) { this(msg, code, null); } - public TaskException(String msg, Code code, Exception nestedEx) - { + public TaskException(String msg, Code code, Exception nestedEx) { super(msg, nestedEx); this.code = code; } - public Code getCode() - { + public Code getCode() { return code; } - public enum Code - { - TASK_EXISTS, NO_TASK_EXISTS, TASK_ALREADY_STARTED, UNKNOWN, CONFIG_ERROR, TASK_NODE_NOT_AVAILABLE + public enum Code { + /** 任务存在 */ + TASK_EXISTS, + /** 任务不存在 */ + NO_TASK_EXISTS, + /** 任务已经开始 */ + TASK_ALREADY_STARTED, + /** 未知 */ + UNKNOWN, + /** 配置错误 */ + CONFIG_ERROR, + /** 任务节点不可用 */ + TASK_NODE_NOT_AVAILABLE } } \ No newline at end of file diff --git a/ruoyi-plugins/ruoyi-mybatis-interceptor/src/main/java/com/ruoyi/mybatisinterceptor/enums/DataSecurityStrategy.java b/ruoyi-plugins/ruoyi-mybatis-interceptor/src/main/java/com/ruoyi/mybatisinterceptor/enums/DataSecurityStrategy.java index 16358c1..223bee4 100644 --- a/ruoyi-plugins/ruoyi-mybatis-interceptor/src/main/java/com/ruoyi/mybatisinterceptor/enums/DataSecurityStrategy.java +++ b/ruoyi-plugins/ruoyi-mybatis-interceptor/src/main/java/com/ruoyi/mybatisinterceptor/enums/DataSecurityStrategy.java @@ -1,8 +1,12 @@ package com.ruoyi.mybatisinterceptor.enums; public enum DataSecurityStrategy { + /** 通过创建人字段关联表 */ JOINTABLE_CREATE_BY, + /** 通过用户ID字段关联表 */ JOINTABLE_USER_ID, + /** 通过创建人字段 */ CREEATE_BY, + /** 通过用户ID字段 */ USER_ID; } diff --git a/ruoyi-plugins/ruoyi-mybatis-interceptor/src/main/java/com/ruoyi/mybatisinterceptor/enums/SqlType.java b/ruoyi-plugins/ruoyi-mybatis-interceptor/src/main/java/com/ruoyi/mybatisinterceptor/enums/SqlType.java index 52af7d4..cb321c8 100644 --- a/ruoyi-plugins/ruoyi-mybatis-interceptor/src/main/java/com/ruoyi/mybatisinterceptor/enums/SqlType.java +++ b/ruoyi-plugins/ruoyi-mybatis-interceptor/src/main/java/com/ruoyi/mybatisinterceptor/enums/SqlType.java @@ -1,9 +1,13 @@ package com.ruoyi.mybatisinterceptor.enums; public enum SqlType { + /** where */ WHERE("where"), + /** join */ JOIN("join"), + /** select */ SELECT("select"), + /** limit */ LIMIT("limit"); private String sqlType;