From e167761df097fdecdd0b2c6692e61c02f73e04ea Mon Sep 17 00:00:00 2001 From: sol Date: Tue, 23 Sep 2025 14:18:26 +0800 Subject: [PATCH] docs(common-auth): Add a comment description --- .../bgasol/plugin/satoken/config/CorsConfigure.java | 1 + .../plugin/satoken/config/SaTokenConfigure.java | 4 +--- .../plugin/satoken/config/SaTokenInterceptor.java | 1 + .../plugin/satoken/runner/ControllerScanner.java | 6 +++--- .../satoken/runner/SaSameTokenRefreshTask.java | 4 +--- .../plugin/satoken/service/StpInterfaceImpl.java | 12 +++--------- .../base/converter/StringToStringListConverter.java | 2 -- .../common/core/base/exception/BaseException.java | 1 + .../core/base/exception/VerificationException.java | 1 + .../java/com/bgasol/common/core/base/vo/BaseVo.java | 5 +++++ .../common/core/base/vo/VerificationResult.java | 4 ++++ 11 files changed, 21 insertions(+), 20 deletions(-) diff --git a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/CorsConfigure.java b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/CorsConfigure.java index 463aa98..c29c272 100644 --- a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/CorsConfigure.java +++ b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/CorsConfigure.java @@ -5,6 +5,7 @@ import org.springframework.lang.NonNull; import org.springframework.web.servlet.config.annotation.CorsRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; +/// 跨域配置 @Configuration public class CorsConfigure implements WebMvcConfigurer { @Override diff --git a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/SaTokenConfigure.java b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/SaTokenConfigure.java index a0c3a73..0ac0e47 100644 --- a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/SaTokenConfigure.java +++ b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/SaTokenConfigure.java @@ -13,9 +13,7 @@ import org.springframework.lang.NonNull; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; -/** - * Sa-Token 权限认证 配置类 - */ +/// Sa-Token 权限认证 配置类 @Configuration @Slf4j public class SaTokenConfigure implements WebMvcConfigurer { diff --git a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/SaTokenInterceptor.java b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/SaTokenInterceptor.java index f4c95f6..ef114e9 100644 --- a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/SaTokenInterceptor.java +++ b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/config/SaTokenInterceptor.java @@ -5,6 +5,7 @@ import com.bgasol.common.constant.value.GatewayConfigValues; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; +/// 重写sa-token的注解拦截器 public class SaTokenInterceptor extends SaInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { diff --git a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/runner/ControllerScanner.java b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/runner/ControllerScanner.java index de1af0e..0fa03a2 100644 --- a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/runner/ControllerScanner.java +++ b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/runner/ControllerScanner.java @@ -26,6 +26,7 @@ import java.util.List; import java.util.Set; import java.util.concurrent.TimeUnit; +/// 扫描controller @Component @RequiredArgsConstructor @Slf4j @@ -39,9 +40,7 @@ public class ControllerScanner { private final static String controllerPackage = "com.bgasol.web.**.controller"; - /** - * 扫描controller类和方法，将权限信息存入数据库 - */ + /// 扫描controller类和方法，将权限信息存入数据库 public void scanController(Class controllerClass) { // 只扫描controller的类 PermissionEntity parentPermissionEntity = new PermissionEntity(); @@ -123,6 +122,7 @@ public class ControllerScanner { } } + /// 开始扫描controller @EventListener(InstanceRegisteredEvent.class) @Async() public void scanControllers() throws ClassNotFoundException, InterruptedException { diff --git a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/runner/SaSameTokenRefreshTask.java b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/runner/SaSameTokenRefreshTask.java index 185c23a..d938dd3 100644 --- a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/runner/SaSameTokenRefreshTask.java +++ b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/runner/SaSameTokenRefreshTask.java @@ -12,9 +12,7 @@ import org.springframework.stereotype.Component; import java.util.concurrent.TimeUnit; -/** - * Same-Token，定时刷新（分布式锁保证同一时刻只有一个实例执行） - */ +/// Same-Token，定时刷新（分布式锁保证同一时刻只有一个实例执行） @Component @RequiredArgsConstructor @Slf4j diff --git a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/service/StpInterfaceImpl.java b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/service/StpInterfaceImpl.java index c97f74f..17bc4b7 100644 --- a/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/service/StpInterfaceImpl.java +++ b/cloud/common/common-auth/src/main/java/com/bgasol/plugin/satoken/service/StpInterfaceImpl.java @@ -17,9 +17,7 @@ import java.util.Set; import static com.bgasol.common.constant.value.SystemConfigValues.ADMIN_USER_ID; -/** - * 自定义权限验证接口扩展 - */ +/// 权限数据加载源 @Component @RequiredArgsConstructor public class StpInterfaceImpl implements StpInterface { @@ -34,9 +32,7 @@ public class StpInterfaceImpl implements StpInterface { return userEntityBaseVo.getData(); } - /** - * 返回一个账号所拥有的权限码集合 - */ + /// 返回一个账号所拥有的权限码集合 @Override public List getPermissionList(Object loginId, String loginType) { UserEntity user = this.getUser((String) loginId, loginType); @@ -55,9 +51,7 @@ public class StpInterfaceImpl implements StpInterface { return new ArrayList<>(permissions); } - /** - * 返回一个账号所拥有的角色标识集合 (权限与角色可分开校验) - */ + /// 返回一个账号所拥有的角色标识集合 (权限与角色可分开校验) @Override public List getRoleList(Object loginId, String loginType) { UserEntity user = this.getUser((String) loginId, loginType); diff --git a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/converter/StringToStringListConverter.java b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/converter/StringToStringListConverter.java index 3b8ae39..90d974c 100644 --- a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/converter/StringToStringListConverter.java +++ b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/converter/StringToStringListConverter.java @@ -66,5 +66,3 @@ public class StringToStringListConverter implements Converter> { }; } } - - diff --git a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/exception/BaseException.java b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/exception/BaseException.java index 3b9996f..f30e696 100644 --- a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/exception/BaseException.java +++ b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/exception/BaseException.java @@ -5,6 +5,7 @@ import com.bgasol.common.core.base.vo.ResponseType; import lombok.Getter; import lombok.extern.slf4j.Slf4j; +/// 自定义通用异常 @Getter @Slf4j public class BaseException extends RuntimeException { diff --git a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/exception/VerificationException.java b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/exception/VerificationException.java index 368e174..f28c536 100644 --- a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/exception/VerificationException.java +++ b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/exception/VerificationException.java @@ -6,6 +6,7 @@ import lombok.extern.slf4j.Slf4j; import java.util.List; +/// 自定义验证异常 @Slf4j @Getter public class VerificationException extends RuntimeException { diff --git a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/vo/BaseVo.java b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/vo/BaseVo.java index fa96248..5f651c8 100644 --- a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/vo/BaseVo.java +++ b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/vo/BaseVo.java @@ -15,18 +15,23 @@ import java.util.List; @NoArgsConstructor @Schema(description = "基础响应数据") public class BaseVo { + /// 响应码 @Schema(description = "响应码") private Integer code; + /// 响应消息 @Schema(description = "响应消息") private String message; + /// 响应数据 @Schema(description = "响应数据") private T data; + /// 响应时间 @Schema(description = "响应时间") private Date time; + /// 响应类型 @Schema(description = "响应类型") private ResponseType type; diff --git a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/vo/VerificationResult.java b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/vo/VerificationResult.java index 2905bf9..f1ba913 100644 --- a/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/vo/VerificationResult.java +++ b/cloud/common/common-base-model/src/main/java/com/bgasol/common/core/base/vo/VerificationResult.java @@ -6,18 +6,22 @@ import lombok.NoArgsConstructor; import lombok.Setter; import lombok.experimental.SuperBuilder; +/// 参数校验结果 @Schema(description = "参数校验结果") @Getter @Setter @SuperBuilder @NoArgsConstructor public class VerificationResult { + /// 校验结果 @Schema(description = "校验结果") private boolean result; + /// 校验字段 @Schema(description = "校验字段") private String field; + /// 校验消息 @Schema(description = "校验消息") private String message; }