diff --git a/docker-compose.yml b/docker-compose.yml index 0f53b1b8..82d78484 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -7,7 +7,7 @@ # - name 固定项目名,容器统一管理和卸载,避免与其他项目冲突 # - 中间件配置全部内联于 command 参数,无需外部配置文件 # - 数据持久化使用命名卷(docker volume 统一管理),不污染项目目录 -# - RustFS 兼容 MinIO 磁盘格式与 S3 协议(MinIO 社区版已于 2026 年停止维护) +# - 对象存储使用 RustFS(S3 协议兼容) name: youlai-boot diff --git a/src/main/java/com/youlai/boot/auth/password/config/CaptchaProperties.java b/src/main/java/com/youlai/boot/auth/password/config/CaptchaProperties.java index 8b0f4681..7e7bda1c 100644 --- a/src/main/java/com/youlai/boot/auth/password/config/CaptchaProperties.java +++ b/src/main/java/com/youlai/boot/auth/password/config/CaptchaProperties.java @@ -15,43 +15,27 @@ import org.springframework.stereotype.Component; @Data public class CaptchaProperties { - /** - * 验证码类型 circle-圆圈干扰验证码|gif-Gif验证码|line-干扰线验证码|shear-扭曲干扰验证码 - */ + // 验证码类型 circle-圆圈干扰验证码|gif-Gif验证码|line-干扰线验证码|shear-扭曲干扰验证码 private String type; - /** - * 验证码图片宽度 - */ + // 验证码图片宽度 private int width; - /** - * 验证码图片高度 - */ + // 验证码图片高度 private int height; - /** - * 干扰线数量 - */ + // 干扰线数量 private int interfereCount; - /** - * 文本透明度 - */ + // 文本透明度 private Float textAlpha; - /** - * 验证码过期时间,单位:秒 - */ + // 验证码过期时间,单位:秒 private Long expireSeconds; - /** - * 验证码字符配置 - */ + // 验证码字符配置 private CodeProperties code; - /** - * 验证码字体 - */ + // 验证码字体 private FontProperties font; /** @@ -59,13 +43,9 @@ public class CaptchaProperties { */ @Data public static class CodeProperties { - /** - * 验证码字符类型 math-算术|random-随机字符串 - */ + // 验证码字符类型 math-算术|random-随机字符串 private String type; - /** - * 验证码字符长度,type=算术时,表示运算位数(1:个位数 2:十位数);type=随机字符时,表示字符个数 - */ + // 验证码字符长度,type=算术时,表示运算位数(1:个位数 2:十位数);type=随机字符时,表示字符个数 private int length; } @@ -74,17 +54,11 @@ public class CaptchaProperties { */ @Data public static class FontProperties { - /** - * 字体名称 - */ + // 字体名称 private String name; - /** - * 字体样式 0-普通|1-粗体|2-斜体 - */ + // 字体样式 0-普通|1-粗体|2-斜体 private int weight; - /** - * 字体大小 - */ + // 字体大小 private int size; } diff --git a/src/main/java/com/youlai/boot/auth/password/exception/CaptchaException.java b/src/main/java/com/youlai/boot/auth/password/exception/CaptchaException.java index 9c5c6b6d..5e484b00 100644 --- a/src/main/java/com/youlai/boot/auth/password/exception/CaptchaException.java +++ b/src/main/java/com/youlai/boot/auth/password/exception/CaptchaException.java @@ -5,8 +5,6 @@ import lombok.Getter; /** * 图形验证码校验失败时抛出的异常。 - *

- * 携带 {@link ResultCode} 用于统一错误响应。 * * @author Ray.Hao * @since 3.1.0 diff --git a/src/main/java/com/youlai/boot/auth/password/filter/CaptchaValidationFilter.java b/src/main/java/com/youlai/boot/auth/password/filter/CaptchaValidationFilter.java index 201ab338..36e93e68 100644 --- a/src/main/java/com/youlai/boot/auth/password/filter/CaptchaValidationFilter.java +++ b/src/main/java/com/youlai/boot/auth/password/filter/CaptchaValidationFilter.java @@ -30,8 +30,6 @@ import java.nio.charset.StandardCharsets; /** * 图形验证码校验过滤器 - *

- * 仅拦截账号密码登录请求:先校验验证码,校验通过后把请求体包装成可重复读取的 Request 再放行。 * * @author Ray.Hao */ diff --git a/src/main/java/com/youlai/boot/auth/qrcode/controller/QrCodeAuthController.java b/src/main/java/com/youlai/boot/auth/qrcode/controller/QrCodeAuthController.java index 773fbebe..6307e60c 100644 --- a/src/main/java/com/youlai/boot/auth/qrcode/controller/QrCodeAuthController.java +++ b/src/main/java/com/youlai/boot/auth/qrcode/controller/QrCodeAuthController.java @@ -24,9 +24,6 @@ import org.springframework.web.bind.annotation.RestController; /** * 扫码登录认证接口 * - *

generate/status/login 不需要登录态(PC 端未登录),由 Security 配置放行; - * scan/confirm/cancel 需要 APP 端登录态,当前用户 ID 从 Security 上下文获取。

- * * @author Ray.Hao * @since 4.5.0 */ diff --git a/src/main/java/com/youlai/boot/auth/qrcode/model/context/QrCodeLoginContext.java b/src/main/java/com/youlai/boot/auth/qrcode/model/context/QrCodeLoginContext.java index 95885e0d..c6607add 100644 --- a/src/main/java/com/youlai/boot/auth/qrcode/model/context/QrCodeLoginContext.java +++ b/src/main/java/com/youlai/boot/auth/qrcode/model/context/QrCodeLoginContext.java @@ -11,30 +11,30 @@ import lombok.Data; @Data public class QrCodeLoginContext { - /** 票据,UUID 无连字符 */ + // 票据,UUID 无连字符 private String ticket; - /** 状态枚举名,取 {@link com.youlai.boot.auth.qrcode.enums.QrCodeLoginStatusEnum#name()} */ + // 状态枚举名,取 {@link com.youlai.boot.auth.qrcode.enums.QrCodeLoginStatusEnum#name()} private String status; - /** 扫码用户 ID,scan 时写入 */ + // 扫码用户 ID,scan 时写入 private Long userId; - /** 用户原始昵称(未脱敏),status 接口返回时脱敏 */ + // 用户原始昵称(未脱敏),status 接口返回时脱敏 private String nickname; - /** 用户头像 URL */ + // 用户头像 URL private String avatar; - /** 创建时间戳(毫秒) */ + // 创建时间戳(毫秒) private Long createdAt; - /** 扫码时间戳(毫秒) */ + // 扫码时间戳(毫秒) private Long scannedAt; - /** 确认时间戳(毫秒) */ + // 确认时间戳(毫秒) private Long confirmedAt; - /** generate 时的 PC 端 IP */ + // generate 时的 PC 端 IP private String clientIp; } diff --git a/src/main/java/com/youlai/boot/auth/qrcode/service/QrCodeLoginService.java b/src/main/java/com/youlai/boot/auth/qrcode/service/QrCodeLoginService.java index 66ed0e86..c11621e8 100644 --- a/src/main/java/com/youlai/boot/auth/qrcode/service/QrCodeLoginService.java +++ b/src/main/java/com/youlai/boot/auth/qrcode/service/QrCodeLoginService.java @@ -35,16 +35,13 @@ import java.util.concurrent.TimeUnit; @Slf4j public class QrCodeLoginService { - /** 票据默认有效期(秒) */ + // 票据默认有效期(秒) private static final int DEFAULT_EXPIRE_SECONDS = 300; - /** 状态流转时若 Redis 剩余 TTL 小于该值,补足到此值 */ + // 状态流转时若 Redis 剩余 TTL 小于该值,补足到此值 private static final int MIN_REMAIN_SECONDS = 30; - /** - * 从 Redis 读回的值可能是不带类型信息的 Map(序列化器以 Object.class 存储), - * 用它把 Map 转回强类型上下文对象。JsonMapper 线程安全,复用单例。 - */ + // 从 Redis 读回的值可能是不带类型信息的 Map(序列化器以 Object.class 存储), private static final JsonMapper JSON_MAPPER = JsonMapper.builder().build(); private final RedisTemplate redisTemplate; diff --git a/src/main/java/com/youlai/boot/auth/session/controller/AuthSessionController.java b/src/main/java/com/youlai/boot/auth/session/controller/AuthSessionController.java index 960be83d..e26b13b0 100644 --- a/src/main/java/com/youlai/boot/auth/session/controller/AuthSessionController.java +++ b/src/main/java/com/youlai/boot/auth/session/controller/AuthSessionController.java @@ -19,8 +19,6 @@ import org.springframework.web.bind.annotation.RestController; /** * 登录态管理接口 * - *

注销与刷新令牌,各登录方式共用。

- * * @author Ray.Hao * @since 4.8.0 */ diff --git a/src/main/java/com/youlai/boot/auth/session/service/AuthSessionService.java b/src/main/java/com/youlai/boot/auth/session/service/AuthSessionService.java index c5f8860f..845da193 100644 --- a/src/main/java/com/youlai/boot/auth/session/service/AuthSessionService.java +++ b/src/main/java/com/youlai/boot/auth/session/service/AuthSessionService.java @@ -11,8 +11,6 @@ import org.springframework.stereotype.Service; /** * 登录态服务 * - *

承载各登录方式共用的注销与令牌刷新。

- * * @author Ray.Hao * @since 4.8.0 */ diff --git a/src/main/java/com/youlai/boot/auth/sms/provider/SmsAuthenticationProvider.java b/src/main/java/com/youlai/boot/auth/sms/provider/SmsAuthenticationProvider.java index dc5d9592..b92853f4 100644 --- a/src/main/java/com/youlai/boot/auth/sms/provider/SmsAuthenticationProvider.java +++ b/src/main/java/com/youlai/boot/auth/sms/provider/SmsAuthenticationProvider.java @@ -18,15 +18,6 @@ import org.springframework.security.core.userdetails.UsernameNotFoundException; /** * 短信验证码认证 Provider - *

- * 认证流程: - *

    - *
  1. 根据手机号查询用户信息
  2. - *
  3. 校验用户状态
  4. - *
  5. 校验短信验证码(与 Redis 缓存比对)
  6. - *
  7. 验证成功后删除验证码
  8. - *
  9. 返回已认证的 Authentication
  10. - *
* * @author Ray.Hao * @since 2.17.0 diff --git a/src/main/java/com/youlai/boot/auth/sms/service/SmsAuthService.java b/src/main/java/com/youlai/boot/auth/sms/service/SmsAuthService.java index f032919e..bbbd371b 100644 --- a/src/main/java/com/youlai/boot/auth/sms/service/SmsAuthService.java +++ b/src/main/java/com/youlai/boot/auth/sms/service/SmsAuthService.java @@ -43,9 +43,7 @@ public class SmsAuthService { */ public void sendSmsCode(String mobile) { - // 随机生成4位验证码 - // String code = String.valueOf((int) ((Math.random() * 9 + 1) * 1000)); - // TODO 为了方便测试,验证码固定为 1234,实际开发中在配置了厂商短信服务后,可以使用上面的随机验证码 + // TODO 固定验证码 1234 便于测试,接入短信厂商后改为随机生成 String code = "1234"; // 发送短信验证码 diff --git a/src/main/java/com/youlai/boot/auth/sms/token/SmsAuthenticationToken.java b/src/main/java/com/youlai/boot/auth/sms/token/SmsAuthenticationToken.java index 83e8ac50..84e9d787 100644 --- a/src/main/java/com/youlai/boot/auth/sms/token/SmsAuthenticationToken.java +++ b/src/main/java/com/youlai/boot/auth/sms/token/SmsAuthenticationToken.java @@ -9,8 +9,6 @@ import java.util.Collection; /** * 短信验证码认证 Token。 - *

- * 未认证:principal=手机号,credentials=验证码;已认证:principal=SecurityUserDetails,credentials=null。 * * @author Ray.Hao * @since 2.20.0 diff --git a/src/main/java/com/youlai/boot/auth/wxma/config/WxMaProperties.java b/src/main/java/com/youlai/boot/auth/wxma/config/WxMaProperties.java index 94d330bb..88f6fbfa 100644 --- a/src/main/java/com/youlai/boot/auth/wxma/config/WxMaProperties.java +++ b/src/main/java/com/youlai/boot/auth/wxma/config/WxMaProperties.java @@ -14,9 +14,9 @@ import org.springframework.stereotype.Component; @ConfigurationProperties(prefix = "wx.miniapp") public class WxMaProperties { - /** 小程序 appid */ + // 小程序 appid private String appid; - /** 小程序 appsecret */ + // 小程序 appsecret private String secret; } diff --git a/src/main/java/com/youlai/boot/auth/wxma/controller/WxMaAuthController.java b/src/main/java/com/youlai/boot/auth/wxma/controller/WxMaAuthController.java index 8ff8e019..105ce860 100644 --- a/src/main/java/com/youlai/boot/auth/wxma/controller/WxMaAuthController.java +++ b/src/main/java/com/youlai/boot/auth/wxma/controller/WxMaAuthController.java @@ -35,15 +35,6 @@ public class WxMaAuthController { private final WxMaAuthService wxMaAuthService; - /** - * 静默登录 - *

- * 适用场景:个人小程序、无需手机号的登录场景 - *

- */ @Operation(summary = "[小程序]静默登录", description = "通过微信 code 登录,已绑定用户直接返回 token,未绑定用户返回 openid 需绑定手机号") @PostMapping("/silent-login") @Log(module = LogModuleEnum.LOGIN, value = ActionTypeEnum.LOGIN) @@ -56,13 +47,6 @@ public class WxMaAuthController { return Result.success(result); } - /** - * 手机号快捷登录 - *

- * 适用场景:企业认证小程序(已开通手机号快捷登录权限) - *

- * 一步完成登录,无需绑定流程,自动创建新用户 - */ @Operation(summary = "[小程序]手机号快捷登录", description = "同时使用微信 code 和手机号授权 code 登录,适用于企业认证小程序") @PostMapping("/phone-login") @Log(module = LogModuleEnum.LOGIN, value = ActionTypeEnum.LOGIN) @@ -72,13 +56,6 @@ public class WxMaAuthController { return Result.success(result); } - /** - * 绑定手机号 - *

- * 适用场景:静默登录后未绑定手机号的用户 - *

- * 绑定成功后自动完成登录 - */ @Operation(summary = "[小程序]绑定手机号", description = "为静默登录用户绑定手机号,绑定成功后自动登录") @PostMapping("/bind-mobile") @Log(module = LogModuleEnum.LOGIN, value = ActionTypeEnum.LOGIN) diff --git a/src/main/java/com/youlai/boot/auth/wxma/exception/MobileNotBoundException.java b/src/main/java/com/youlai/boot/auth/wxma/exception/MobileNotBoundException.java index 68ff1f1f..94b60fbe 100644 --- a/src/main/java/com/youlai/boot/auth/wxma/exception/MobileNotBoundException.java +++ b/src/main/java/com/youlai/boot/auth/wxma/exception/MobileNotBoundException.java @@ -4,8 +4,6 @@ import org.springframework.security.core.AuthenticationException; /** * 微信小程序登录时手机号未绑定异常。 - *

- * 携带 openid 和 sessionKey 供前端引导用户完成手机号绑定。 * * @author Ray.Hao * @since 3.1.0 diff --git a/src/main/java/com/youlai/boot/auth/wxma/provider/WxMaAuthenticationProvider.java b/src/main/java/com/youlai/boot/auth/wxma/provider/WxMaAuthenticationProvider.java index 10ce36f2..4f90cc79 100644 --- a/src/main/java/com/youlai/boot/auth/wxma/provider/WxMaAuthenticationProvider.java +++ b/src/main/java/com/youlai/boot/auth/wxma/provider/WxMaAuthenticationProvider.java @@ -22,8 +22,6 @@ import org.springframework.security.core.userdetails.UsernameNotFoundException; /** * 微信小程序认证 Provider - *

- * 用微信登录凭证换取 openid,已绑定手机号的用户返回认证结果,未绑定抛出 MobileNotBoundException。 * * @author Ray.Hao */ diff --git a/src/main/java/com/youlai/boot/auth/wxma/service/WxMaAuthService.java b/src/main/java/com/youlai/boot/auth/wxma/service/WxMaAuthService.java index 21886847..b4f2128e 100644 --- a/src/main/java/com/youlai/boot/auth/wxma/service/WxMaAuthService.java +++ b/src/main/java/com/youlai/boot/auth/wxma/service/WxMaAuthService.java @@ -51,10 +51,6 @@ public class WxMaAuthService { /** * 静默登录 - *

- * 通过微信登录凭证(code)获取用户唯一标识(openid), - * 如果用户已绑定手机号则直接登录成功,否则返回需绑定手机号的提示。 - *

* * @param code 微信登录凭证(wx.login 获取) * @return 登录结果(成功返回 token,需绑定返回 openid) @@ -85,10 +81,6 @@ public class WxMaAuthService { /** * 手机号快捷登录 - *

- * 同时使用微信登录凭证和手机号授权凭证, - * 一步完成用户注册/登录,无需额外绑定流程。 - *

* * @param loginCode 微信登录凭证(wx.login 获取) * @param phoneCode 手机号授权凭证(getPhoneNumber 事件获取) @@ -117,10 +109,6 @@ public class WxMaAuthService { /** * 绑定手机号 - *

- * 为已静默登录但未绑定手机号的用户绑定手机号, - * 绑定成功后自动完成登录。 - *

* * @param openid 微信用户唯一标识 * @param mobile 手机号码 @@ -194,9 +182,6 @@ public class WxMaAuthService { /** * 创建新用户 - *

- * 新用户默认分配 GUEST(访问游客)角色 - *

*/ private SysUser createNewUser(String mobile) { SysUser user = new SysUser(); diff --git a/src/main/java/com/youlai/boot/auth/wxma/token/WxMaAuthenticationToken.java b/src/main/java/com/youlai/boot/auth/wxma/token/WxMaAuthenticationToken.java index 970ec5d8..24014e61 100644 --- a/src/main/java/com/youlai/boot/auth/wxma/token/WxMaAuthenticationToken.java +++ b/src/main/java/com/youlai/boot/auth/wxma/token/WxMaAuthenticationToken.java @@ -9,8 +9,6 @@ import java.util.Collection; /** * 微信小程序认证 Token。 - *

- * 未认证:principal=微信code;已认证:principal=SecurityUserDetails。 * * @author Ray.Hao * @since 4.0.0 diff --git a/src/main/java/com/youlai/boot/codegen/model/entity/GenTable.java b/src/main/java/com/youlai/boot/codegen/model/entity/GenTable.java index fe9801eb..b1ed8614 100644 --- a/src/main/java/com/youlai/boot/codegen/model/entity/GenTable.java +++ b/src/main/java/com/youlai/boot/codegen/model/entity/GenTable.java @@ -17,49 +17,31 @@ import lombok.Setter; @Setter public class GenTable extends BaseEntity { - /** - * 表名 - */ + // 表名 private String tableName; - /** - * 包名 - */ + // 包名 private String packageName; - /** - * 模块名 - */ + // 模块名 private String moduleName; - /** - * 实体类名 - */ + // 实体类名 private String entityName; - /** - * 业务名 - */ + // 业务名 private String businessName; - /** - * 父菜单ID - */ + // 父菜单ID private Long parentMenuId; - /** - * 作者 - */ + // 作者 private String author; - /** - * 页面类型 classic|crud - */ + // 页面类型 classic|crud private String pageType; - /** - * 要移除的表前缀,如: sys_ - */ + // 要移除的表前缀,如: sys_ private String removeTablePrefix; } diff --git a/src/main/java/com/youlai/boot/codegen/model/entity/GenTableColumn.java b/src/main/java/com/youlai/boot/codegen/model/entity/GenTableColumn.java index a2640747..ff4100c7 100644 --- a/src/main/java/com/youlai/boot/codegen/model/entity/GenTableColumn.java +++ b/src/main/java/com/youlai/boot/codegen/model/entity/GenTableColumn.java @@ -22,86 +22,54 @@ import lombok.Setter; public class GenTableColumn extends BaseEntity { - /** - * 关联的表配置ID - */ + // 关联的表配置ID private Long tableId; - /** - * 列名 - */ + // 列名 private String columnName; - /** - * 列类型 - */ + // 列类型 private String columnType; - /** - * 字段长度 - */ + // 字段长度 private Long maxLength; - /** - * 字段名称 - */ + // 字段名称 private String fieldName; - /** - * 字段排序 - */ + // 字段排序 private Integer fieldSort; - /** - * 字段类型 - */ + // 字段类型 private String fieldType; - /** - * 字段描述 - */ + // 字段描述 private String fieldComment; - /** - * 表单类型 - */ + // 表单类型 private FormTypeEnum formType; - /** - * 查询方式 - */ + // 查询方式 private QueryTypeEnum queryType; - /** - * 是否在列表显示 - */ + // 是否在列表显示 private Integer isShowInList; - /** - * 是否在表单显示 - */ + // 是否在表单显示 private Integer isShowInForm; - /** - * 是否在查询条件显示 - */ + // 是否在查询条件显示 private Integer isShowInQuery; - /** - * 是否必填 - */ + // 是否必填 private Integer isRequired; - /** - * TypeScript类型 - */ + // TypeScript类型 @TableField(exist = false) @JsonIgnore private String tsType; - /** - * 字典类型 - */ + // 字典类型 private String dictType; } diff --git a/src/main/java/com/youlai/boot/codegen/model/query/TablePageQuery.java b/src/main/java/com/youlai/boot/codegen/model/query/TablePageQuery.java index 51b88c96..119fefbe 100644 --- a/src/main/java/com/youlai/boot/codegen/model/query/TablePageQuery.java +++ b/src/main/java/com/youlai/boot/codegen/model/query/TablePageQuery.java @@ -22,9 +22,7 @@ public class TablePageQuery extends BaseQuery { @Schema(description="关键字(表名)") private String keywords; - /** - * 排除的表名 - */ + // 排除的表名 @JsonIgnore private List excludeTables; diff --git a/src/main/java/com/youlai/boot/codegen/model/query/TableQuery.java b/src/main/java/com/youlai/boot/codegen/model/query/TableQuery.java index 031aa2cc..32c0b2d0 100644 --- a/src/main/java/com/youlai/boot/codegen/model/query/TableQuery.java +++ b/src/main/java/com/youlai/boot/codegen/model/query/TableQuery.java @@ -22,9 +22,7 @@ public class TableQuery extends BaseQuery { @Schema(description="关键字(表名)") private String keywords; - /** - * 排除的表名 - */ + // 排除的表名 @JsonIgnore private List excludeTables; diff --git a/src/main/java/com/youlai/boot/codegen/model/vo/GenConfigAiVO.java b/src/main/java/com/youlai/boot/codegen/model/vo/GenConfigAiVO.java index 86b04871..afcdfd7f 100644 --- a/src/main/java/com/youlai/boot/codegen/model/vo/GenConfigAiVO.java +++ b/src/main/java/com/youlai/boot/codegen/model/vo/GenConfigAiVO.java @@ -13,10 +13,10 @@ import java.util.List; @Data public class GenConfigAiVO { - /** 业务名 */ + // 业务名 private String businessName; - /** 字段配置列表 */ + // 字段配置列表 private List fieldConfigs; /** @@ -25,31 +25,31 @@ public class GenConfigAiVO { @Data public static class FieldAiVO { - /** 列名,须与入参一致 */ + // 列名,须与入参一致 private String columnName; - /** 字段描述 */ + // 字段描述 private String fieldComment; - /** 表单类型枚举名 */ + // 表单类型枚举名 private String formType; - /** 查询类型枚举名 */ + // 查询类型枚举名 private String queryType; - /** 是否必填 */ + // 是否必填 private Integer isRequired; - /** 是否在列表显示 */ + // 是否在列表显示 private Integer isShowInList; - /** 是否在表单显示 */ + // 是否在表单显示 private Integer isShowInForm; - /** 是否在查询条件显示 */ + // 是否在查询条件显示 private Integer isShowInQuery; - /** 字典类型编码 */ + // 字典类型编码 private String dictType; } } diff --git a/src/main/java/com/youlai/boot/codegen/property/CodegenProperties.java b/src/main/java/com/youlai/boot/codegen/property/CodegenProperties.java index 70e44d91..67ae9736 100644 --- a/src/main/java/com/youlai/boot/codegen/property/CodegenProperties.java +++ b/src/main/java/com/youlai/boot/codegen/property/CodegenProperties.java @@ -21,34 +21,22 @@ import java.util.Map; public class CodegenProperties { - /** - * 默认配置 - */ + // 默认配置 private DefaultConfig defaultConfig ; - /** - * 模板配置 - */ + // 模板配置 private Map templateConfigs = MapUtil.newHashMap(true); - /** - * 后端应用名 - */ + // 后端应用名 private String backendAppName; - /** - * 前端应用名 - */ + // 前端应用名 private String frontendAppName; - /** - * 下载文件名 - */ + // 下载文件名 private String downloadFileName; - /** - * 排除数据表 - */ + // 排除数据表 private List excludeTables; /** @@ -57,19 +45,13 @@ public class CodegenProperties { @Data public static class TemplateConfig { - /** - * 模板路径,相对模板根 classpath:codegen (e.g. backend/controller.java.vm) - */ + // 模板路径,相对模板根 classpath:codegen (e.g. backend/controller.java.vm) private String templatePath; - /** - * 子包名 (e.g. controller/service/mapper/model) - */ + // 子包名 (e.g. controller/service/mapper/model) private String subpackageName; - /** - * 文件扩展名,如 .java - */ + // 文件扩展名,如 .java private String extension = FileNameUtil.EXT_JAVA; } @@ -80,14 +62,10 @@ public class CodegenProperties { @Data public static class DefaultConfig { - /** - * 作者 (e.g. Ray) - */ + // 作者 (e.g. Ray) private String author; - /** - * 默认模块名(e.g. system) - */ + // 默认模块名(e.g. system) private String moduleName; } diff --git a/src/main/java/com/youlai/boot/codegen/service/impl/CodegenServiceImpl.java b/src/main/java/com/youlai/boot/codegen/service/impl/CodegenServiceImpl.java index faad72d3..37f88c40 100644 --- a/src/main/java/com/youlai/boot/codegen/service/impl/CodegenServiceImpl.java +++ b/src/main/java/com/youlai/boot/codegen/service/impl/CodegenServiceImpl.java @@ -38,10 +38,6 @@ import java.util.zip.ZipOutputStream; /** * 代码生成服务实现类。 * - *

- * 根据代码生成配置({@link CodegenProperties})与表/字段元数据,渲染模板并提供预览与下载能力。 - *

- * * @author Ray * @since 2.10.0 */ @@ -207,8 +203,6 @@ public class CodegenServiceImpl implements CodegenService { /** * 生成文件名。 * - *

部分模板需要使用约定的命名规则(例如前端 API 文件)。

- * * @param entityName 实体名(例如 User) * @param templateName 模板名(例如 Entity、Controller、API) * @param extension 文件后缀(例如 .java、.ts) diff --git a/src/main/java/com/youlai/boot/codegen/service/impl/GenTableServiceImpl.java b/src/main/java/com/youlai/boot/codegen/service/impl/GenTableServiceImpl.java index aaf0261e..f00a0c04 100644 --- a/src/main/java/com/youlai/boot/codegen/service/impl/GenTableServiceImpl.java +++ b/src/main/java/com/youlai/boot/codegen/service/impl/GenTableServiceImpl.java @@ -52,7 +52,7 @@ import java.util.stream.Collectors; @RequiredArgsConstructor public class GenTableServiceImpl extends ServiceImpl implements GenTableService { - /** 系统提示词名称,对应 resources/prompts 下的相对路径 */ + // 系统提示词名称,对应 resources/prompts 下的相对路径 private static final String SYSTEM_PROMPT_PATH = "codegen/system.md"; private final DatabaseMapper databaseMapper; diff --git a/src/main/java/com/youlai/boot/common/base/BaseEntity.java b/src/main/java/com/youlai/boot/common/base/BaseEntity.java index 67f898f6..48c81ace 100644 --- a/src/main/java/com/youlai/boot/common/base/BaseEntity.java +++ b/src/main/java/com/youlai/boot/common/base/BaseEntity.java @@ -14,9 +14,6 @@ import java.time.LocalDateTime; /** * 基础实体类 * - *

包含主键和创建/更新时间,适用于所有实体(含关联表)

- *

审计字段(createBy/updateBy)和逻辑删除字段(isDeleted)由需要的实体自行声明

- * * @author Ray.Hao * @since 4.3.1 */ @@ -26,22 +23,16 @@ public class BaseEntity implements Serializable { @Serial private static final long serialVersionUID = 1L; - /** - * 主键ID - */ + // 主键ID @TableId(type = IdType.AUTO) private Long id; - /** - * 创建时间 - */ + // 创建时间 @TableField(fill = FieldFill.INSERT) @JsonInclude(value = JsonInclude.Include.NON_NULL) private LocalDateTime createTime; - /** - * 更新时间 - */ + // 更新时间 @TableField(fill = FieldFill.INSERT_UPDATE) @JsonInclude(value = JsonInclude.Include.NON_NULL) private LocalDateTime updateTime; diff --git a/src/main/java/com/youlai/boot/common/constant/JwtClaimConstants.java b/src/main/java/com/youlai/boot/common/constant/JwtClaimConstants.java index 8b9463ef..dbe76442 100644 --- a/src/main/java/com/youlai/boot/common/constant/JwtClaimConstants.java +++ b/src/main/java/com/youlai/boot/common/constant/JwtClaimConstants.java @@ -8,39 +8,22 @@ package com.youlai.boot.common.constant; */ public interface JwtClaimConstants { - /** - * 令牌类型 - */ + // 令牌类型 String TOKEN_TYPE = "tokenType"; - /** - * 用户ID - */ + // 用户ID String USER_ID = "userId"; - /** - * 部门ID - */ + // 部门ID String DEPT_ID = "deptId"; - /** - * 数据权限列表 - *

- * 存储用户所有角色的数据权限范围,用于实现多角色权限合并(并集策略) - */ + // 数据权限列表 String DATA_SCOPES = "dataScopes"; - /** - * 角色编码集合(不带 ROLE_ 前缀) - */ + // 角色编码集合(不带 ROLE_ 前缀) String ROLES = "roles"; - /** - * Token 版本号 - *

- * 用于用户级会话失效,当用户修改密码、被禁用、强制下线时递增版本号, - * 使该用户之前签发的所有 Token 失效。 - */ + // Token 版本号 String TOKEN_VERSION = "tokenVersion"; } diff --git a/src/main/java/com/youlai/boot/common/constant/RedisConstants.java b/src/main/java/com/youlai/boot/common/constant/RedisConstants.java index 7ddd87b6..45c91c2f 100644 --- a/src/main/java/com/youlai/boot/common/constant/RedisConstants.java +++ b/src/main/java/com/youlai/boot/common/constant/RedisConstants.java @@ -12,10 +12,10 @@ public interface RedisConstants { * 限流相关键 */ interface RateLimit { - /** 接口级限流 Key(示例:rate_limit:api:{user}:{uri}) */ + // 接口级限流 Key(示例:rate_limit:api:{user}:{uri}) String API = "rate_limit:api:{}:{}"; - /** IP 全局限流 Key(示例:rate_limit:ip:192.168.1.100) */ + // IP 全局限流 Key(示例:rate_limit:ip:192.168.1.100) String IP = "rate_limit:ip:{}"; } @@ -70,9 +70,9 @@ public interface RedisConstants { * 表单模块 */ interface Form { - /** 已发布表单渲染规则(formKey -> FormRenderVO,发布/停用/改规则/删除时主动失效) */ + // 已发布表单渲染规则(formKey -> FormRenderVO,发布/停用/改规则/删除时主动失效) String RENDER_RULE = "form:render:{}"; - /** 公开表单匿名提交计数(formKey:ip 维度滑动窗口,防刷限流) */ + // 公开表单匿名提交计数(formKey:ip 维度滑动窗口,防刷限流) String PUBLIC_SUBMIT_COUNT = "form:public:submit:{}:{}"; } diff --git a/src/main/java/com/youlai/boot/common/constant/SecurityConstants.java b/src/main/java/com/youlai/boot/common/constant/SecurityConstants.java index 3301a297..8082b2f0 100644 --- a/src/main/java/com/youlai/boot/common/constant/SecurityConstants.java +++ b/src/main/java/com/youlai/boot/common/constant/SecurityConstants.java @@ -8,18 +8,12 @@ package com.youlai.boot.common.constant; */ public interface SecurityConstants { - /** - * 登录路径 - */ + // 登录路径 String LOGIN_PATH = "/api/v1/auth/login"; - /** - * JWT Token 前缀 - */ + // JWT Token 前缀 String BEARER_TOKEN_PREFIX = "Bearer "; - /** - * 角色前缀,用于区分 authorities 角色和权限, ROLE_* 角色 、没有前缀的是权限 - */ + // 角色前缀,用于区分 authorities 角色和权限, ROLE_* 角色 、没有前缀的是权限 String ROLE_PREFIX = "ROLE_"; } diff --git a/src/main/java/com/youlai/boot/common/constant/SystemConstants.java b/src/main/java/com/youlai/boot/common/constant/SystemConstants.java index 9933de48..97544d7e 100644 --- a/src/main/java/com/youlai/boot/common/constant/SystemConstants.java +++ b/src/main/java/com/youlai/boot/common/constant/SystemConstants.java @@ -8,19 +8,13 @@ package com.youlai.boot.common.constant; */ public interface SystemConstants { - /** - * 根节点ID - */ + // 根节点ID Long ROOT_NODE_ID = 0L; - /** - * 系统默认密码 - */ + // 系统默认密码 String DEFAULT_PASSWORD = "123456"; - /** - * 超级管理员角色编码 - */ + // 超级管理员角色编码 String ROOT_ROLE_CODE = "ROOT"; } diff --git a/src/main/java/com/youlai/boot/common/enums/DataScopeEnum.java b/src/main/java/com/youlai/boot/common/enums/DataScopeEnum.java index 37a2636a..0f135e19 100644 --- a/src/main/java/com/youlai/boot/common/enums/DataScopeEnum.java +++ b/src/main/java/com/youlai/boot/common/enums/DataScopeEnum.java @@ -5,9 +5,6 @@ import lombok.Getter; /** * 数据权限枚举 - *

- * 多角色数据权限合并策略:取并集(OR),即用户能看到所有角色权限范围内的数据。 - * 如果任一角色是 ALL,则直接跳过数据权限过滤。 * * @author Ray.Hao * @since 2.3.0 @@ -37,8 +34,6 @@ public enum DataScopeEnum implements IBaseEnum { /** * 自定义部门数据 - 可查看指定部门的数据 - *

- * 需要配合 sys_role_dept 表使用,存储角色可访问的部门ID列表 */ CUSTOM(5, "自定义部门数据"); diff --git a/src/main/java/com/youlai/boot/common/enums/SocialPlatformEnum.java b/src/main/java/com/youlai/boot/common/enums/SocialPlatformEnum.java index 973b57f4..02708922 100644 --- a/src/main/java/com/youlai/boot/common/enums/SocialPlatformEnum.java +++ b/src/main/java/com/youlai/boot/common/enums/SocialPlatformEnum.java @@ -6,8 +6,6 @@ import lombok.Getter; /** * 第三方登录平台类型枚举。 - *

- * value 作为 MyBatis-Plus 枚举值持久化到数据库。 * * @author Ray.Hao * @since 2.17.0 diff --git a/src/main/java/com/youlai/boot/common/exception/DataPermissionException.java b/src/main/java/com/youlai/boot/common/exception/DataPermissionException.java index 1598e2b1..b16b3215 100644 --- a/src/main/java/com/youlai/boot/common/exception/DataPermissionException.java +++ b/src/main/java/com/youlai/boot/common/exception/DataPermissionException.java @@ -4,8 +4,6 @@ import lombok.Getter; /** * 数据权限异常 - *

- * 当数据权限拦截器拼接SQL条件失败时抛出,属于系统级异常,非业务异常。 * * @author zc * @since 2.0.0 diff --git a/src/main/java/com/youlai/boot/common/result/ExcelResult.java b/src/main/java/com/youlai/boot/common/result/ExcelResult.java index d9d6590a..ec858e90 100644 --- a/src/main/java/com/youlai/boot/common/result/ExcelResult.java +++ b/src/main/java/com/youlai/boot/common/result/ExcelResult.java @@ -14,24 +14,16 @@ import java.util.List; @Data public class ExcelResult { - /** - * 响应码,来确定是否导入成功 - */ + // 响应码,来确定是否导入成功 private String code; - /** - * 有效条数 - */ + // 有效条数 private Integer validCount; - /** - * 无效条数 - */ + // 无效条数 private Integer invalidCount; - /** - * 错误提示信息 - */ + // 错误提示信息 private List messageList; public ExcelResult() { diff --git a/src/main/java/com/youlai/boot/common/result/PageResult.java b/src/main/java/com/youlai/boot/common/result/PageResult.java index 3b453d19..b9df6bf0 100644 --- a/src/main/java/com/youlai/boot/common/result/PageResult.java +++ b/src/main/java/com/youlai/boot/common/result/PageResult.java @@ -24,8 +24,6 @@ public class PageResult implements Serializable { /** * 构建分页结果(MyBatis-Plus {@link IPage})。 - * - *

list 为当前页记录列表,total 为符合条件的总记录数。

*/ public static PageResult success(IPage page) { PageResult result = new PageResult<>(); @@ -46,8 +44,6 @@ public class PageResult implements Serializable { /** * 构建列表结果(无分页)。 - * - *

total 固定为 0,用于与分页返回区分。

*/ public static PageResult success(List list) { PageResult result = new PageResult<>(); diff --git a/src/main/java/com/youlai/boot/common/result/ResultCode.java b/src/main/java/com/youlai/boot/common/result/ResultCode.java index 1469802f..4a91fe77 100644 --- a/src/main/java/com/youlai/boot/common/result/ResultCode.java +++ b/src/main/java/com/youlai/boot/common/result/ResultCode.java @@ -4,48 +4,6 @@ import java.io.Serializable; /** * 响应码枚举 - *

- * 参考《阿里巴巴 Java 开发手册》错误码设计建议: - * 00000 表示成功。 - * A**** 表示用户端错误(如参数错误、认证失败等)。 - * B**** 表示当前系统执行出错(如系统超时等)。 - * C**** 表示调用第三方服务出错(如中间件、数据库等外部依赖)。 - *

- * 错误码位数与号段说明: - * - 错误码为字符串类型,共 5 位:错误产生来源(A/B/C) + 四位数字编号。 - * - 四位数字编号范围 0001~9999,大类之间建议按步长 100 预留号段(如 A0200、A0300、A0400)。 - * - 错误码后三位编号与 HTTP 状态码无关。 - *

- * 说明: - * - 本项目仅保留实际使用的错误码,A/B/C 各保留少量示例。 - * - 如需扩展业务错误码,建议在对应宏观分类下按场景划分号段并保持全局唯一。 - *

- * 附表(节选):错误码列表(示例/项目使用项) - *

- * | 错误码 | 中文描述             | 说明             |
- * |-------|----------------------|------------------|
- * | 00000 | 成功                 | 正常执行后的返回 |
- * | A0001 | 用户端错误           | 一级宏观错误码   |
- * | A0100 | 用户注册错误         | 二级宏观错误码   |
- * | A0101 | 用户未同意隐私协议   | 二级宏观错误码   |
- * | A0200 | 用户登录异常         | 二级宏观错误码   |
- * | A0201 | 用户账户不存在       | 二级宏观错误码   |
- * | A0202 | 用户账户被冻结       | 二级宏观错误码   |
- * | A0230 | 访问令牌无效或已过期 | 令牌校验失败     |
- * | A0241 | 用户验证码尝试次数超限 | 二级宏观错误码   |
- * | A0300 | 访问权限异常         | 二级宏观错误码   |
- * | A0301 | 访问未授权           | 二级宏观错误码   |
- * | A0400 | 用户请求参数错误     | 二级宏观错误码   |
- * | A0410 | 请求必填参数为空     | 二级宏观错误码   |
- * | A0500 | 用户请求服务异常     | 二级宏观错误码   |
- * | A0502 | 请求并发数超出限制   | 二级宏观错误码   |
- * | A0506 | 请勿重复提交         | 二级宏观错误码   |
- * | B0001 | 系统执行出错         | 一级宏观错误码   |
- * | B0100 | 系统执行超时         | 二级宏观错误码   |
- * | C0001 | 调用第三方服务出错   | 一级宏观错误码   |
- * | C0113 | 接口不存在           | 二级宏观错误码   |
- * | C0300 | 数据库服务出错       | 二级宏观错误码   |
- * 
* * @author Ray.Hao * @since 4.3.1 diff --git a/src/main/java/com/youlai/boot/config/JacksonConfig.java b/src/main/java/com/youlai/boot/config/JacksonConfig.java index ce221e06..6fd3dafd 100644 --- a/src/main/java/com/youlai/boot/config/JacksonConfig.java +++ b/src/main/java/com/youlai/boot/config/JacksonConfig.java @@ -14,11 +14,6 @@ import java.util.TimeZone; /** * Jackson 全局序列化配置 * - *

本项目的统一序列化策略: - *
- 统一时区 GMT+8 统一日期格式 yyyy-MM-dd HH:mm:ss - *
- Long/BigInteger 序列化为字符串,避免前端精度丢失 - *
- 禁用 WRITE_DATES_AS_TIMESTAMPS,避免日期输出为时间戳

- * * @author Ray.Hao * @since 2026/1/12 */ diff --git a/src/main/java/com/youlai/boot/config/RedisCacheConfig.java b/src/main/java/com/youlai/boot/config/RedisCacheConfig.java index f7665976..bd8883d9 100644 --- a/src/main/java/com/youlai/boot/config/RedisCacheConfig.java +++ b/src/main/java/com/youlai/boot/config/RedisCacheConfig.java @@ -27,8 +27,6 @@ public class RedisCacheConfig { /** * 自定义 RedisCacheManager - *

- * 修改 Redis 序列化方式,默认 JdkSerializationRedisSerializer * * @param redisConnectionFactory {@link RedisConnectionFactory} * @param cacheProperties {@link CacheProperties} diff --git a/src/main/java/com/youlai/boot/config/RedisConfig.java b/src/main/java/com/youlai/boot/config/RedisConfig.java index c821d5ef..ab6baa10 100644 --- a/src/main/java/com/youlai/boot/config/RedisConfig.java +++ b/src/main/java/com/youlai/boot/config/RedisConfig.java @@ -20,8 +20,6 @@ public class RedisConfig { /** * 自定义 RedisTemplate - *

- * 修改 Redis 序列化方式,默认 JdkSerializationRedisSerializer * * @param redisConnectionFactory {@link RedisConnectionFactory} * @return {@link RedisTemplate} diff --git a/src/main/java/com/youlai/boot/framework/mybatis/MetaFieldFillHandler.java b/src/main/java/com/youlai/boot/framework/mybatis/MetaFieldFillHandler.java index cc8fe5c5..20bf973e 100644 --- a/src/main/java/com/youlai/boot/framework/mybatis/MetaFieldFillHandler.java +++ b/src/main/java/com/youlai/boot/framework/mybatis/MetaFieldFillHandler.java @@ -10,9 +10,6 @@ import java.time.LocalDateTime; /** * MyBatis-Plus 字段自动填充 * - *

自动填充 createTime/updateTime(时间戳)和 createBy/updateBy(操作人ID)

- *

实体字段需标注 {@code @TableField(fill = FieldFill.INSERT)} 或 {@code FieldFill.INSERT_UPDATE} 才会触发

- * * @author Ray.Hao * @since 3.0.0 */ diff --git a/src/main/java/com/youlai/boot/framework/mybatis/MyDataPermissionHandler.java b/src/main/java/com/youlai/boot/framework/mybatis/MyDataPermissionHandler.java index 38ac05db..14dc08d6 100644 --- a/src/main/java/com/youlai/boot/framework/mybatis/MyDataPermissionHandler.java +++ b/src/main/java/com/youlai/boot/framework/mybatis/MyDataPermissionHandler.java @@ -24,12 +24,6 @@ import java.util.List; /** * 数据权限处理器 - *

- * 支持多角色数据权限合并(并集策略): - * - 如果任一角色是 ALL,则跳过数据权限过滤 - * - 否则用 OR 连接各角色的数据权限条件 - *

- * 使用 JSQLParser 构建 SQL 条件,避免字符串拼接,提高代码安全性和可读性。 * * @author Ray.Hao * @since 2021/12/10 @@ -108,8 +102,6 @@ public class MyDataPermissionHandler implements DataPermissionHandler { /** * 使用并集策略进行数据权限过滤 - *

- * 多个角色的数据权限通过 OR 连接,实现并集效果 * * @param annotation 数据权限注解 * @param dataScopes 数据权限列表 @@ -158,8 +150,6 @@ public class MyDataPermissionHandler implements DataPermissionHandler { /** * 构建单个角色的数据权限SQL条件 - *

- * 使用 JSQLParser 构建 Expression,避免字符串拼接 * * @param deptAlias 部门表别名 * @param deptIdColumnName 部门ID字段名 @@ -221,8 +211,6 @@ public class MyDataPermissionHandler implements DataPermissionHandler { /** * 构建部门及子部门数据权限条件 - *

- * SQL: dept_id IN (SELECT id FROM sys_dept WHERE id = ? OR FIND_IN_SET(?, tree_path)) * * @param deptColumn 部门列 * @param deptId 部门ID @@ -230,8 +218,7 @@ public class MyDataPermissionHandler implements DataPermissionHandler { */ @SneakyThrows private Expression buildDeptAndSubExpression(Column deptColumn, Long deptId) { - // 使用字符串解析,避免不同 JSqlParser 版本下 InExpression/ItemsList 渲染差异导致 SQL 语法错误 - // SQL: dept_id IN (SELECT id FROM sys_dept WHERE id = ? OR FIND_IN_SET(?, tree_path)) + // 直接拼 SQL 字符串解析,规避 JSqlParser 版本间表达式渲染差异 String columnName = deptColumn.toString(); String sql = columnName + " IN (SELECT " + DEPT_ID_COLUMN + " FROM " + DEPT_TABLE + " WHERE " + DEPT_ID_COLUMN + " = " + deptId + @@ -241,8 +228,6 @@ public class MyDataPermissionHandler implements DataPermissionHandler { /** * 构建自定义部门数据权限条件 - *

- * SQL: dept_id IN (?, ?, ...) * * @param deptColumn 部门列 * @param customDeptIds 自定义部门ID列表 diff --git a/src/main/java/com/youlai/boot/framework/security/config/SecurityProperties.java b/src/main/java/com/youlai/boot/framework/security/config/SecurityProperties.java index a68ebb83..2e5e3cce 100644 --- a/src/main/java/com/youlai/boot/framework/security/config/SecurityProperties.java +++ b/src/main/java/com/youlai/boot/framework/security/config/SecurityProperties.java @@ -13,8 +13,6 @@ import org.springframework.stereotype.Component; /** * 安全模块配置属性类 * - *

映射 application.yml 中 security 前缀的安全相关配置

- * * @author Ray.Hao * @since 2024/4/18 */ @@ -24,17 +22,12 @@ import org.springframework.stereotype.Component; @ConfigurationProperties(prefix = "security") public class SecurityProperties { - /** - * 令牌策略配置 - */ + // 令牌策略配置 @Valid @NotNull(message = "令牌策略配置不能为空") private TokenConfig token; - /** - * 匿名放行路径(仍经过安全过滤器链,仅跳过认证与授权判断,保留安全响应头) - *

示例值:/api/v1/auth/login/**, /doc.html

- */ + // 匿名放行路径(仍经过安全过滤器链,仅跳过认证与授权判断,保留安全响应头) @NotEmpty private String[] permitAllUrls; @@ -43,42 +36,24 @@ public class SecurityProperties { */ @Data public static class TokenConfig { - /** - * 令牌策略类型 - *
    - *
  • jwt - 基于JWT的无状态认证
  • - *
  • redis-token - 基于Redis的有状态认证
  • - *
- */ + // 令牌策略类型 @NotNull(message = "令牌类型不能为空") @Pattern(regexp = "jwt|redis-token", message = "令牌类型只能是 jwt 或 redis-token") private String type; - /** - * 访问令牌有效期(单位:秒) - *

默认值:3600(1小时)

- *

-1 表示永不过期

- */ + // 访问令牌有效期(单位:秒) @Min(-1) private Integer accessTokenTimeToLive = 3600; - /** - * 刷新令牌有效期(单位:秒) - *

默认值:604800(7天)

- *

-1 表示永不过期

- */ + // 刷新令牌有效期(单位:秒) @Min(-1) private Integer refreshTokenTimeToLive = 604800; - /** - * JWT 配置项(type 为 jwt 时必填) - */ + // JWT 配置项(type 为 jwt 时必填) @Valid private JwtConfig jwt; - /** - * Redis令牌配置项(type 为 redis-token 时使用) - */ + // Redis令牌配置项(type 为 redis-token 时使用) @Valid private RedisTokenConfig redisToken; } @@ -88,11 +63,7 @@ public class SecurityProperties { */ @Data public static class JwtConfig { - /** - * JWT签名密钥 - *

HS256算法要求至少32个字符

- *

示例:SecretKey012345678901234567890123456789

- */ + // JWT签名密钥 @NotNull(message = "JWT 密钥不能为空") private String secretKey; } @@ -102,11 +73,7 @@ public class SecurityProperties { */ @Data public static class RedisTokenConfig { - /** - * 是否允许多设备同时登录 - *

true - 允许同一账户多设备登录(默认)

- *

false - 新登录会使旧令牌失效

- */ + // 是否允许多设备同时登录 private Boolean allowMultiLogin = true; } } diff --git a/src/main/java/com/youlai/boot/framework/security/filter/TokenAuthenticationFilter.java b/src/main/java/com/youlai/boot/framework/security/filter/TokenAuthenticationFilter.java index c4298f35..ef134da1 100644 --- a/src/main/java/com/youlai/boot/framework/security/filter/TokenAuthenticationFilter.java +++ b/src/main/java/com/youlai/boot/framework/security/filter/TokenAuthenticationFilter.java @@ -18,13 +18,6 @@ import java.io.IOException; /** * Token 认证过滤器。 - *

- * 仅负责解析 Token 和填充 {@link SecurityContextHolder}。 - * 无效 Token 抛出 {@link AuthenticationException},由使用方的 - * {@code AuthenticationEntryPoint} 统一处理响应格式。 - *

- * 必须注册在 {@code ExceptionTranslationFilter} 之后(即 {@code AuthorizationFilter} 之前), - * 这样抛出的异常才能被 {@code ExceptionTranslationFilter} 捕获。 * * @author wangtao * @since 2025/3/6 diff --git a/src/main/java/com/youlai/boot/framework/security/model/RoleDataScope.java b/src/main/java/com/youlai/boot/framework/security/model/RoleDataScope.java index 2fbcb6ba..26f2c6ff 100644 --- a/src/main/java/com/youlai/boot/framework/security/model/RoleDataScope.java +++ b/src/main/java/com/youlai/boot/framework/security/model/RoleDataScope.java @@ -9,8 +9,6 @@ import java.util.List; /** * 角色数据权限信息 - *

- * 用于存储单个角色的数据权限范围信息,支持多角色数据权限合并(并集策略) * * @author Ray.Hao * @since 3.0.0 @@ -22,20 +20,13 @@ public class RoleDataScope implements Serializable { private static final long serialVersionUID = 1L; - /** - * 角色编码 - */ + // 角色编码 private String roleCode; - /** - * 数据权限范围值 - * 1-所有数据 2-部门及子部门数据 3-本部门数据 4-本人数据 5-自定义部门数据 - */ + // 数据权限范围值 private Integer dataScope; - /** - * 自定义部门ID列表(仅当 dataScope=5 时有效) - */ + // 自定义部门ID列表(仅当 dataScope=5 时有效) private List customDeptIds; /** diff --git a/src/main/java/com/youlai/boot/framework/security/model/SecurityUser.java b/src/main/java/com/youlai/boot/framework/security/model/SecurityUser.java index 96ee67ef..c0680a3b 100644 --- a/src/main/java/com/youlai/boot/framework/security/model/SecurityUser.java +++ b/src/main/java/com/youlai/boot/framework/security/model/SecurityUser.java @@ -7,9 +7,6 @@ import java.util.Set; /** * 安全模块用户数据 POJO。 - *

- * 作为端口接口的返回类型,承载用户认证所需的全部数据。 - * 纯 JDK 类型,无 system 模块依赖,可直接序列化。 * * @author Ray.Hao * @since 2025/12/16 @@ -17,50 +14,30 @@ import java.util.Set; @Data public class SecurityUser { - /** - * 用户ID - */ + // 用户ID private Long userId; - /** - * 用户名 - */ + // 用户名 private String username; - /** - * 昵称 - */ + // 昵称 private String nickname; - /** - * 部门ID - */ + // 部门ID private Long deptId; - /** - * 密码(加密后) - */ + // 密码(加密后) private String password; - /** - * 状态(1:启用 其它:禁用) - */ + // 状态(1:启用 其它:禁用) private Integer status; - /** - * 头像 URL - */ + // 头像 URL private String avatar; - /** - * 角色编码集合 - */ + // 角色编码集合 private Set roles; - /** - * 数据权限列表 - *

- * 存储用户所有角色的数据权限范围,用于实现多角色权限合并(并集策略) - */ + // 数据权限列表 private List dataScopes; } diff --git a/src/main/java/com/youlai/boot/framework/security/model/SecurityUserDetails.java b/src/main/java/com/youlai/boot/framework/security/model/SecurityUserDetails.java index eeecd5f3..dcdbefa8 100644 --- a/src/main/java/com/youlai/boot/framework/security/model/SecurityUserDetails.java +++ b/src/main/java/com/youlai/boot/framework/security/model/SecurityUserDetails.java @@ -14,10 +14,6 @@ import java.util.stream.Collectors; /** * Spring Security 用户认证对象。 - *

- * 实现 {@link UserDetails},封装用户标识、角色、数据权限等认证信息。 - * {@link #roles} 字段存储角色编码(不带 ROLE_ 前缀), - * {@link #getAuthorities()} 运行时补前缀并转为 {@link SimpleGrantedAuthority}。 * * @author Ray.Hao * @version 3.0.0 @@ -26,39 +22,25 @@ import java.util.stream.Collectors; @NoArgsConstructor public class SecurityUserDetails implements UserDetails { - /** - * 用户ID - */ + // 用户ID private Long userId; - /** - * 用户名 - */ + // 用户名 private String username; - /** - * 密码 - */ + // 密码 private String password; - /** - * 账号是否启用(true:启用 false:禁用) - */ + // 账号是否启用(true:启用 false:禁用) private Boolean enabled; - /** - * 部门ID - */ + // 部门ID private Long deptId; - /** - * 数据权限列表 - */ + // 数据权限列表 private List dataScopes; - /** - * 角色编码集合(不带 ROLE_ 前缀) - */ + // 角色编码集合(不带 ROLE_ 前缀) private Set roles; /** diff --git a/src/main/java/com/youlai/boot/framework/security/port/PermissionPort.java b/src/main/java/com/youlai/boot/framework/security/port/PermissionPort.java index 0176ebf7..79fdfc80 100644 --- a/src/main/java/com/youlai/boot/framework/security/port/PermissionPort.java +++ b/src/main/java/com/youlai/boot/framework/security/port/PermissionPort.java @@ -4,9 +4,6 @@ import java.util.Set; /** * 权限查询端口。 - *

- * 由 system 模块提供适配器实现,framework 层通过此接口获取角色权限集合, - * 不直接依赖 system 模块的 {@code RoleMenuService}。 * * @see com.youlai.boot.system.adapter.security.PermissionAdapter */ diff --git a/src/main/java/com/youlai/boot/framework/security/port/UserAuthenticationPort.java b/src/main/java/com/youlai/boot/framework/security/port/UserAuthenticationPort.java index b57d69cb..dd6ec4fe 100644 --- a/src/main/java/com/youlai/boot/framework/security/port/UserAuthenticationPort.java +++ b/src/main/java/com/youlai/boot/framework/security/port/UserAuthenticationPort.java @@ -5,9 +5,6 @@ import com.youlai.boot.framework.security.model.SecurityUser; /** * 用户认证信息查询端口。 - *

- * 由 system 模块提供适配器实现,framework 层通过此接口获取认证数据, - * 不直接依赖 system 模块的 {@code UserService} / {@code UserSocialService}。 * * @see com.youlai.boot.system.adapter.security.UserAuthenticationAdapter */ diff --git a/src/main/java/com/youlai/boot/framework/security/service/PermissionService.java b/src/main/java/com/youlai/boot/framework/security/service/PermissionService.java index ef7cc446..074fd1ea 100644 --- a/src/main/java/com/youlai/boot/framework/security/service/PermissionService.java +++ b/src/main/java/com/youlai/boot/framework/security/service/PermissionService.java @@ -13,9 +13,6 @@ import java.util.Set; /** * Spring Security 权限校验组件。 - *

- * 用于 SpEL 表达式:{@code @PreAuthorize("@ss.hasPerm('sys:user:create')")}。 - * 通过 {@link PermissionPort} 查询角色权限,不直接依赖 system 模块。 * * @author Ray.Hao * @since 0.0.1 diff --git a/src/main/java/com/youlai/boot/framework/security/service/SecurityUserDetailsService.java b/src/main/java/com/youlai/boot/framework/security/service/SecurityUserDetailsService.java index 9b998c22..1dc4ced6 100644 --- a/src/main/java/com/youlai/boot/framework/security/service/SecurityUserDetailsService.java +++ b/src/main/java/com/youlai/boot/framework/security/service/SecurityUserDetailsService.java @@ -12,8 +12,6 @@ import org.springframework.stereotype.Service; /** * 系统用户认证 DetailsService。 - *

- * 通过 {@link UserAuthenticationPort} 获取认证信息,不直接依赖 system 模块。 * * @author Ray.Hao * @since 2021/10/19 diff --git a/src/main/java/com/youlai/boot/framework/security/token/JwtTokenManager.java b/src/main/java/com/youlai/boot/framework/security/token/JwtTokenManager.java index f9754989..c93e07b2 100644 --- a/src/main/java/com/youlai/boot/framework/security/token/JwtTokenManager.java +++ b/src/main/java/com/youlai/boot/framework/security/token/JwtTokenManager.java @@ -31,11 +31,6 @@ import java.util.stream.Collectors; /** * JWT Token 管理器。 - *

- * 基于 JWT 的无状态认证,支持 Access + Refresh 双令牌、Token 撤销(jti 黑名单)、 - * 用户级会话失效(tokenVersion)、多角色数据权限存储。 - *

- * JWT claims 中存储角色编码(不带 ROLE_ 前缀),解析后由 {@link SecurityUserDetails#getAuthorities()} 运行时补前缀。 * * @author Ray.Hao * @since 2024/11/15 diff --git a/src/main/java/com/youlai/boot/framework/security/token/RedisTokenManager.java b/src/main/java/com/youlai/boot/framework/security/token/RedisTokenManager.java index 54ae7a3c..0ae0f707 100644 --- a/src/main/java/com/youlai/boot/framework/security/token/RedisTokenManager.java +++ b/src/main/java/com/youlai/boot/framework/security/token/RedisTokenManager.java @@ -22,11 +22,6 @@ import java.util.concurrent.TimeUnit; /** * Redis Token 管理器。 - *

- * 基于 Redis 的有状态 Token 认证,支持 Access + Refresh 双令牌、 - * 单/多设备登录控制、用户级会话失效。 - *

- * 直接存取 {@link SecurityUserDetails}(password 置 null),无需 UserSession 中间层。 * * @author Ray.Hao * @since 2024/11/15 diff --git a/src/main/java/com/youlai/boot/framework/security/token/TokenManager.java b/src/main/java/com/youlai/boot/framework/security/token/TokenManager.java index 7aef032e..81d80a5d 100644 --- a/src/main/java/com/youlai/boot/framework/security/token/TokenManager.java +++ b/src/main/java/com/youlai/boot/framework/security/token/TokenManager.java @@ -6,8 +6,6 @@ import org.springframework.security.core.Authentication; /** * Token 管理器 - *

- * 用于生成、解析、校验、刷新 Token * * @author Ray.Hao * @since 2.16.0 @@ -60,8 +58,6 @@ public interface TokenManager { * @param token Token */ default void invalidateToken(String token) { - // 默认实现可以是空的,或者抛出不支持的操作异常 - // throw new UnsupportedOperationException("Not implemented"); } /** diff --git a/src/main/java/com/youlai/boot/framework/security/util/SecurityUtils.java b/src/main/java/com/youlai/boot/framework/security/util/SecurityUtils.java index d4f28d3c..3a25ad59 100644 --- a/src/main/java/com/youlai/boot/framework/security/util/SecurityUtils.java +++ b/src/main/java/com/youlai/boot/framework/security/util/SecurityUtils.java @@ -64,8 +64,6 @@ public class SecurityUtils { /** * 获取角色编码集合,不带 ROLE_ 前缀。 - *

- * 直接从 {@link SecurityUserDetails#getRoles()} 取值,不做 stripping 和过滤。 */ public static Set getRoles() { return getUser().map(SecurityUserDetails::getRoles).orElse(Set.of()); diff --git a/src/main/java/com/youlai/boot/framework/web/filter/IpRateLimitFilter.java b/src/main/java/com/youlai/boot/framework/web/filter/IpRateLimitFilter.java index ed629549..50d8e993 100644 --- a/src/main/java/com/youlai/boot/framework/web/filter/IpRateLimitFilter.java +++ b/src/main/java/com/youlai/boot/framework/web/filter/IpRateLimitFilter.java @@ -22,24 +22,6 @@ import java.io.IOException; /** * IP 全局限流过滤器 - *

- * 在所有请求进入 Controller 之前,按 IP 维度做滑动窗口限流。 - * 与 {@code @RateLimit} 注解级限流叠加:先过 IP 全局,再过接口级。 - *

- * - *

限流维度

- *
{@code
- *   Key: rate_limit:ip:{clientIp}
- *   默认: 1000 req / 60s(可通过 rate-limit.ip.* 配置)
- * }
- * - *

响应头

- * - * - * - * - * - *
X-RateLimit-Limit窗口内最大允许请求数
X-RateLimit-Remaining窗口内剩余可用请求数
X-RateLimit-Reset窗口重置时间(Unix 秒)
Retry-After超限时建议重试等待秒数(仅 429)
* * @author Ray.Hao * @since 4.4.0 diff --git a/src/main/java/com/youlai/boot/framework/web/log/OperationLogPort.java b/src/main/java/com/youlai/boot/framework/web/log/OperationLogPort.java index 3e8ef74c..53709f82 100644 --- a/src/main/java/com/youlai/boot/framework/web/log/OperationLogPort.java +++ b/src/main/java/com/youlai/boot/framework/web/log/OperationLogPort.java @@ -2,7 +2,6 @@ package com.youlai.boot.framework.web.log; /** * 操作日志落库端口 - *

由 {@link com.youlai.boot.system.adapter.log.OperationLogAdapter} 实现

* * @author Ray.Hao * @since 4.7.0 diff --git a/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimit.java b/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimit.java index 8192d1e3..5ed95f94 100644 --- a/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimit.java +++ b/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimit.java @@ -9,8 +9,6 @@ import java.lang.annotation.Target; /** * 接口限流注解 * - *

标注在 Controller 方法上,基于 Redis 滑动窗口实现

- * * @author Ray.Hao * @since 4.3.1 */ @@ -21,15 +19,11 @@ public @interface RateLimit { /** * 窗口内允许的最大请求数。 - *

- * {@code <=0} 时使用全局默认值 {@code rate-limit.default-limit}。 */ int limit() default 0; /** * 滑动窗口大小(秒)。 - *

- * {@code <=0} 时使用全局默认值 {@code rate-limit.default-window}。 */ int window() default 0; } diff --git a/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimitAspect.java b/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimitAspect.java index 8f415dcb..621edb3a 100644 --- a/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimitAspect.java +++ b/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimitAspect.java @@ -21,16 +21,6 @@ import org.springframework.web.context.request.ServletRequestAttributes; /** * 接口级限流切面 - *

- * 对标注了 {@link RateLimit} 的 Controller 方法做 Redis 滑动窗口计数。 - * 超阈值抛出 {@link RateLimitException}(A0502),全局异常处理器统一返回 JSON。 - *

- * - *

升级历史

- *
    - *
  • 4.3.1 — 初始版本:固定窗口计数器
  • - *
  • 4.4.0 — 升级为滑动窗口 + X-RateLimit-* 渐进式响应头
  • - *
* * @author Ray.Hao * @since 4.3.1 diff --git a/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimitProperties.java b/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimitProperties.java index 822eda51..06c2b35b 100644 --- a/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimitProperties.java +++ b/src/main/java/com/youlai/boot/framework/web/ratelimit/RateLimitProperties.java @@ -8,7 +8,6 @@ import java.time.Duration; /** * 限流配置 - *

对应 application.yml 中的 {@code rate-limit} 配置节点。

* * @author Ray.Hao * @since 4.3.1 @@ -18,38 +17,25 @@ import java.time.Duration; @ConfigurationProperties(prefix = "rate-limit") public class RateLimitProperties { - /** - * @RateLimit 注解未显式指定 limit 时的默认阈值(窗口内最大请求数) - */ + // / private int defaultLimit = 5; - /** - * @RateLimit 注解未显式指定 window 时的默认窗口大小,支持 60s / 1m / 500ms 等 Duration 写法 - */ + // / private Duration defaultWindow = Duration.ofSeconds(60); - /** - * IP 全局限流配置 - */ + // IP 全局限流配置 private Ip ip = new Ip(); @Data public static class Ip { - /** - * 是否启用 IP 全局限流。 - * 建议生产环境开启,开发/测试环境酌情关闭。 - */ + // 是否启用 IP 全局限流。 private boolean enabled = true; - /** - * 窗口内最大请求数(默认 1000) - */ + // 窗口内最大请求数(默认 1000) private int limit = 1000; - /** - * 滑动窗口大小,支持 60s / 1m / 500ms 等 Duration 写法(默认 60s) - */ + // 滑动窗口大小,支持 60s / 1m / 500ms 等 Duration 写法(默认 60s) private Duration window = Duration.ofSeconds(60); } diff --git a/src/main/java/com/youlai/boot/framework/web/ratelimit/RedisSlidingWindowRateLimiter.java b/src/main/java/com/youlai/boot/framework/web/ratelimit/RedisSlidingWindowRateLimiter.java index 87530387..5c27bb91 100644 --- a/src/main/java/com/youlai/boot/framework/web/ratelimit/RedisSlidingWindowRateLimiter.java +++ b/src/main/java/com/youlai/boot/framework/web/ratelimit/RedisSlidingWindowRateLimiter.java @@ -12,18 +12,6 @@ import java.util.UUID; /** * Redis 滑动窗口限流器 * - *

基于 Redis Sorted Set 实现原子化的滑动窗口计数: - *

    - *
  1. ZREMRANGEBYSCORE 清除窗口外旧请求
  2. - *
  3. ZADD 添加当前请求
  4. - *
  5. ZCARD 统计窗口内请求数
  6. - *
  7. PEXPIRE 设置 Key 过期(窗口 + 1s 冗余)
  8. - *
- * 一次网络往返完成全部操作,避免多次 Redis 调用之间的竞态条件。

- * - *

Redis 异常时返回 null(本次不计数),调用方统一按 Fail-Open 放行, - * 保证限流组件故障不影响业务可用性。

- * * @author Ray.Hao * @since 4.4.0 */ diff --git a/src/main/java/com/youlai/boot/framework/web/ratelimit/SlidingWindowScript.java b/src/main/java/com/youlai/boot/framework/web/ratelimit/SlidingWindowScript.java index fafe61ad..13cc472f 100644 --- a/src/main/java/com/youlai/boot/framework/web/ratelimit/SlidingWindowScript.java +++ b/src/main/java/com/youlai/boot/framework/web/ratelimit/SlidingWindowScript.java @@ -8,16 +8,6 @@ import java.util.UUID; /** * 滑动窗口限流 Lua 脚本(共享工具) - *

- * 基于 Redis Sorted Set 实现原子化的滑动窗口计数: - *

    - *
  1. ZREMRANGEBYSCORE 清除窗口外旧请求
  2. - *
  3. ZADD 添加当前请求
  4. - *
  5. ZCARD 统计窗口内请求数
  6. - *
  7. PEXPIRE 设置 Key 过期(窗口 + 1s 冗余)
  8. - *
- * 一次网络往返完成全部操作,避免多次 Redis 调用之间的竞态条件。 - *

* * @author Ray.Hao * @since 4.4.0 diff --git a/src/main/java/com/youlai/boot/framework/web/repeatsubmit/RepeatSubmit.java b/src/main/java/com/youlai/boot/framework/web/repeatsubmit/RepeatSubmit.java index fa798be8..838f9d5c 100644 --- a/src/main/java/com/youlai/boot/framework/web/repeatsubmit/RepeatSubmit.java +++ b/src/main/java/com/youlai/boot/framework/web/repeatsubmit/RepeatSubmit.java @@ -9,8 +9,6 @@ import java.lang.annotation.Target; /** * 防重复提交注解 * - *

标注在写接口方法上,指定时间窗口内同一用户对同一请求只允许提交一次,默认 5 秒。

- * * @author Ray.Hao * @since 2.3.0 */ @@ -21,17 +19,11 @@ public @interface RepeatSubmit { /** * 防重占位过期时间(秒) - * - *

默认 5 秒内不允许重复提交,占位到期后自动释放。

*/ int expire() default 5; /** * 请求标识 SpEL 表达式(可选) - * - *

非空时以表达式的值区分不同请求,如 {@code "#form.name"}; - * 为空时基于方法参数自动生成请求指纹,自动排除 ServletRequest/ServletResponse、 - * MultipartFile、BindingResult 等不可稳定序列化的参数。

*/ String key() default ""; } diff --git a/src/main/java/com/youlai/boot/framework/web/repeatsubmit/RepeatSubmitAspect.java b/src/main/java/com/youlai/boot/framework/web/repeatsubmit/RepeatSubmitAspect.java index b5bda566..f3b42d11 100644 --- a/src/main/java/com/youlai/boot/framework/web/repeatsubmit/RepeatSubmitAspect.java +++ b/src/main/java/com/youlai/boot/framework/web/repeatsubmit/RepeatSubmitAspect.java @@ -39,9 +39,6 @@ import java.util.List; /** * 防重复提交切面 * - *

用 Redis 的「不存在才写入 + TTL」原子占位实现:同一请求标识在过期时间内 - * 第二次提交直接拒绝,占位到期自动释放,无需手动解锁。

- * * @author Ray.Hao * @since 4.3.1 */ @@ -55,7 +52,7 @@ public class RepeatSubmitAspect { private static final ExpressionParser SPEL_PARSER = new SpelExpressionParser(); private static final ParameterNameDiscoverer PARAMETER_NAME_DISCOVERER = new DefaultParameterNameDiscoverer(); - /** 生成请求指纹时排除的参数类型,这些对象序列化结果不稳定或无业务含义 */ + // 生成请求指纹时排除的参数类型,这些对象序列化结果不稳定或无业务含义 private static final List> EXCLUDED_PARAM_TYPES = List.of(ServletRequest.class, ServletResponse.class, MultipartFile.class, BindingResult.class); @@ -77,8 +74,6 @@ public class RepeatSubmitAspect { /** * 生成防重占位的 key - * - *

注解配置了 key 表达式时以表达式的值区分请求;否则对过滤后的业务参数做哈希。

*/ private String buildLockKey(ProceedingJoinPoint pjp, RepeatSubmit repeatSubmit) { HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest(); @@ -90,14 +85,18 @@ public class RepeatSubmitAspect { return StrUtil.format(RedisConstants.Lock.RESUBMIT, userIdentifier, requestIdentifier + ":" + requestFingerprint); } - /** 过滤掉不可稳定序列化的参数后再生成指纹 */ + /** + * 过滤掉不可稳定序列化的参数后再生成指纹 + */ private Object[] filterArgs(ProceedingJoinPoint pjp) { return Arrays.stream(pjp.getArgs()) .filter(arg -> arg == null || EXCLUDED_PARAM_TYPES.stream().noneMatch(type -> type.isInstance(arg))) .toArray(); } - /** 解析注解上的 SpEL key 表达式,方法参数可直接引用 */ + /** + * 解析注解上的 SpEL key 表达式,方法参数可直接引用 + */ private String evaluateKey(ProceedingJoinPoint pjp, String spel) { Method method = ((MethodSignature) pjp.getSignature()).getMethod(); MethodBasedEvaluationContext context = new MethodBasedEvaluationContext( diff --git a/src/main/java/com/youlai/boot/framework/web/util/ResponseWriter.java b/src/main/java/com/youlai/boot/framework/web/util/ResponseWriter.java index 118ea7ed..16ce427b 100644 --- a/src/main/java/com/youlai/boot/framework/web/util/ResponseWriter.java +++ b/src/main/java/com/youlai/boot/framework/web/util/ResponseWriter.java @@ -13,7 +13,6 @@ import java.nio.charset.StandardCharsets; /** * 响应写入器 - *

用于过滤器、Security处理器等场景统一写入HTTP响应

*/ @Slf4j public final class ResponseWriter { diff --git a/src/main/java/com/youlai/boot/module/form/enums/FormCategoryEnum.java b/src/main/java/com/youlai/boot/module/form/enums/FormCategoryEnum.java index 61e6b97e..ec20a96c 100644 --- a/src/main/java/com/youlai/boot/module/form/enums/FormCategoryEnum.java +++ b/src/main/java/com/youlai/boot/module/form/enums/FormCategoryEnum.java @@ -9,9 +9,6 @@ import lombok.Getter; /** * 表单类型枚举 * - *

类型驱动消费方行为:设计器绑定流程时仅列出 workflow 类型, - * 避免"意见反馈"等通用收集表单混入流程表单候选项

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/form/enums/FormStatusEnum.java b/src/main/java/com/youlai/boot/module/form/enums/FormStatusEnum.java index 299e6810..169ad7f9 100644 --- a/src/main/java/com/youlai/boot/module/form/enums/FormStatusEnum.java +++ b/src/main/java/com/youlai/boot/module/form/enums/FormStatusEnum.java @@ -9,8 +9,6 @@ import lombok.Getter; /** * 表单状态枚举 * - *

-1 为停用态,其余为正常生命周期

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/form/model/entity/FormData.java b/src/main/java/com/youlai/boot/module/form/model/entity/FormData.java index f2e049f9..ae21d684 100644 --- a/src/main/java/com/youlai/boot/module/form/model/entity/FormData.java +++ b/src/main/java/com/youlai/boot/module/form/model/entity/FormData.java @@ -18,36 +18,24 @@ import lombok.EqualsAndHashCode; @Data public class FormData extends BaseEntity { - /** - * 表单定义ID - */ + // 表单定义ID private Long formId; - /** - * 表单版本(提交时快照,用于追溯该数据由哪版规则产出) - */ + // 表单版本(提交时快照,用于追溯该数据由哪版规则产出) private Integer formVersion; - /** - * 表单数据(field -> value 映射的 JSON 字符串) - */ + // 表单数据(field -> value 映射的 JSON 字符串) private String dataJson; - /** - * 提交人ID(匿名提交为空) - */ + // 提交人ID(匿名提交为空) @TableField(fill = FieldFill.INSERT) private Long createBy; - /** - * 修改人ID(数据修正时记录) - */ + // 修改人ID(数据修正时记录) @TableField(fill = FieldFill.INSERT_UPDATE) private Long updateBy; - /** - * 逻辑删除标识(0未删除 1已删除) - */ + // 逻辑删除标识(0未删除 1已删除) private Integer isDeleted; } diff --git a/src/main/java/com/youlai/boot/module/form/model/entity/FormDefinition.java b/src/main/java/com/youlai/boot/module/form/model/entity/FormDefinition.java index 53c17da2..dc87969e 100644 --- a/src/main/java/com/youlai/boot/module/form/model/entity/FormDefinition.java +++ b/src/main/java/com/youlai/boot/module/form/model/entity/FormDefinition.java @@ -19,73 +19,47 @@ import lombok.EqualsAndHashCode; @Data public class FormDefinition extends BaseEntity { - /** - * 表单唯一标识(业务编码,创建后不可修改) - */ + // 表单唯一标识(业务编码,创建后不可修改) private String formKey; - /** - * 表单名称 - */ + // 表单名称 private String formName; - /** - * 表单描述 - */ + // 表单描述 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String description; - /** - * 表单规则(form-create rule 数组 JSON 字符串) - */ + // 表单规则(form-create rule 数组 JSON 字符串) private String formJson; - /** - * 表单全局配置 JSON 字符串(labelPosition/size/submitBtn 等) - */ + // 表单全局配置 JSON 字符串(labelPosition/size/submitBtn 等) @TableField(updateStrategy = FieldStrategy.ALWAYS) private String optionsJson; - /** - * 状态(0草稿 1已发布 -1已停用) - */ + // 状态(0草稿 1已发布 -1已停用) private Integer status; - /** - * 是否允许匿名公开访问(0否 1是) - */ + // 是否允许匿名公开访问(0否 1是) private Integer isPublic; - /** - * 表单类型(normal通用表单 workflow审批表单) - */ + // 表单类型(normal通用表单 workflow审批表单) private String category; - /** - * 生成的访问菜单ID(NULL未生成,幂等防重复) - */ + // 生成的访问菜单ID(NULL未生成,幂等防重复) private Long menuId; - /** - * 版本号,每次发布+1 - */ + // 版本号,每次发布+1 private Integer version; - /** - * 创建人ID - */ + // 创建人ID @TableField(fill = FieldFill.INSERT) private Long createBy; - /** - * 更新人ID - */ + // 更新人ID @TableField(fill = FieldFill.INSERT_UPDATE) private Long updateBy; - /** - * 逻辑删除标识(0未删除 1已删除) - */ + // 逻辑删除标识(0未删除 1已删除) private Integer isDeleted; } diff --git a/src/main/java/com/youlai/boot/module/form/model/entity/FormSnapshot.java b/src/main/java/com/youlai/boot/module/form/model/entity/FormSnapshot.java index d84aebf6..211de018 100644 --- a/src/main/java/com/youlai/boot/module/form/model/entity/FormSnapshot.java +++ b/src/main/java/com/youlai/boot/module/form/model/entity/FormSnapshot.java @@ -8,10 +8,6 @@ import lombok.EqualsAndHashCode; /** * 表单版本快照实体 * - *

发布时固化规则快照,数据回显按提交时版本加载, - * 防止表单定义变更(字段删除/改名)导致历史数据回显漂移; - * 快照只增不改,审计字段仅保留 BaseEntity 公共部分

- * * @author Ray.Hao * @since 4.9.0 */ @@ -20,29 +16,19 @@ import lombok.EqualsAndHashCode; @Data public class FormSnapshot extends BaseEntity { - /** - * 表单定义ID - */ + // 表单定义ID private Long formId; - /** - * 版本号(发布时递增后的值) - */ + // 版本号(发布时递增后的值) private Integer version; - /** - * 表单规则快照(form-create rule 数组 JSON 字符串) - */ + // 表单规则快照(form-create rule 数组 JSON 字符串) private String formJson; - /** - * 表单全局配置快照 JSON 字符串 - */ + // 表单全局配置快照 JSON 字符串 private String optionsJson; - /** - * 逻辑删除标识(0未删除 1已删除) - */ + // 逻辑删除标识(0未删除 1已删除) private Integer isDeleted; } diff --git a/src/main/java/com/youlai/boot/module/form/service/FormDataService.java b/src/main/java/com/youlai/boot/module/form/service/FormDataService.java index ded2e9c6..437844ec 100644 --- a/src/main/java/com/youlai/boot/module/form/service/FormDataService.java +++ b/src/main/java/com/youlai/boot/module/form/service/FormDataService.java @@ -18,8 +18,6 @@ public interface FormDataService { /** * 提交表单数据(仅已发布表单可提交,提交时快照表单版本) * - *

提交前执行后端基础校验(必填/类型,基于 rule validate)与字段白名单过滤

- * * @param formKey 表单唯一标识 * @param data 表单数据(field -> value 映射) * @return 是否提交成功 @@ -29,8 +27,6 @@ public interface FormDataService { /** * 提交表单数据并返回数据ID * - *

供工作流模块发起流程时建立 businessKey 关联(form_data.id),校验规则同 {@link #saveFormData}

- * * @param formKey 表单唯一标识 * @param data 表单数据(field -> value 映射) * @return 表单数据ID @@ -40,9 +36,6 @@ public interface FormDataService { /** * 匿名提交公开表单数据(公开分享链接入口) * - *

公开访问总闸:仅 is_public=1 且已发布的表单可提交; - * 按 formKey + IP 维度做 Redis 限流防刷,create_by 为空(匿名无身份)

- * * @param formKey 表单唯一标识 * @param data 表单数据(field -> value 映射) * @param ip 提交方 IP(限流维度) diff --git a/src/main/java/com/youlai/boot/module/form/service/FormDefinitionService.java b/src/main/java/com/youlai/boot/module/form/service/FormDefinitionService.java index 65124da9..9b5f7080 100644 --- a/src/main/java/com/youlai/boot/module/form/service/FormDefinitionService.java +++ b/src/main/java/com/youlai/boot/module/form/service/FormDefinitionService.java @@ -55,8 +55,6 @@ public interface FormDefinitionService { /** * 修改表单定义 * - *

formKey 创建后不可修改;草稿态可修改元数据与规则,非草稿态仅可修改规则

- * * @param id 表单ID * @param formData 表单定义表单数据 * @return 是否修改成功 @@ -130,9 +128,6 @@ public interface FormDefinitionService { /** * 审批表单下拉选项(供工作流设计器绑定表单) * - *

仅返回已发布且类型为 workflow 的表单;value 为 formKey(BPMN formKey 引用), - * 草稿/停用表单结构未定不应被流程绑定

- * * @return 审批表单下拉选项列表 */ List> listWorkflowFormOptions(); diff --git a/src/main/java/com/youlai/boot/module/form/service/impl/FormDataServiceImpl.java b/src/main/java/com/youlai/boot/module/form/service/impl/FormDataServiceImpl.java index 753904df..7c144fa1 100644 --- a/src/main/java/com/youlai/boot/module/form/service/impl/FormDataServiceImpl.java +++ b/src/main/java/com/youlai/boot/module/form/service/impl/FormDataServiceImpl.java @@ -42,14 +42,10 @@ public class FormDataServiceImpl extends ServiceImpl i private final FormSnapshotMapper formSnapshotMapper; private final RedisTemplate redisTemplate; - /** - * 公开表单单 IP 提交上限(次/分钟):匿名接口防刷阈值 - */ + // 公开表单单 IP 提交上限(次/分钟):匿名接口防刷阈值 private static final int PUBLIC_SUBMIT_LIMIT = 10; - /** - * 公开表单限流窗口:1 分钟 - */ + // 公开表单限流窗口:1 分钟 private static final Duration PUBLIC_SUBMIT_WINDOW = Duration.ofMinutes(1); /** @@ -157,8 +153,6 @@ public class FormDataServiceImpl extends ServiceImpl i /** * 获取表单数据详情(只读回显) * - *

数据不存在时返回 null,由调用方决定语义:控制器直查需提示用户,工作流回显需静默降级

- * * @param dataId 数据ID */ @Override @@ -180,8 +174,6 @@ public class FormDataServiceImpl extends ServiceImpl i /** * 填充回显规则:命中版本快照用快照规则,否则回退当前定义 * - *

回退分支兼容快照表启用前提交的历史数据

- * * @param vo 数据详情 VO * @param formId 表单定义ID * @param version 提交时版本 diff --git a/src/main/java/com/youlai/boot/module/form/service/impl/FormDefinitionServiceImpl.java b/src/main/java/com/youlai/boot/module/form/service/impl/FormDefinitionServiceImpl.java index 963f47bd..9a0171cd 100644 --- a/src/main/java/com/youlai/boot/module/form/service/impl/FormDefinitionServiceImpl.java +++ b/src/main/java/com/youlai/boot/module/form/service/impl/FormDefinitionServiceImpl.java @@ -63,7 +63,7 @@ import java.util.stream.Collectors; @RequiredArgsConstructor public class FormDefinitionServiceImpl extends ServiceImpl implements FormDefinitionService { - /** 系统提示词名称,对应 resources/prompts 下的相对路径 */ + // 系统提示词名称,对应 resources/prompts 下的相对路径 private static final String SYSTEM_PROMPT_PATH = "form/system.md"; private final FormConverter formConverter; @@ -76,13 +76,13 @@ public class FormDefinitionServiceImpl extends ServiceImplformKey 创建后不可修改;草稿态可修改元数据与规则,非草稿态仅可修改规则

- * * @param id 表单ID * @param formData 表单定义表单数据 */ @@ -194,9 +192,6 @@ public class FormDefinitionServiceImpl extends ServiceImpl被流程引用的表单禁止删除;其余级联清理关联数据,避免孤儿残留:生成的访问菜单(含其角色授权)、 - * 提交数据、版本快照一并删除

- * * @param ids 表单ID列表 */ @Override @@ -225,8 +220,6 @@ public class FormDefinitionServiceImpl extends ServiceImpl被引用的表单删除后,流程发起与审批时无表单可渲染,故在删除前整体拦截

- * * @param forms 待删除表单 */ private void checkProcessReferences(List forms) { @@ -250,9 +243,6 @@ public class FormDefinitionServiceImpl extends ServiceImpl状态翻转 + 版本自增走单条原子 UPDATE,从 DB 侧消除并发发布的重号竞态; - * 更新成功后回读最新表单,用同一份规则固化版本快照

- * * @param id 表单ID */ @Override @@ -358,9 +348,6 @@ public class FormDefinitionServiceImpl extends ServiceImpl仅返回已发布且 isPublic=1 的表单;直查库,不读 {@link #getFormRender(String)} 的 - * Redis 缓存——缓存 VO 不含 isPublic,命中会绕过公开开关校验

- * * @param formKey 表单唯一标识 */ @Override @@ -460,9 +447,6 @@ public class FormDefinitionServiceImpl extends ServiceImpl挂到顶级"动态表单"目录下,该目录缺失时退化为顶级创建; - * 无子菜单的目录在侧边栏不渲染

- * * @return 默认目录实体 */ private Menu ensureDefaultCatalog() { @@ -536,9 +520,6 @@ public class FormDefinitionServiceImpl extends ServiceImpl踩坑1:只授子菜单不授父目录,buildRoutes 构树出孤儿节点,侧边栏不渲染; - * 踩坑2:不能复用 assignMenusToRole——它是整体替换语义,会清空角色原有菜单授权

- * * @param menuId 菜单ID * @param roleIds 角色ID列表 */ @@ -583,9 +564,6 @@ public class FormDefinitionServiceImpl extends ServiceImpl仅返回已发布且类型为 workflow 的表单;value 为 formKey(BPMN formKey 引用), - * 草稿/停用表单结构未定不应被流程绑定

- * * @return 审批表单下拉选项列表 */ @Override diff --git a/src/main/java/com/youlai/boot/module/form/util/FormRuleValidator.java b/src/main/java/com/youlai/boot/module/form/util/FormRuleValidator.java index 9e27442b..afb4243f 100644 --- a/src/main/java/com/youlai/boot/module/form/util/FormRuleValidator.java +++ b/src/main/java/com/youlai/boot/module/form/util/FormRuleValidator.java @@ -14,17 +14,12 @@ import java.util.Map; /** * 表单规则校验器(后端基础校验 + 字段白名单) * - *

按 form-create rule 的 validate 声明校验必填(required)与基础类型(number/array), - * 并按 rule 声明的 field 过滤数据

- * * @author Ray.Hao * @since 4.9.0 */ public final class FormRuleValidator { - /** - * Jackson 线程安全,静态复用 - */ + // Jackson 线程安全,静态复用 private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper(); private FormRuleValidator() { @@ -33,9 +28,6 @@ public final class FormRuleValidator { /** * 校验并过滤表单数据 * - *

白名单:仅保留 rule 中声明 field 的数据项; - * 校验:逐字段执行 required/类型校验,任一失败抛业务异常并列出全部错误

- * * @param formJson 表单规则(form-create rule 数组 JSON 字符串) * @param data 提交数据(field -> value 映射) * @return 白名单过滤后的数据(保持 rule 字段顺序) diff --git a/src/main/java/com/youlai/boot/module/workflow/config/ConditionalOnWorkflowEnabled.java b/src/main/java/com/youlai/boot/module/workflow/config/ConditionalOnWorkflowEnabled.java index 5c5c4557..a2fd4e70 100644 --- a/src/main/java/com/youlai/boot/module/workflow/config/ConditionalOnWorkflowEnabled.java +++ b/src/main/java/com/youlai/boot/module/workflow/config/ConditionalOnWorkflowEnabled.java @@ -11,8 +11,6 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnBooleanProp /** * 工作流启用条件 * - *

workflow.enabled 显式为 true 时生效,未配置视为关闭

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/workflow/controller/WorkflowDefinitionController.java b/src/main/java/com/youlai/boot/module/workflow/controller/WorkflowDefinitionController.java index 04c102c0..e66af884 100644 --- a/src/main/java/com/youlai/boot/module/workflow/controller/WorkflowDefinitionController.java +++ b/src/main/java/com/youlai/boot/module/workflow/controller/WorkflowDefinitionController.java @@ -20,8 +20,6 @@ import java.util.List; /** * 流程定义控制层(发布产物:发布后供发起、审批与流程图查看) * - *

定义的发布在模型接口(deploy),删除随模型级联

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/workflow/controller/WorkflowTaskController.java b/src/main/java/com/youlai/boot/module/workflow/controller/WorkflowTaskController.java index f572b839..67b125c0 100644 --- a/src/main/java/com/youlai/boot/module/workflow/controller/WorkflowTaskController.java +++ b/src/main/java/com/youlai/boot/module/workflow/controller/WorkflowTaskController.java @@ -28,8 +28,6 @@ import java.util.List; /** * 流程任务控制层(待办/已办、审批通过/驳回) * - *

待办、已办为当前用户自己的数据,仅登录校验、不加权限注解

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/workflow/handler/ProcessCompletedHandler.java b/src/main/java/com/youlai/boot/module/workflow/handler/ProcessCompletedHandler.java index 26605844..a3f668e7 100644 --- a/src/main/java/com/youlai/boot/module/workflow/handler/ProcessCompletedHandler.java +++ b/src/main/java/com/youlai/boot/module/workflow/handler/ProcessCompletedHandler.java @@ -3,9 +3,6 @@ package com.youlai.boot.module.workflow.handler; /** * 流程审批通过后的业务处理器(扩展点) * - *

一个流程定义 Key 对应一个处理器,由 ProcessCompletedListener 统一路由; - * 新增"审批通过后处理"(如报销入账、采购入库、离职禁用账号)只需实现本接口并注册为 Spring Bean

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/workflow/handler/expense/ExpenseProcessCompletedHandler.java b/src/main/java/com/youlai/boot/module/workflow/handler/expense/ExpenseProcessCompletedHandler.java index 5edcaa46..ddfb2562 100644 --- a/src/main/java/com/youlai/boot/module/workflow/handler/expense/ExpenseProcessCompletedHandler.java +++ b/src/main/java/com/youlai/boot/module/workflow/handler/expense/ExpenseProcessCompletedHandler.java @@ -13,9 +13,6 @@ import org.springframework.stereotype.Component; /** * 报销流程审批通过后的业务处理(示例:财务入账) * - *

演示项目的入账为日志占位,未真实对接财务系统; - * businessKey 即发起时提交的报销表单数据ID,可回读申请人填写的金额等内容

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/workflow/handler/purchase/PurchaseProcessCompletedHandler.java b/src/main/java/com/youlai/boot/module/workflow/handler/purchase/PurchaseProcessCompletedHandler.java index 8059cfe7..8ed9c326 100644 --- a/src/main/java/com/youlai/boot/module/workflow/handler/purchase/PurchaseProcessCompletedHandler.java +++ b/src/main/java/com/youlai/boot/module/workflow/handler/purchase/PurchaseProcessCompletedHandler.java @@ -13,9 +13,6 @@ import org.springframework.stereotype.Component; /** * 采购流程审批通过后的业务处理(示例:采购入库) * - *

演示项目的入库为日志占位,未真实对接仓储系统; - * 正式对接时在 handle 中完成入库单生成与库存变更

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/workflow/listener/ProcessCompletedListener.java b/src/main/java/com/youlai/boot/module/workflow/listener/ProcessCompletedListener.java index 87cbbe84..6d0bb3c8 100644 --- a/src/main/java/com/youlai/boot/module/workflow/listener/ProcessCompletedListener.java +++ b/src/main/java/com/youlai/boot/module/workflow/listener/ProcessCompletedListener.java @@ -21,9 +21,6 @@ import java.util.stream.Collectors; /** * 流程完成事件监听器:审批通过(实例正常结束)后按流程定义 Key 路由到业务处理器 * - *

挂在引擎全局(见 WorkflowEngineConfig),任意流程结束均会派发本监听器; - * 只响应 PROCESS_COMPLETED,取消/删除流程不触发业务后处理

- * * @author Ray.Hao * @since 4.9.0 */ @@ -68,9 +65,6 @@ public class ProcessCompletedListener implements FlowableEventListener { /** * 监听器异常不回滚审批事务:后处理(入账/入库)失败不阻断流程结束 - * - *

强一致场景(后处理失败必须连带回滚审批)改为 true, - * 异常将随 completeTask 的事务一起回滚

*/ @Override public boolean isFailOnException() { diff --git a/src/main/java/com/youlai/boot/module/workflow/runner/WorkflowDemoInitializer.java b/src/main/java/com/youlai/boot/module/workflow/runner/WorkflowDemoInitializer.java index c38120c3..b571591b 100644 --- a/src/main/java/com/youlai/boot/module/workflow/runner/WorkflowDemoInitializer.java +++ b/src/main/java/com/youlai/boot/module/workflow/runner/WorkflowDemoInitializer.java @@ -11,9 +11,6 @@ import org.springframework.stereotype.Component; /** * 演示流程启动初始化器 * - *

委托 {@link WorkflowDemoService} 幂等初始化,重置能力由管理端接口提供。 - * 由 workflow.demo.enabled 控制(默认关闭),置 true 后启动时初始化演示流程

- * * @author Ray.Hao * @since 4.9.0 */ diff --git a/src/main/java/com/youlai/boot/module/workflow/service/WorkflowDemoService.java b/src/main/java/com/youlai/boot/module/workflow/service/WorkflowDemoService.java index b074732e..c088d844 100644 --- a/src/main/java/com/youlai/boot/module/workflow/service/WorkflowDemoService.java +++ b/src/main/java/com/youlai/boot/module/workflow/service/WorkflowDemoService.java @@ -10,8 +10,6 @@ public interface WorkflowDemoService { /** * 幂等初始化演示流程(已存在则跳过):部署流程定义 + 创建模型草稿 - * - *

单个流程失败仅记录日志,不阻断其余流程与应用启动

*/ void initIfAbsent(); diff --git a/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowDemoServiceImpl.java b/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowDemoServiceImpl.java index 22d2e77b..a878955c 100644 --- a/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowDemoServiceImpl.java +++ b/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowDemoServiceImpl.java @@ -26,11 +26,6 @@ import java.util.Set; /** * 演示流程服务实现(请假、报销、采购、用章) * - *

初始化按 key 幂等双写:部署流程定义(可发起)+ 创建模型草稿(流程模型页可见),两者各自查重互不依赖。 - * 引擎表(ACT_*)不走 SQL 预置:流程定义跨三表且主键由引擎生成,直接写库绕过解析校验,重置同理依赖引擎级联删除

- * - *

重置供演示环境定期复原,数据效果等价业务脚本"DROP 重建",不动引擎表结构

- * * @author Ray.Hao * @since 4.9.0 */ @@ -44,9 +39,7 @@ public class WorkflowDemoServiceImpl implements WorkflowDemoService { private final FormDataService formDataService; private final BpmnModelHelper bpmnModelHelper; - /** - * 演示流程清单(key 与 resources/workflow/ 下同名 BPMN 文件的 process id 一致) - */ + // 演示流程清单(key 与 resources/workflow/ 下同名 BPMN 文件的 process id 一致) private static final List DEMO_PROCESSES = List.of( new DemoProcess("leave", "请假审批"), new DemoProcess("expense", "报销审批"), diff --git a/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowInstanceServiceImpl.java b/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowInstanceServiceImpl.java index 2949e59e..dda6c3d9 100644 --- a/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowInstanceServiceImpl.java +++ b/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowInstanceServiceImpl.java @@ -41,9 +41,6 @@ import java.util.Set; /** * 流程实例业务实现类 * - *

发起时绑定动态表单:表单数据落库后以数据ID作为 businessKey,表单字段随流程变量提交, - * 网关条件可直接引用表单字段(如 ${days > 3})

- * * @author Ray.Hao * @since 4.9.0 */ @@ -259,9 +256,6 @@ public class WorkflowInstanceServiceImpl implements WorkflowInstanceService { /** * 发起表单数据回显(按提交时快照严格回显) - * - *

表单数据缺失时静默降级:业务表重装(dynamic-form.sql 重建)而引擎表保留、 - * 或数据被手动删除时实例仍在,详情页可继续展示审批记录/流程走向/流程图,不因表单缺失整体报错

*/ private void fillFormData(InstanceDetailVO detailVO, String formKey, String businessKey) { if (StrUtil.isBlank(formKey) || StrUtil.isBlank(businessKey)) { diff --git a/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowModelServiceImpl.java b/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowModelServiceImpl.java index 5643ea94..2f530786 100644 --- a/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowModelServiceImpl.java +++ b/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowModelServiceImpl.java @@ -44,8 +44,6 @@ import java.util.stream.Collectors; /** * 流程模型业务实现类 * - *

模型即设计草稿,editorSource 持久化 bpmn-js 产出的 BPMN XML;部署后生成不可变的流程定义

- * * @author Ray.Hao * @since 4.9.0 */ @@ -60,9 +58,7 @@ public class WorkflowModelServiceImpl implements WorkflowModelService { private final BpmnModelHelper bpmnModelHelper; private final RoleService roleService; - /** - * 新模型初始模板:开始 → 审批 → 结束,设计器打开即可直接编辑 - */ + // 新模型初始模板:开始 → 审批 → 结束,设计器打开即可直接编辑 private static final String INITIAL_XML_TEMPLATE = """ 列表页即呈现"未发布 / v2 已启用 / v3 已停用",发布管理不必独立成页

*/ private void fillPublishState(List records) { if (records.isEmpty()) { @@ -203,9 +197,6 @@ public class WorkflowModelServiceImpl implements WorkflowModelService { /** * 删除流程模型 * - *

「流程」对用户是整体:删除设计草稿时级联删除其全部发布版本(含运行实例与历史), - * 避免残留孤儿定义导致列表出现无模型可管理的流程;有在办实例的流程先拦截,防止在办任务被静默抹除

- * * @param modelIds 模型ID集合 */ @Override @@ -222,8 +213,6 @@ public class WorkflowModelServiceImpl implements WorkflowModelService { /** * 校验流程无运行中实例 - * - *

级联删除会连同在办任务一并抹除,审批人无从知晓,故有在办实例时禁止删除

*/ private void checkNoRunningInstance(Model model) { long runningCount = runtimeService.createProcessInstanceQuery() @@ -248,9 +237,6 @@ public class WorkflowModelServiceImpl implements WorkflowModelService { /** * 查询引用指定表单的流程 * - *

引用写在 BPMN 的开始节点与用户任务节点(flowable:formKey);模型草稿虽未部署但已绑定表单, - * 一并计入:表单被删除后,流程发起或审批时无表单可渲染

- * * @param formKeys 表单标识集合 * @return 表单标识 → 引用它的流程名称集合(无引用返回空 Map) */ diff --git a/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowTaskServiceImpl.java b/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowTaskServiceImpl.java index 782d4bac..4b3df71e 100644 --- a/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowTaskServiceImpl.java +++ b/src/main/java/com/youlai/boot/module/workflow/service/impl/WorkflowTaskServiceImpl.java @@ -55,9 +55,6 @@ import java.util.stream.Collectors; /** * 流程任务业务实现类 * - *

任务归属以用户名为准(引擎 assignee 与登录用户名一致);候选组任务(candidateGroups 对应角色编码) - * 待办可见、办理时自动认领,审批意见归档为引擎评论

- * * @author Ray.Hao * @since 4.9.0 */ @@ -67,7 +64,7 @@ import java.util.stream.Collectors; @RequiredArgsConstructor public class WorkflowTaskServiceImpl implements WorkflowTaskService { - /** 系统提示词名称,对应 resources/prompts 下的相对路径 */ + // 系统提示词名称,对应 resources/prompts 下的相对路径 private static final String SYSTEM_PROMPT_PATH = "workflow/summary.md"; private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper(); @@ -285,9 +282,6 @@ public class WorkflowTaskServiceImpl implements WorkflowTaskService { /** * 当前用户的候选任务查询:本人任务(办理人/候选用户)或所属角色候选组的任务 - * - *

引擎未同步用户-角色关系,单参 candidateOrAssigned 匹配不到候选组, - * 以 or 查询显式传入登录用户的角色编码集合(BPMN candidateGroups 对应系统角色编码)

*/ private TaskQuery createCandidateTaskQuery() { String username = SecurityUtils.getUsername(); @@ -329,9 +323,6 @@ public class WorkflowTaskServiceImpl implements WorkflowTaskService { /** * 发起表单数据回显(按提交时快照严格回显) - * - *

表单数据缺失时静默降级(业务表重装或数据被删而实例仍在), - * 办理弹窗可继续展示审批记录/流程走向,不因表单缺失整体报错

*/ private void fillFormData(TaskDetailVO detailVO, String formKey, String businessKey) { if (StrUtil.isBlank(formKey) || StrUtil.isBlank(businessKey)) { diff --git a/src/main/java/com/youlai/boot/module/workflow/util/BpmnModelHelper.java b/src/main/java/com/youlai/boot/module/workflow/util/BpmnModelHelper.java index 2a9a8868..71de57ba 100644 --- a/src/main/java/com/youlai/boot/module/workflow/util/BpmnModelHelper.java +++ b/src/main/java/com/youlai/boot/module/workflow/util/BpmnModelHelper.java @@ -116,8 +116,6 @@ public class BpmnModelHelper { /** * 提取 BPMN XML 引用的全部表单标识(开始节点与用户任务节点,去重) * - *

供表单删除前校验使用:设计器草稿未部署,其引用不体现在流程定义里

- * * @param bpmnXml BPMN 2.0 XML 字符串 * @return formKey 集合,无引用返回空集合 */ @@ -165,9 +163,6 @@ public class BpmnModelHelper { /** * 校验 BPMN XML 中用户任务节点的办理人配置 * - *

assignee/候选组/候选用户三者均未配置的任务会成为无主任务: - * 不出现在任何人的待办列表,流程将永久卡在该节点

- * * @param bpmnXml BPMN 2.0 XML 字符串 * @return 未配置办理人的节点名称列表(全部已配置返回空列表) */ @@ -194,8 +189,6 @@ public class BpmnModelHelper { /** * 提取 BPMN XML 中全部用户任务引用的候选组编码(去重) * - *

供发布校验核对角色存在性:候选组指向不存在的角色时任务无人可见,同样会卡死流程

- * * @param bpmnXml BPMN 2.0 XML 字符串 * @return 候选组角色编码集合(无候选组返回空集合) */ diff --git a/src/main/java/com/youlai/boot/support/ai/AiChatService.java b/src/main/java/com/youlai/boot/support/ai/AiChatService.java index 432200ba..27609457 100644 --- a/src/main/java/com/youlai/boot/support/ai/AiChatService.java +++ b/src/main/java/com/youlai/boot/support/ai/AiChatService.java @@ -17,9 +17,6 @@ import java.util.function.Supplier; /** * AI 对话服务 * - *

代码生成、动态表单、工作流的 AI 辅助功能统一走这里;对话客户端由 spring.ai 自动装配提供, - * 未开启时调用返回业务异常,不影响应用启动

- * * @author Ray.Hao * @since 0.1.0 */ @@ -32,9 +29,7 @@ public class AiChatService { private final ObjectProvider chatClientBuilderProvider; - /** - * 对话客户端,首次调用时构建 - */ + // 对话客户端,首次调用时构建 private ChatClient chatClient; /** @@ -54,8 +49,6 @@ public class AiChatService { /** * 发送提示词并映射为实体 * - *

实体结构不符时框架会携带校验错误自动重试,无需手工解析 JSON

- * * @param systemPrompt 系统提示词(角色与约束) * @param userPrompt 用户提示词(输入数据) * @param type 目标实体类型 @@ -70,8 +63,6 @@ public class AiChatService { /** * 发送提示词并映射为 JSON 数组 * - *

元素结构开放(如 form-create rule)时使用,产出后仍需业务侧校验

- * * @param systemPrompt 系统提示词(角色与约束) * @param userPrompt 用户提示词(输入数据) * @return JSON 数组 diff --git a/src/main/java/com/youlai/boot/support/ai/PromptLoader.java b/src/main/java/com/youlai/boot/support/ai/PromptLoader.java index d54b3173..2d0e3ab5 100644 --- a/src/main/java/com/youlai/boot/support/ai/PromptLoader.java +++ b/src/main/java/com/youlai/boot/support/ai/PromptLoader.java @@ -17,9 +17,6 @@ import java.util.concurrent.ConcurrentHashMap; /** * 提示词加载器 * - *

提示词文本统一放在类路径的 prompts 目录下,一个文件对应一段系统提示词, - * 应用启动时全部载入并缓存;文本中的 {{键}} 在渲染时替换为变量值

- * * @author Ray.Hao * @since 0.1.0 */ @@ -27,29 +24,19 @@ import java.util.concurrent.ConcurrentHashMap; @Component public class PromptLoader { - /** - * 提示词文件位置 - */ + // 提示词文件位置 private static final String LOCATION_PATTERN = "classpath*:prompts/**/*.md"; - /** - * 提示词目录,用于从资源地址截取提示词名称 - */ + // 提示词目录,用于从资源地址截取提示词名称 private static final String DIRECTORY = "prompts/"; - /** - * 占位符左标记 - */ + // 占位符左标记 private static final String PLACEHOLDER_LEFT = "{{"; - /** - * 占位符右标记 - */ + // 占位符右标记 private static final String PLACEHOLDER_RIGHT = "}}"; - /** - * 提示词内容,键为 prompts 下的相对路径 - */ + // 提示词内容,键为 prompts 下的相对路径 private final Map prompts = new ConcurrentHashMap<>(); /** diff --git a/src/main/java/com/youlai/boot/support/file/property/StorageProperties.java b/src/main/java/com/youlai/boot/support/file/property/StorageProperties.java index 26b80f5b..0ecc9e77 100644 --- a/src/main/java/com/youlai/boot/support/file/property/StorageProperties.java +++ b/src/main/java/com/youlai/boot/support/file/property/StorageProperties.java @@ -12,9 +12,6 @@ import java.util.stream.Collectors; /** * 文件存储配置属性类 * - *

映射 application.yml 中 storage 前缀的配置;s3 / aliyun / local - * 子配置由各自的 {@code FileService} 实现类绑定

- * * @author Ray.Hao * @since 4.8.0 */ @@ -23,19 +20,10 @@ import java.util.stream.Collectors; @ConfigurationProperties(prefix = "storage") public class StorageProperties { - /** - * 存储类型,决定激活哪个 FileService 实现类 - *
    - *
  • s3 - S3 协议兼容对象存储(当前部署 RustFS)
  • - *
  • aliyun - 阿里云 OSS
  • - *
  • local - 本地磁盘存储
  • - *
- */ + // 存储类型,决定激活哪个 FileService 实现类 private String type; - /** - * 上传限制 - */ + // 上传限制 private Upload upload = new Upload(); /** @@ -44,16 +32,10 @@ public class StorageProperties { @Data public static class Upload { - /** - * 单文件大小上限,如 50MB - *

同时作为 spring.servlet.multipart 的上限,保持单一来源

- */ + // 单文件大小上限,如 50MB private String maxFileSize; - /** - * 允许上传的文件扩展名白名单 - *

置空表示不限制

- */ + // 允许上传的文件扩展名白名单 private List allowedExtensions; } diff --git a/src/main/java/com/youlai/boot/support/file/service/impl/AliyunFileServiceImpl.java b/src/main/java/com/youlai/boot/support/file/service/impl/AliyunFileServiceImpl.java index ef8ee8e4..ce084cd7 100644 --- a/src/main/java/com/youlai/boot/support/file/service/impl/AliyunFileServiceImpl.java +++ b/src/main/java/com/youlai/boot/support/file/service/impl/AliyunFileServiceImpl.java @@ -27,10 +27,6 @@ import java.time.LocalDateTime; /** * 阿里云 OSS 文件存储服务。 - *

- * 当 {@code storage.type=aliyun} 时生效。 - * 上传文件按日期分目录存储,URL 格式:{@code 协议://bucket.endpoint/yyyyMMdd/uuid.suffix}, - * 协议取自 endpoint 配置(未指定时默认 https)。 */ @Component @Slf4j @@ -40,13 +36,13 @@ import java.time.LocalDateTime; @Data public class AliyunFileServiceImpl implements FileService { - /** OSS 地域节点,如 {@code oss-cn-hangzhou.aliyuncs.com},兼容带 {@code http(s)://} 前缀写法 */ + // OSS 地域节点,如 {@code oss-cn-hangzhou.aliyuncs.com},兼容带 {@code http(s)://} 前缀写法 private String endpoint; - /** AccessKey ID */ + // 访问密钥 ID private String accessKeyId; - /** AccessKey Secret */ + // 访问密钥 Secret private String accessKeySecret; - /** 存储空间名称 */ + // 存储空间名称 private String bucket; private OSS aliyunOssClient; @@ -110,8 +106,6 @@ public class AliyunFileServiceImpl implements FileService { /** * 获取文件访问主机地址(含协议),如 {@code https://bucket.oss-cn-hangzhou.aliyuncs.com}。 - *

- * 协议以 endpoint 配置为准,未指定时默认 https。 */ private String getFileHost() { String endpointWithProtocol = endpointWithProtocol(); diff --git a/src/main/java/com/youlai/boot/support/file/service/impl/LocalFileServiceImpl.java b/src/main/java/com/youlai/boot/support/file/service/impl/LocalFileServiceImpl.java index 50d713f1..1d00b2fc 100644 --- a/src/main/java/com/youlai/boot/support/file/service/impl/LocalFileServiceImpl.java +++ b/src/main/java/com/youlai/boot/support/file/service/impl/LocalFileServiceImpl.java @@ -21,10 +21,6 @@ import java.time.LocalDateTime; /** * 本地文件存储服务。 - *

- * 当 {@code storage.type=local} 时生效。 - * 文件写入本地磁盘 {@code storage.local.path} 下按日期分目录存储。 - * URL 为相对于存储根目录的路径,如 {@code /yyyyMMdd/uuid.suffix}。 */ @Data @Slf4j @@ -34,7 +30,7 @@ import java.time.LocalDateTime; @RequiredArgsConstructor public class LocalFileServiceImpl implements FileService { - /** 本地存储根目录,来自 {@code storage.local.path} */ + // 本地存储根目录,来自 {@code storage.local.path} private String path; /** diff --git a/src/main/java/com/youlai/boot/support/file/service/impl/S3FileServiceImpl.java b/src/main/java/com/youlai/boot/support/file/service/impl/S3FileServiceImpl.java index cfd6110f..ad1cdd70 100644 --- a/src/main/java/com/youlai/boot/support/file/service/impl/S3FileServiceImpl.java +++ b/src/main/java/com/youlai/boot/support/file/service/impl/S3FileServiceImpl.java @@ -41,12 +41,6 @@ import java.time.LocalDateTime; /** * S3 协议文件存储实现类(当前部署为 RustFS) * - *

当 {@code storage.type=s3} 时生效。

- *
    - *
  • 配置了 {@code storage.s3.domain} 时直接用域名拼接 URL
  • - *
  • 未配置则用预签名 GET URL(去掉 query 参数后的纯路径)
  • - *
- * * @author Ray.Hao * @since 4.8.0 */ @@ -58,15 +52,15 @@ import java.time.LocalDateTime; @Slf4j public class S3FileServiceImpl implements FileService { - /** S3 对象存储服务端点,如 {@code http://localhost:9000} */ + // S3 对象存储服务端点,如 {@code http://localhost:9000} private String endpoint; - /** 访问密钥 */ + // 访问密钥 private String accessKey; - /** 秘密密钥 */ + // 秘密密钥 private String secretKey; - /** 存储桶名称 */ + // 存储桶名称 private String bucket; - /** 自定义域名(可选),配置后不再使用预签名 URL */ + // 自定义域名(可选),配置后不再使用预签名 URL private String domain; private S3Client s3Client; @@ -153,8 +147,6 @@ public class S3FileServiceImpl implements FileService { /** * 删除文件。 - *

- * 从完整 URL 中提取对象名后调用 S3 删除。 * * @param filePath 文件完整 URL * @return 删除成功返回 true @@ -178,7 +170,9 @@ public class S3FileServiceImpl implements FileService { } } - /** 公开只读策略:匿名可列桶与读对象,禁止任何匿名写入 */ + /** + * 公开只读策略:匿名可列桶与读对象,禁止任何匿名写入 + */ private static String publicBucketPolicy(String bucket) { return "{\"Version\":\"2012-10-17\"," + "\"Statement\":[{\"Effect\":\"Allow\"," diff --git a/src/main/java/com/youlai/boot/support/mail/MailProperties.java b/src/main/java/com/youlai/boot/support/mail/MailProperties.java index 7a535474..41944bce 100644 --- a/src/main/java/com/youlai/boot/support/mail/MailProperties.java +++ b/src/main/java/com/youlai/boot/support/mail/MailProperties.java @@ -15,22 +15,22 @@ import org.springframework.stereotype.Component; @Data public class MailProperties { - /** SMTP 服务器地址 */ + // SMTP 服务器地址 private String host; - /** SMTP 端口 */ + // SMTP 端口 private int port; - /** 发件人账号 */ + // 发件人账号 private String username; - /** 发件人密码 */ + // 发件人密码 private String password; - /** 发件人地址 */ + // 发件人地址 private String from; - /** SMTP 扩展属性 */ + // SMTP 扩展属性 private Properties properties = new Properties(); @Data @@ -39,14 +39,14 @@ public class MailProperties { @Data public static class Smtp { - /** 启用 SMTP 认证 */ + // 启用 SMTP 认证 private boolean auth; private StartTls starttls = new StartTls(); @Data public static class StartTls { - /** 启用 STARTTLS */ + // 启用 STARTTLS private boolean enable; } } diff --git a/src/main/java/com/youlai/boot/support/mail/service/EmailService.java b/src/main/java/com/youlai/boot/support/mail/service/EmailService.java index e1d81e41..401e7294 100644 --- a/src/main/java/com/youlai/boot/support/mail/service/EmailService.java +++ b/src/main/java/com/youlai/boot/support/mail/service/EmailService.java @@ -2,8 +2,6 @@ package com.youlai.boot.support.mail.service; /** * 邮件发送服务接口。 - *

- * 由各邮件供应商实现(SMTP、SendGrid 等),通过 {@code mail.type} 配置项选择。 * * @author Ray.Hao * @since 3.1.0 diff --git a/src/main/java/com/youlai/boot/support/mail/service/impl/SmtpEmailServiceImpl.java b/src/main/java/com/youlai/boot/support/mail/service/impl/SmtpEmailServiceImpl.java index 8e3e8214..df87d87f 100644 --- a/src/main/java/com/youlai/boot/support/mail/service/impl/SmtpEmailServiceImpl.java +++ b/src/main/java/com/youlai/boot/support/mail/service/impl/SmtpEmailServiceImpl.java @@ -20,8 +20,6 @@ import java.nio.charset.StandardCharsets; /** * SMTP 邮件服务。 - *

- * 当 {@code mail.type=smtp}(默认)时生效。基于 Spring {@link JavaMailSender} 发送邮件。 * * @author Ray.Hao * @since 3.1.0 @@ -33,7 +31,7 @@ import java.nio.charset.StandardCharsets; public class SmtpEmailServiceImpl implements EmailService { private final JavaMailSender mailSender; - /** 发件人地址等邮件配置,来自 {@code mail.*} */ + // 发件人地址等邮件配置,来自 {@code mail.*} private final MailProperties mailProperties; /** diff --git a/src/main/java/com/youlai/boot/support/sms/AliyunSmsProperties.java b/src/main/java/com/youlai/boot/support/sms/AliyunSmsProperties.java index 40f58c5c..36f82dd9 100644 --- a/src/main/java/com/youlai/boot/support/sms/AliyunSmsProperties.java +++ b/src/main/java/com/youlai/boot/support/sms/AliyunSmsProperties.java @@ -17,22 +17,22 @@ import java.util.Map; @ConfigurationProperties(prefix = "sms.aliyun") public class AliyunSmsProperties { - /** Access Key ID */ + // 访问密钥 ID private String accessKeyId; - /** Access Key Secret */ + // 访问密钥 Secret private String accessKeySecret; - /** API 域名,如 dysmsapi.aliyuncs.com */ + // API 域名,如 dysmsapi.aliyuncs.com private String domain; - /** 区域,如 cn-shanghai */ + // 区域,如 cn-shanghai private String regionId; - /** 短信签名 */ + // 短信签名 private String signName; - /** 短信模板集合,key 为模板用途(login/register),value 为模板CODE */ + // 短信模板集合,key 为模板用途(login/register),value 为模板CODE private Map templates; } \ No newline at end of file diff --git a/src/main/java/com/youlai/boot/support/sms/SmsTypeEnum.java b/src/main/java/com/youlai/boot/support/sms/SmsTypeEnum.java index c27ac54d..8c338bd8 100644 --- a/src/main/java/com/youlai/boot/support/sms/SmsTypeEnum.java +++ b/src/main/java/com/youlai/boot/support/sms/SmsTypeEnum.java @@ -5,8 +5,6 @@ import lombok.Getter; /** * 短信类型枚举 - *

- * value 值对应 application-*.yml 中的 sms.templates.* 配置 * * @author Ray.Hao * @since 2.21.0 diff --git a/src/main/java/com/youlai/boot/support/sms/service/SmsService.java b/src/main/java/com/youlai/boot/support/sms/service/SmsService.java index cd068aa0..1922d48c 100644 --- a/src/main/java/com/youlai/boot/support/sms/service/SmsService.java +++ b/src/main/java/com/youlai/boot/support/sms/service/SmsService.java @@ -6,8 +6,6 @@ import java.util.Map; /** * 短信发送服务接口。 - *

- * 由各短信供应商实现(阿里云、腾讯云等),通过 {@code sms.type} 配置项选择。 * * @author Ray.Hao * @since 2024/8/17 diff --git a/src/main/java/com/youlai/boot/support/sse/OnlineUserDTO.java b/src/main/java/com/youlai/boot/support/sse/OnlineUserDTO.java index 9f09e3f7..480562e0 100644 --- a/src/main/java/com/youlai/boot/support/sse/OnlineUserDTO.java +++ b/src/main/java/com/youlai/boot/support/sse/OnlineUserDTO.java @@ -9,8 +9,6 @@ import java.io.Serializable; /** * 在线用户信息 DTO。 - *

- * 用于 SSE 在线用户列表展示,包含用户名、会话数量和最早登录时间。 * * @author Ray.Hao * @since 3.0.0 @@ -23,12 +21,12 @@ public class OnlineUserDTO implements Serializable { @Serial private static final long serialVersionUID = 1L; - /** 用户名 */ + // 用户名 private String username; - /** 会话数量,多设备登录时大于 1 */ + // 会话数量,多设备登录时大于 1 private int sessionCount; - /** 最早登录时间(毫秒时间戳) */ + // 最早登录时间(毫秒时间戳) private long loginTime; } diff --git a/src/main/java/com/youlai/boot/support/sse/SseService.java b/src/main/java/com/youlai/boot/support/sse/SseService.java index d3e45186..1bc4654f 100644 --- a/src/main/java/com/youlai/boot/support/sse/SseService.java +++ b/src/main/java/com/youlai/boot/support/sse/SseService.java @@ -13,8 +13,6 @@ import java.util.Map; /** * SSE 推送服务 - *

- * 组合 {@link SseSessionManager} 提供 SSE 建连、广播、定向推送、在线用户统计等能力。 * * @author Ray.Hao * @since 3.1.0 diff --git a/src/main/java/com/youlai/boot/support/sse/SseSessionManager.java b/src/main/java/com/youlai/boot/support/sse/SseSessionManager.java index 55c25b24..8c38fe2f 100644 --- a/src/main/java/com/youlai/boot/support/sse/SseSessionManager.java +++ b/src/main/java/com/youlai/boot/support/sse/SseSessionManager.java @@ -19,9 +19,6 @@ import java.util.concurrent.ConcurrentHashMap; /** * SSE 会话管理器 - *

- * 维护 SSE 连接的用户会话信息,支持多设备同时登录。 - * 职责:建连 / 断开 / 心跳检测 / 定向推送 / 全员广播 * * @author Ray.Hao * @since 3.1.0 @@ -30,16 +27,16 @@ import java.util.concurrent.ConcurrentHashMap; @Component public class SseSessionManager { - /** SSE 连接超时时间:30 分钟 */ + // SSE 连接超时时间:30 分钟 public static final long TIMEOUT = 30 * 60 * 1000L; - /** 用户名 -> SseEmitter 集合(支持多设备) */ + // 用户名 -> SseEmitter 集合(支持多设备) private final Map> userEmittersMap = new ConcurrentHashMap<>(); - /** SseEmitter -> 用户名(快速定位用户) */ + // SseEmitter -> 用户名(快速定位用户) private final Map emitterUserMap = new ConcurrentHashMap<>(); - /** SseEmitter -> 连接时间 */ + // SseEmitter -> 连接时间 private final Map emitterTimeMap = new ConcurrentHashMap<>(); /** diff --git a/src/main/java/com/youlai/boot/support/sse/constant/SseEventConstants.java b/src/main/java/com/youlai/boot/support/sse/constant/SseEventConstants.java index 4bd71119..38406081 100644 --- a/src/main/java/com/youlai/boot/support/sse/constant/SseEventConstants.java +++ b/src/main/java/com/youlai/boot/support/sse/constant/SseEventConstants.java @@ -11,9 +11,9 @@ public final class SseEventConstants { private SseEventConstants() { } - /** 心跳事件 */ + // 心跳事件 public static final String PING = "ping"; - /** 在线用户数事件 */ + // 在线用户数事件 public static final String ONLINE_USERS = "online-users"; } diff --git a/src/main/java/com/youlai/boot/support/sse/constant/SseTopics.java b/src/main/java/com/youlai/boot/support/sse/constant/SseTopics.java index 3d82972b..c0695acd 100644 --- a/src/main/java/com/youlai/boot/support/sse/constant/SseTopics.java +++ b/src/main/java/com/youlai/boot/support/sse/constant/SseTopics.java @@ -11,15 +11,15 @@ public final class SseTopics { private SseTopics() { } - /** 字典变更事件 */ + // 字典变更事件 public static final String DICT = "dict"; - /** 系统消息事件 */ + // 系统消息事件 public static final String SYSTEM = "system"; - /** 通知事件 */ + // 通知事件 public static final String NOTICE = "notice"; - /** 通知撤回事件 */ + // 通知撤回事件 public static final String NOTICE_REVOKE = "notice-revoke"; } diff --git a/src/main/java/com/youlai/boot/system/adapter/log/OperationLogAdapter.java b/src/main/java/com/youlai/boot/system/adapter/log/OperationLogAdapter.java index c1f6b90f..bb5a7957 100644 --- a/src/main/java/com/youlai/boot/system/adapter/log/OperationLogAdapter.java +++ b/src/main/java/com/youlai/boot/system/adapter/log/OperationLogAdapter.java @@ -9,7 +9,6 @@ import org.springframework.stereotype.Component; /** * 操作日志适配器 - *

实现 {@link OperationLogPort},落库 sys_log

* * @author Ray.Hao * @since 4.7.0 diff --git a/src/main/java/com/youlai/boot/system/adapter/security/PermissionAdapter.java b/src/main/java/com/youlai/boot/system/adapter/security/PermissionAdapter.java index b8ed617b..fbd1a177 100644 --- a/src/main/java/com/youlai/boot/system/adapter/security/PermissionAdapter.java +++ b/src/main/java/com/youlai/boot/system/adapter/security/PermissionAdapter.java @@ -9,8 +9,6 @@ import java.util.Set; /** * 权限查询适配器。 - *

- * 实现 framework 层的 {@link PermissionPort},委托 {@link RoleMenuService} 查询权限集合。 * * @author Ray.Hao * @since 3.1.0 diff --git a/src/main/java/com/youlai/boot/system/adapter/security/UserAuthenticationAdapter.java b/src/main/java/com/youlai/boot/system/adapter/security/UserAuthenticationAdapter.java index fd7fb3cb..fbf1055b 100644 --- a/src/main/java/com/youlai/boot/system/adapter/security/UserAuthenticationAdapter.java +++ b/src/main/java/com/youlai/boot/system/adapter/security/UserAuthenticationAdapter.java @@ -10,8 +10,6 @@ import org.springframework.stereotype.Component; /** * 用户认证信息查询适配器。 - *

- * 实现 framework 层的 {@link UserAuthenticationPort},委托 system 层服务完成查询。 * * @author Ray.Hao * @since 3.1.0 diff --git a/src/main/java/com/youlai/boot/system/enums/MenuTypeEnum.java b/src/main/java/com/youlai/boot/system/enums/MenuTypeEnum.java index 107b7abb..0cac4fe9 100644 --- a/src/main/java/com/youlai/boot/system/enums/MenuTypeEnum.java +++ b/src/main/java/com/youlai/boot/system/enums/MenuTypeEnum.java @@ -20,15 +20,11 @@ public enum MenuTypeEnum implements IBaseEnum { EXTERNAL("E", "外链"), BUTTON("B", "按钮"); - /** - * 数据库存储值 - */ + // 数据库存储值 @EnumValue private final String value; - /** - * 友好名称 - */ + // 友好名称 private final String label; MenuTypeEnum(String value, String label) { diff --git a/src/main/java/com/youlai/boot/system/mapper/RoleMapper.java b/src/main/java/com/youlai/boot/system/mapper/RoleMapper.java index fead0397..147ebb4d 100644 --- a/src/main/java/com/youlai/boot/system/mapper/RoleMapper.java +++ b/src/main/java/com/youlai/boot/system/mapper/RoleMapper.java @@ -28,8 +28,6 @@ public interface RoleMapper extends BaseMapper { /** * 获取角色的数据权限信息列表 - *

- * 返回角色编码和数据权限范围的映射列表 * * @param roleCodes 角色编码集合 * @return 角色数据权限信息列表 [{code: 'ADMIN', data_scope: 1}, ...] diff --git a/src/main/java/com/youlai/boot/system/model/dto/DictChangeDTO.java b/src/main/java/com/youlai/boot/system/model/dto/DictChangeDTO.java index 5c30b210..fc9ced3e 100644 --- a/src/main/java/com/youlai/boot/system/model/dto/DictChangeDTO.java +++ b/src/main/java/com/youlai/boot/system/model/dto/DictChangeDTO.java @@ -9,8 +9,6 @@ import java.io.Serializable; /** * 字典变更通知数据 - *

- * 字典数据发生变更时作为 SSE 推送载荷广播至前端(主题 {@code SseTopics.DICT}),前端据此清除字典缓存。 * * @author Ray.Hao * @since 3.0.0 @@ -23,10 +21,10 @@ public class DictChangeDTO implements Serializable { @Serial private static final long serialVersionUID = 1L; - /** 字典编码 */ + // 字典编码 private String dictCode; - /** 变更时间戳 */ + // 变更时间戳 private long timestamp; /** diff --git a/src/main/java/com/youlai/boot/system/model/dto/MenuCreateDTO.java b/src/main/java/com/youlai/boot/system/model/dto/MenuCreateDTO.java index 7d5b33c2..911de1e9 100644 --- a/src/main/java/com/youlai/boot/system/model/dto/MenuCreateDTO.java +++ b/src/main/java/com/youlai/boot/system/model/dto/MenuCreateDTO.java @@ -3,10 +3,6 @@ package com.youlai.boot.system.model.dto; /** * 创建菜单DTO * - *

承载创建菜单及其 CRUD 按钮权限所需的全部信息,由调用方(如代码生成)构造后 - * 传给 {@link com.youlai.boot.system.service.MenuService#addMenuForCodegen(Long, MenuCreateDTO)}, - * 使 system 模块无需依赖调用方的实体类型。

- * * @author Ray.Hao * @since 4.8.0 */ diff --git a/src/main/java/com/youlai/boot/system/model/dto/RolePermsDTO.java b/src/main/java/com/youlai/boot/system/model/dto/RolePermsDTO.java index 68698ded..32b6f879 100644 --- a/src/main/java/com/youlai/boot/system/model/dto/RolePermsDTO.java +++ b/src/main/java/com/youlai/boot/system/model/dto/RolePermsDTO.java @@ -12,13 +12,9 @@ import java.util.Set; @Data public class RolePermsDTO { - /** - * 角色编码 - */ + // 角色编码 private String roleCode; - /** - * 权限集合 - */ + // 权限集合 private Set perms; } \ No newline at end of file diff --git a/src/main/java/com/youlai/boot/system/model/entity/Config.java b/src/main/java/com/youlai/boot/system/model/entity/Config.java index 40a8075f..1fa7c495 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/Config.java +++ b/src/main/java/com/youlai/boot/system/model/entity/Config.java @@ -18,42 +18,28 @@ import lombok.EqualsAndHashCode; @TableName("sys_config") public class Config extends BaseEntity { - /** - * 配置名称 - */ + // 配置名称 private String configName; - /** - * 配置键 - */ + // 配置键 private String configKey; - /** - * 配置值 - */ + // 配置值 private String configValue; - /** - * 描述、备注 - */ + // 描述、备注 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String remark; - /** - * 创建人ID - */ + // 创建人ID @TableField(fill = FieldFill.INSERT) private Long createBy; - /** - * 更新人ID - */ + // 更新人ID @TableField(fill = FieldFill.INSERT_UPDATE) private Long updateBy; - /** - * 逻辑删除标识(0-未删除 1-已删除) - */ + // 逻辑删除标识(0-未删除 1-已删除) private Integer isDeleted; } diff --git a/src/main/java/com/youlai/boot/system/model/entity/Dept.java b/src/main/java/com/youlai/boot/system/model/entity/Dept.java index cb31f54d..2c5914fd 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/Dept.java +++ b/src/main/java/com/youlai/boot/system/model/entity/Dept.java @@ -18,51 +18,33 @@ import lombok.EqualsAndHashCode; @EqualsAndHashCode(callSuper = true) public class Dept extends BaseEntity { - /** - * 部门名称 - */ + // 部门名称 private String name; - /** - * 部门编码 - */ + // 部门编码 private String code; - /** - * 父节点id - */ + // 父节点id private Long parentId; - /** - * 父节点id路径 - */ + // 父节点id路径 private String treePath; - /** - * 显示顺序 - */ + // 显示顺序 private Integer sort; - /** - * 状态(1-正常 0-禁用) - */ + // 状态(1-正常 0-禁用) private Integer status; - /** - * 创建人 ID - */ + // 创建人 ID @TableField(fill = FieldFill.INSERT) private Long createBy; - /** - * 更新人 ID - */ + // 更新人 ID @TableField(fill = FieldFill.INSERT_UPDATE) private Long updateBy; - /** - * 是否删除(0-否 1-是) - */ + // 是否删除(0-否 1-是) private Integer isDeleted; } \ No newline at end of file diff --git a/src/main/java/com/youlai/boot/system/model/entity/Dict.java b/src/main/java/com/youlai/boot/system/model/entity/Dict.java index 8708c0dd..536f838e 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/Dict.java +++ b/src/main/java/com/youlai/boot/system/model/entity/Dict.java @@ -16,31 +16,21 @@ import lombok.EqualsAndHashCode; @Data public class Dict extends BaseEntity { - /** - * 字典编码 - */ + // 字典编码 private String dictCode; - /** - * 字典名称 - */ + // 字典名称 private String name; - /** - * 状态(1:启用, 0:停用) - */ + // 状态(1:启用, 0:停用) private Integer status; - /** - * 备注 - */ + // 备注 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String remark; - /** - * 逻辑删除(1-已删除 0-未删除) - */ + // 逻辑删除(1-已删除 0-未删除) private Integer isDeleted; } diff --git a/src/main/java/com/youlai/boot/system/model/entity/DictItem.java b/src/main/java/com/youlai/boot/system/model/entity/DictItem.java index e90c0c40..9da940e6 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/DictItem.java +++ b/src/main/java/com/youlai/boot/system/model/entity/DictItem.java @@ -16,58 +16,38 @@ import lombok.EqualsAndHashCode; @Data public class DictItem extends BaseEntity { - /** - * 字典编码 - */ + // 字典编码 private String dictCode; - /** - * 字典项名称 - */ + // 字典项名称 private String label; - /** - * 字典项值 - */ + // 字典项值 private String value; - /** - * 排序 - */ + // 排序 private Integer sort; - /** - * 状态(1-启用,0-停用) - */ + // 状态(1-启用,0-停用) private Integer status; - /** - * 备注 - */ + // 备注 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String remark; - /** - * 标签类型 - */ + // 标签类型 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String tagType; - /** - * 创建人 ID - */ + // 创建人 ID @TableField(fill = FieldFill.INSERT) private Long createBy; - /** - * 更新人 ID - */ + // 更新人 ID @TableField(fill = FieldFill.INSERT_UPDATE) private Long updateBy; - /** - * 逻辑删除(1-已删除 0-未删除) - */ + // 逻辑删除(1-已删除 0-未删除) private Integer isDeleted; } diff --git a/src/main/java/com/youlai/boot/system/model/entity/Menu.java b/src/main/java/com/youlai/boot/system/model/entity/Menu.java index 890a71ff..9bed7331 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/Menu.java +++ b/src/main/java/com/youlai/boot/system/model/entity/Menu.java @@ -18,85 +18,55 @@ import java.util.Map; @Data @EqualsAndHashCode(callSuper = true) public class Menu extends BaseEntity { - /** - * 父菜单ID - */ + // 父菜单ID private Long parentId; - /** - * 菜单名称 - */ + // 菜单名称 private String name; - /** - * 菜单类型(C-目录 M-菜单 E-外链 B-按钮) - */ + // 菜单类型(C-目录 M-菜单 E-外链 B-按钮) private String type; - /** - * 路由名称(Vue Router 中定义的路由名称) - */ + // 路由名称(Vue Router 中定义的路由名称) @TableField(updateStrategy = FieldStrategy.ALWAYS) private String routeName; - /** - * 路由路径(Vue Router 中定义的 URL 路径) - */ + // 路由路径(Vue Router 中定义的 URL 路径) private String routePath; - /** - * 组件路径(vue页面完整路径,省略.vue后缀) - */ + // 组件路径(vue页面完整路径,省略.vue后缀) @TableField(updateStrategy = FieldStrategy.ALWAYS) private String component; - /** - * 外链地址 - */ + // 外链地址 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String externalUrl; - /** - * 权限标识 - */ + // 权限标识 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String perm; - /** - * 显示状态(1:显示;0:隐藏) - */ + // 显示状态(1:显示;0:隐藏) private Integer visible; - /** - * 排序 - */ + // 排序 private Integer sort; - /** - * 菜单图标 - */ + // 菜单图标 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String icon; - /** - * 跳转路径 - */ + // 跳转路径 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String redirect; - /** - * 父节点路径,以英文逗号(,)分割 - */ + // 父节点路径,以英文逗号(,)分割 private String treePath; - /** - * 【菜单】是否开启页面缓存(1:开启;0:关闭) - */ + // 【菜单】是否开启页面缓存(1:开启;0:关闭) private Integer keepAlive; - /** - * 路由参数 - */ + // 路由参数 @TableField(updateStrategy = FieldStrategy.ALWAYS, typeHandler = JacksonTypeHandler.class) private Map params; diff --git a/src/main/java/com/youlai/boot/system/model/entity/Notice.java b/src/main/java/com/youlai/boot/system/model/entity/Notice.java index e2a4317b..fa7d9f09 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/Notice.java +++ b/src/main/java/com/youlai/boot/system/model/entity/Notice.java @@ -22,69 +22,43 @@ public class Notice extends BaseEntity { @Serial private static final long serialVersionUID = 1L; - /** - * 通知标题 - */ + // 通知标题 private String title; - /** - * 通知内容 - */ + // 通知内容 private String content; - /** - * 通知类型 - */ + // 通知类型 private Integer type; - /** - * 发布人 - */ + // 发布人 private Long publisherId; - /** - * 通知等级(L: 低, M: 中, H: 高) - */ + // 通知等级(L: 低, M: 中, H: 高) private String level; - /** - * 目标类型(1: 全体, 2: 指定) - */ + // 目标类型(1: 全体, 2: 指定) private Integer targetType; - /** - * 目标用户ID集合 - */ + // 目标用户ID集合 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String targetUserIds; - /** - * 发布状态(0: 未发布, 1: 已发布, -1: 已撤回) - */ + // 发布状态(0: 未发布, 1: 已发布, -1: 已撤回) private Integer publishStatus; - /** - * 发布时间 - */ + // 发布时间 private LocalDateTime publishTime; - /** - * 撤回时间 - */ + // 撤回时间 private LocalDateTime revokeTime; - /** - * 创建人ID - */ + // 创建人ID @TableField(fill = FieldFill.INSERT) private Long createBy; - /** - * 更新人ID - */ + // 更新人ID @TableField(fill = FieldFill.INSERT_UPDATE) private Long updateBy; - /** - * 逻辑删除标识(0-未删除 1-已删除) - */ + // 逻辑删除标识(0-未删除 1-已删除) private Integer isDeleted; } diff --git a/src/main/java/com/youlai/boot/system/model/entity/Role.java b/src/main/java/com/youlai/boot/system/model/entity/Role.java index d81a3823..1e91ffdb 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/Role.java +++ b/src/main/java/com/youlai/boot/system/model/entity/Role.java @@ -18,45 +18,29 @@ import lombok.EqualsAndHashCode; @EqualsAndHashCode(callSuper = true) public class Role extends BaseEntity { - /** - * 角色名称 - */ + // 角色名称 private String name; - /** - * 角色编码 - */ + // 角色编码 private String code; - /** - * 显示顺序 - */ + // 显示顺序 private Integer sort; - /** - * 角色状态(1-正常 0-停用) - */ + // 角色状态(1-正常 0-停用) private Integer status; - /** - * 数据权限 - */ + // 数据权限 private Integer dataScope; - /** - * 创建人 ID - */ + // 创建人 ID @TableField(fill = FieldFill.INSERT) private Long createBy; - /** - * 更新人 ID - */ + // 更新人 ID @TableField(fill = FieldFill.INSERT_UPDATE) private Long updateBy; - /** - * 是否删除(0-否 1-是) - */ + // 是否删除(0-否 1-是) private Integer isDeleted; } \ No newline at end of file diff --git a/src/main/java/com/youlai/boot/system/model/entity/RoleDept.java b/src/main/java/com/youlai/boot/system/model/entity/RoleDept.java index 93ef111b..dc4cd420 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/RoleDept.java +++ b/src/main/java/com/youlai/boot/system/model/entity/RoleDept.java @@ -7,8 +7,6 @@ import lombok.NoArgsConstructor; /** * 角色部门关联实体 - *

- * 用于存储角色自定义数据权限时,可访问的部门ID列表 * * @author Ray.Hao * @since 3.0.0 @@ -19,14 +17,10 @@ import lombok.NoArgsConstructor; @AllArgsConstructor public class RoleDept { - /** - * 角色ID - */ + // 角色ID private Long roleId; - /** - * 部门ID - */ + // 部门ID private Long deptId; } diff --git a/src/main/java/com/youlai/boot/system/model/entity/RoleMenu.java b/src/main/java/com/youlai/boot/system/model/entity/RoleMenu.java index e16825d6..8ac94e8d 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/RoleMenu.java +++ b/src/main/java/com/youlai/boot/system/model/entity/RoleMenu.java @@ -14,14 +14,10 @@ import lombok.NoArgsConstructor; @AllArgsConstructor @NoArgsConstructor public class RoleMenu { - /** - * 角色ID - */ + // 角色ID private Long roleId; - /** - * 菜单ID - */ + // 菜单ID private Long menuId; } \ No newline at end of file diff --git a/src/main/java/com/youlai/boot/system/model/entity/SysLog.java b/src/main/java/com/youlai/boot/system/model/entity/SysLog.java index b7712d7f..789ac82d 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/SysLog.java +++ b/src/main/java/com/youlai/boot/system/model/entity/SysLog.java @@ -18,103 +18,65 @@ import java.time.LocalDateTime; @TableName("sys_log") public class SysLog implements Serializable { - /** - * 主键 - */ + // 主键 @TableId(type = IdType.AUTO) private Long id; - /** - * 模块 - */ + // 模块 private LogModuleEnum module; - /** - * 操作类型 - */ + // 操作类型 @TableField(value = "action_type") private ActionTypeEnum actionType; - /** - * 操作标题 - */ + // 操作标题 private String title; - /** - * 自定义日志内容,最长 500 字符 - */ + // 自定义日志内容,最长 500 字符 private String content; - /** - * 操作人ID - */ + // 操作人ID private Long operatorId; - /** - * 操作人名称 - */ + // 操作人名称 private String operatorName; - /** - * 请求路径 - */ + // 请求路径 private String requestUri; - /** - * 请求方式 - */ + // 请求方式 @TableField(value = "request_method") private String requestMethod; - /** - * IP 地址 - */ + // IP 地址 private String ip; - /** - * 省份 - */ + // 省份 private String province; - /** - * 城市 - */ + // 城市 private String city; - /** - * 设备 - */ + // 设备 private String device; - /** - * 操作系统 - */ + // 操作系统 private String os; - /** - * 浏览器 - */ + // 浏览器 private String browser; - /** - * 状态:0失败 1成功 - */ + // 状态:0失败 1成功 private Integer status; - /** - * 错误信息,切面内截断至 1000 字符 - */ + // 错误信息,切面内截断至 1000 字符 @TableField(value = "error_msg") private String errorMsg; - /** - * 执行时间(毫秒) - */ + // 执行时间(毫秒) private Integer executionTime; - /** - * 操作时间 - */ + // 操作时间 private LocalDateTime createTime; } diff --git a/src/main/java/com/youlai/boot/system/model/entity/SysUser.java b/src/main/java/com/youlai/boot/system/model/entity/SysUser.java index 728edbbc..355053c6 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/SysUser.java +++ b/src/main/java/com/youlai/boot/system/model/entity/SysUser.java @@ -13,68 +13,44 @@ import lombok.EqualsAndHashCode; @EqualsAndHashCode(callSuper = true) public class SysUser extends BaseEntity { - /** - * 用户名 - */ + // 用户名 private String username; - /** - * 昵称 - */ + // 昵称 private String nickname; - /** - * 性别(1-男 2-女 0-保密) - */ + // 性别(1-男 2-女 0-保密) private Integer gender; - /** - * 密码 - */ + // 密码 private String password; - /** - * 部门ID - */ + // 部门ID private Long deptId; - /** - * 用户头像 - */ + // 用户头像 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String avatar; - /** - * 联系方式 - */ + // 联系方式 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String mobile; - /** - * 状态(1-正常 0-禁用) - */ + // 状态(1-正常 0-禁用) private Integer status; - /** - * 用户邮箱 - */ + // 用户邮箱 @TableField(updateStrategy = FieldStrategy.ALWAYS) private String email; - /** - * 创建人 ID - */ + // 创建人 ID @TableField(fill = FieldFill.INSERT) private Long createBy; - /** - * 更新人 ID - */ + // 更新人 ID @TableField(fill = FieldFill.INSERT_UPDATE) private Long updateBy; - /** - * 是否删除(0-否 1-是) - */ + // 是否删除(0-否 1-是) private Integer isDeleted; } \ No newline at end of file diff --git a/src/main/java/com/youlai/boot/system/model/entity/UserNotice.java b/src/main/java/com/youlai/boot/system/model/entity/UserNotice.java index ea91e5f7..cde22216 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/UserNotice.java +++ b/src/main/java/com/youlai/boot/system/model/entity/UserNotice.java @@ -20,15 +20,15 @@ import java.time.LocalDateTime; @TableName("sys_user_notice") public class UserNotice extends BaseEntity { - /** 公共通知id */ + // 公共通知id private Long noticeId; - /** 用户id */ + // 用户id private Long userId; - /** 读取状态,0未读,1已读 */ + // 读取状态,0未读,1已读 private Integer isRead; - /** 用户阅读时间 */ + // 用户阅读时间 private LocalDateTime readTime; - /** 逻辑删除标识(0-未删除 1-已删除) */ + // 逻辑删除标识(0-未删除 1-已删除) @TableLogic(value = "0", delval = "1") private Integer isDeleted; } diff --git a/src/main/java/com/youlai/boot/system/model/entity/UserRole.java b/src/main/java/com/youlai/boot/system/model/entity/UserRole.java index 9ab2e05d..d52a09b5 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/UserRole.java +++ b/src/main/java/com/youlai/boot/system/model/entity/UserRole.java @@ -17,13 +17,9 @@ import lombok.NoArgsConstructor; @AllArgsConstructor @NoArgsConstructor public class UserRole { - /** - * 用户ID - */ + // 用户ID private Long userId; - /** - * 角色ID - */ + // 角色ID private Long roleId; } \ No newline at end of file diff --git a/src/main/java/com/youlai/boot/system/model/entity/UserSocial.java b/src/main/java/com/youlai/boot/system/model/entity/UserSocial.java index c5bbd7fc..ee640d67 100644 --- a/src/main/java/com/youlai/boot/system/model/entity/UserSocial.java +++ b/src/main/java/com/youlai/boot/system/model/entity/UserSocial.java @@ -16,59 +16,37 @@ import java.time.LocalDateTime; @Setter public class UserSocial { - /** - * 主键ID - */ + // 主键ID private Long id; - /** - * 用户ID - */ + // 用户ID private Long userId; - /** - * 平台类型 - */ + // 平台类型 private SocialPlatformEnum platform; - /** - * 平台openid - */ + // 平台openid private String openid; - /** - * 微信unionid - */ + // 微信unionid private String unionid; - /** - * 第三方昵称 - */ + // 第三方昵称 private String nickname; - /** - * 第三方头像URL - */ + // 第三方头像URL private String avatar; - /** - * 微信session_key - */ + // 微信session_key private String sessionKey; - /** - * 是否已验证(1-已验证 0-未验证) - */ + // 是否已验证(1-已验证 0-未验证) private Integer verified; - /** - * 绑定时间 - */ + // 绑定时间 private LocalDateTime createTime; - /** - * 更新时间 - */ + // 更新时间 private LocalDateTime updateTime; } diff --git a/src/main/java/com/youlai/boot/system/model/query/UserQuery.java b/src/main/java/com/youlai/boot/system/model/query/UserQuery.java index 0f4212dd..2cde9070 100644 --- a/src/main/java/com/youlai/boot/system/model/query/UserQuery.java +++ b/src/main/java/com/youlai/boot/system/model/query/UserQuery.java @@ -24,9 +24,7 @@ public class UserQuery extends BaseQuery { @Schema(description = "角色ID") private List roleIds; - /** - * 创建时间范围,下标 0 为开始时间、下标 1 为结束时间,只传日期时自动补全为当天 00:00:00 / 23:59:59 - */ + // 创建时间范围,下标 0 为开始时间、下标 1 为结束时间,只传日期时自动补全为当天 00:00:00 / 23:59:59 @Schema(description = "创建时间范围,格式为 [开始时间, 结束时间]") private List createTime; } diff --git a/src/main/java/com/youlai/boot/system/schedule/OnlineUserCountTask.java b/src/main/java/com/youlai/boot/system/schedule/OnlineUserCountTask.java index 9eb60767..e66ecb34 100644 --- a/src/main/java/com/youlai/boot/system/schedule/OnlineUserCountTask.java +++ b/src/main/java/com/youlai/boot/system/schedule/OnlineUserCountTask.java @@ -8,7 +8,6 @@ import org.springframework.stereotype.Component; /** * 在线用户统计定时任务 - *

每 3 分钟统计并广播当前在线用户数量

* * @author Ray.Hao * @since 3.1.0 diff --git a/src/main/java/com/youlai/boot/system/schedule/XxlJobSample.java b/src/main/java/com/youlai/boot/system/schedule/XxlJobSample.java index bfaa3481..52eb68fe 100644 --- a/src/main/java/com/youlai/boot/system/schedule/XxlJobSample.java +++ b/src/main/java/com/youlai/boot/system/schedule/XxlJobSample.java @@ -6,8 +6,6 @@ import org.springframework.stereotype.Component; /** * XXL-JOB 示例任务。 - *

- * 需在调度中心配置同名任务后方可执行。 * * @author Ray.Hao * @since 3.1.0 diff --git a/src/main/java/com/youlai/boot/system/service/MenuService.java b/src/main/java/com/youlai/boot/system/service/MenuService.java index 287d2dee..2370b0e2 100644 --- a/src/main/java/com/youlai/boot/system/service/MenuService.java +++ b/src/main/java/com/youlai/boot/system/service/MenuService.java @@ -77,8 +77,6 @@ public interface MenuService extends IService

{ /** * 为代码生成创建菜单 * - *

菜单已存在(routeName 相同)时直接返回;创建成功后一并生成查询/新增/修改/删除四个按钮权限。 - * * @param parentMenuId 父菜单ID * @param dto 创建菜单数据载体 */ diff --git a/src/main/java/com/youlai/boot/system/service/RoleMenuService.java b/src/main/java/com/youlai/boot/system/service/RoleMenuService.java index 1a2d948b..29337fbb 100644 --- a/src/main/java/com/youlai/boot/system/service/RoleMenuService.java +++ b/src/main/java/com/youlai/boot/system/service/RoleMenuService.java @@ -46,8 +46,6 @@ public interface RoleMenuService extends IService { /** * 获取角色权限集合(带缓存) - *

- * 采用 Read-Through 缓存策略,缓存未命中时自动回源数据库 * * @param roleCodes 角色编码集合 * @return 权限集合 diff --git a/src/main/java/com/youlai/boot/system/service/RoleService.java b/src/main/java/com/youlai/boot/system/service/RoleService.java index 6ee665cb..e211e2da 100644 --- a/src/main/java/com/youlai/boot/system/service/RoleService.java +++ b/src/main/java/com/youlai/boot/system/service/RoleService.java @@ -40,8 +40,6 @@ public interface RoleService extends IService { /** * 角色编码下拉列表(value 为角色编码) * - *

供流程设计器候选组等按编码引用角色的场景选择

- * * @return 角色编码选项列表 */ List> listRoleCodeOptions(); @@ -111,8 +109,6 @@ public interface RoleService extends IService { /** * 获取用户所有角色的数据权限列表 - *

- * 用于实现多角色数据权限合并(并集策略) * * @param roleCodes 角色编码集合 * @return 角色数据权限列表 diff --git a/src/main/java/com/youlai/boot/system/service/UserImportReader.java b/src/main/java/com/youlai/boot/system/service/UserImportReader.java index 3cd3f909..c5ece4ec 100644 --- a/src/main/java/com/youlai/boot/system/service/UserImportReader.java +++ b/src/main/java/com/youlai/boot/system/service/UserImportReader.java @@ -28,8 +28,6 @@ import java.util.stream.Collectors; /** * 用户导入读取器。 - *

- * 基于 EasyExcel 的 {@link AnalysisEventListener},逐行读取 Excel 并完成校验、持久化。 * * @author Ray * @since 2022/4/10 @@ -37,9 +35,7 @@ import java.util.stream.Collectors; @Slf4j public class UserImportReader extends AnalysisEventListener { - /** - * Excel 导入结果 - */ + // Excel 导入结果 @Getter private final ExcelResult excelResult; @@ -52,14 +48,11 @@ public class UserImportReader extends AnalysisEventListener { private final List deptList; private final List genderList; - /** - * 当前行 - */ + // 当前行 private Integer currentRow = 1; /** * 构造方法 - *

在构造方法中给需要查询的内容查询好,尽量避免每条数据查询一次

*/ public UserImportReader() { this.userService = SpringUtil.getBean(UserService.class); @@ -78,9 +71,6 @@ public class UserImportReader extends AnalysisEventListener { /** * 每一条数据解析都会来调用 - *

- * 1. 数据校验;全字段校验 - * 2. 数据持久化; * * @param userImportDto 一行数据,类似于 {@link AnalysisContext#readRowHolder()} */ diff --git a/src/main/java/com/youlai/boot/system/service/impl/RoleMenuServiceImpl.java b/src/main/java/com/youlai/boot/system/service/impl/RoleMenuServiceImpl.java index 1d3a33ab..9914f3fc 100644 --- a/src/main/java/com/youlai/boot/system/service/impl/RoleMenuServiceImpl.java +++ b/src/main/java/com/youlai/boot/system/service/impl/RoleMenuServiceImpl.java @@ -27,11 +27,7 @@ import java.util.stream.Collectors; @Slf4j public class RoleMenuServiceImpl extends ServiceImpl implements RoleMenuService { - /** - * 权限缓存 TTL(秒)。 - * Hash 写入默认永不过期,直接改库(SQL 脚本/手工修数)不触发任何刷新点时会永久陈旧; - * 加 TTL 后过期整 Key 消失,Read-Through 按角色逐个回源重建,实现最终一致自愈 - */ + // 权限缓存 TTL(秒)。 private static final Duration ROLE_PERMS_TTL = Duration.ofSeconds(600); private final RedisTemplate redisTemplate; @@ -117,12 +113,6 @@ public class RoleMenuServiceImpl extends ServiceImpl i /** * 获取角色权限集合(带缓存) - *

- * 采用 Read-Through 缓存策略: - *

    - *
  1. 优先从 Redis Hash 缓存读取
  2. - *
  3. 缓存未命中时回源 DB 并写入缓存
  4. - *
* * @param roleCodes 角色编码集合 * @return 权限集合 diff --git a/src/main/java/com/youlai/boot/system/service/impl/RoleServiceImpl.java b/src/main/java/com/youlai/boot/system/service/impl/RoleServiceImpl.java index 84a92ec0..846ad734 100644 --- a/src/main/java/com/youlai/boot/system/service/impl/RoleServiceImpl.java +++ b/src/main/java/com/youlai/boot/system/service/impl/RoleServiceImpl.java @@ -336,8 +336,6 @@ public class RoleServiceImpl extends ServiceImpl implements Ro /** * 获取用户所有角色的数据权限列表 - *

- * 用于实现多角色数据权限合并(并集策略) * * @param roleCodes 角色编码集合 * @return 角色数据权限列表 diff --git a/src/main/java/com/youlai/boot/system/service/impl/UserServiceImpl.java b/src/main/java/com/youlai/boot/system/service/impl/UserServiceImpl.java index f6cf0602..a799774e 100644 --- a/src/main/java/com/youlai/boot/system/service/impl/UserServiceImpl.java +++ b/src/main/java/com/youlai/boot/system/service/impl/UserServiceImpl.java @@ -119,7 +119,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 新增用户. - *

校验用户名唯一性,设置默认加密密码,保存用户角色关联(事务一致)。 * * @param userForm 用户表单(username 必填且唯一,roleIds 为角色 ID 列表) * @return 新增成功返回 true @@ -155,7 +154,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 更新用户. - *

校验用户名唯一性(排除自身),同步更新角色关联(事务一致)。 * * @param userId 用户 ID * @param userForm 用户表单(username 必填且唯一,roleIds 为角色 ID 列表) @@ -214,7 +212,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 根据用户名获取认证凭证信息. - *

含角色集合和数据权限范围。 * * @param username 用户名(唯一) * @return 认证凭证,用户不存在时返回 null @@ -232,7 +229,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 根据手机号获取认证凭证信息. - *

含角色集合和数据权限范围。 * * @param mobile 手机号 * @return 认证凭证,手机号为空或用户不存在时返回 null @@ -253,7 +249,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 获取导出用户列表. - *

含性别字典翻译,用于 Excel 导出。 * * @param queryParams 查询条件(含关键字、状态、部门过滤) * @return 导出用户列表(gender 字段已翻译为中文) @@ -290,7 +285,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 获取当前登录用户信息. - *

含基础信息、部门名称、角色集合、权限集合(缓存未命中时触发全量刷新)。 * * @return 当前用户信息(含角色、权限) */ @@ -367,7 +361,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 修改个人中心用户信息. - *

仅支持修改昵称、头像、性别,至少修改一个字段。 * * @param formData 个人中心表单(nickname/avatar/gender 至少一个非空) * @return 修改成功返回 true @@ -391,7 +384,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 修改当前用户密码. - *

校验原密码,确认新旧不同,密码变更后使所有会话失效。 * * @param userId 用户 ID * @param data 密码表单(含原密码、新密码、确认密码) @@ -437,7 +429,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 重置用户密码. - *

管理员操作,重置后使该用户所有会话失效。 * * @param userId 用户 ID * @param password 新密码(明文,内部加密存储) @@ -458,7 +449,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 发送短信验证码(绑定或更换手机号). - *

校验手机号未被其他账号绑定,验证码缓存 5 分钟。 * * @param mobile 手机号 * @return 发送成功返回 true,失败返回 false 并记录日志 @@ -476,8 +466,7 @@ public class UserServiceImpl extends ServiceImpl implements throw new BusinessException("手机号已被其他账号绑定"); } - // String code = String.valueOf((int) ((Math.random() * 9 + 1) * 1000)); - // TODO 为了方便测试,验证码固定为 123456,实际开发中在配置了厂商短信服务后,可以使用上面的随机验证码 + // TODO 固定验证码 123456 便于测试,接入短信厂商后改为随机生成 String code = "123456"; Map templateParams = new HashMap<>(); @@ -499,7 +488,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 绑定或更换手机号. - *

校验密码、验证码、手机号唯一性,成功后删除验证码缓存。 * * @param form 手机号绑定表单(含密码、手机号、验证码) * @return 绑定成功返回 true @@ -554,7 +542,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 发送邮箱验证码(绑定或更换邮箱). - *

校验邮箱未被其他账号绑定,验证码缓存 5 分钟。 * * @param email 邮箱地址 * @throws BusinessException 如果邮箱已被其他账号绑定 @@ -571,8 +558,7 @@ public class UserServiceImpl extends ServiceImpl implements throw new BusinessException("邮箱已被其他账号绑定"); } - // String code = String.valueOf((int) ((Math.random() * 9 + 1) * 1000)); - // TODO 为了方便测试,验证码固定为 123456,实际开发中在配置了邮箱服务后,可以使用上面的随机验证码 + // TODO 固定验证码 123456 便于测试,接入邮箱服务后改为随机生成 String code = "123456"; emailService.send(email, "邮箱验证码", "您的验证码为:" + code + ",请在5分钟内使用"); @@ -583,7 +569,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 绑定或更换邮箱. - *

校验密码、验证码、邮箱唯一性,成功后删除验证码缓存。 * * @param form 邮箱绑定表单(含密码、邮箱、验证码) * @return 绑定成功返回 true @@ -639,7 +624,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 解绑手机号. - *

校验密码后将手机号置空。 * * @param form 密码验证表单(含密码) * @return 解绑成功返回 true @@ -671,7 +655,6 @@ public class UserServiceImpl extends ServiceImpl implements /** * 解绑邮箱. - *

校验密码后将邮箱置空。 * * @param form 密码验证表单(含密码) * @return 解绑成功返回 true diff --git a/src/test/java/com/youlai/boot/ArchitectureTest.java b/src/test/java/com/youlai/boot/ArchitectureTest.java index 62077228..3761b750 100644 --- a/src/test/java/com/youlai/boot/ArchitectureTest.java +++ b/src/test/java/com/youlai/boot/ArchitectureTest.java @@ -10,8 +10,6 @@ import static com.tngtech.archunit.library.dependencies.SlicesRuleDefinition.sli /** * 分层依赖约束 * - *

固化包之间的依赖方向,防止 common 反向依赖上层、业务模块之间形成环。

- * * @author Ray.Hao * @since 4.8.0 */ diff --git a/src/test/java/com/youlai/boot/validation/ValidationTest.java b/src/test/java/com/youlai/boot/validation/ValidationTest.java index ba043e14..7b8cb677 100644 --- a/src/test/java/com/youlai/boot/validation/ValidationTest.java +++ b/src/test/java/com/youlai/boot/validation/ValidationTest.java @@ -24,8 +24,6 @@ import static org.assertj.core.api.Assertions.assertThat; /** * 参数校验约束测试 * - *

验证关键 Form 的约束行为,并扫描全部 Controller 保证每个 @RequestBody 参数都触发 Bean Validation。

- * * @author Ray.Hao * @since 4.8.0 */