✨ 全局：简化 captcha 组件，融合到 system 模块

YunaiV
1 parent 0480cdf0
Showing 48 changed files with 43 additions and 128 deletions
yudao-dependencies/pom.xml
yudao-framework/pom.xml
yudao-framework/yudao-spring-boot-starter-captcha/pom.xml
yudao-framework/yudao-spring-boot-starter-captcha/src/main/java/cn/iocoder/yudao/framework/captcha/config/YudaoCaptchaConfiguration.java
yudao-framework/yudao-spring-boot-starter-captcha/src/main/java/cn/iocoder/yudao/framework/captcha/core/enums/CaptchaRedisKeyConstants.java
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/META-INF/services/com.xingyuv.captcha.service.CaptchaCacheService
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
yudao-module-system/yudao-module-system-biz/pom.xml
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/captcha/config/YudaoCaptchaConfiguration.java
yudao-module-system/yudao-module-system-biz/src/main/resources/META-INF/services/com.xingyuv.captcha.service.CaptchaCacheService
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg1.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg1.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg2.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg2.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg3.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg3.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg4.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg4.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg5.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg5.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg6.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg6.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg7.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg7.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg8.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg8.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/jigsaw/original/bg9.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/jigsaw/original/bg9.png
yudao-framework/yudao-spring-boot-starter-captcha/src/main/resources/images/pic-click/bg1.png → yudao-module-system/yudao-module-system-biz/src/main/resources/images/pic-click/bg1.png
@@ -131,16 +131,6 @@
                 <artifactId>yudao-spring-boot-starter-biz-ip</artifactId>
                 <version>${revision}</version>
             </dependency>
-            <dependency>
-                <groupId>cn.iocoder.boot</groupId>
-                <artifactId>yudao-spring-boot-starter-captcha</artifactId>
-                <version>${revision}</version>
-            </dependency>
-            <dependency>
-                <groupId>cn.iocoder.boot</groupId>
-                <artifactId>yudao-spring-boot-starter-desensitize</artifactId>
-                <version>${revision}</version>
-            </dependency>
  
             <!-- Spring 核心 -->
             <dependency>
@@ -33,7 +33,6 @@
         <module>yudao-spring-boot-starter-biz-ip</module>
  
         <module>yudao-spring-boot-starter-flowable</module>
-        <module>yudao-spring-boot-starter-captcha</module>
         <module>yudao-spring-boot-starter-websocket</module>
     </modules>
  
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <parent>
-        <groupId>cn.iocoder.boot</groupId>
-        <artifactId>yudao-framework</artifactId>
-        <version>${revision}</version>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-    <artifactId>yudao-spring-boot-starter-captcha</artifactId>
-    <packaging>jar</packaging>
-
-    <name>${project.artifactId}</name>
-    <description>验证码拓展
-        1. 基于 aj-captcha 实现滑块验证码，文档：https://ajcaptcha.beliefteam.cn/captcha-doc/
-    </description>
-
-    <dependencies>
-        <dependency>
-            <groupId>com.xingyuv</groupId>
-            <artifactId>spring-boot-starter-captcha-plus</artifactId>
-        </dependency>
-        <!-- Spring 核心 -->
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter</artifactId>
-        </dependency>
-
-        <!-- DB 相关 -->
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-redis</artifactId>
-        </dependency>
-
-    </dependencies>
-
-</project>
-package cn.iocoder.yudao.framework.captcha.config;
-
-import cn.iocoder.yudao.framework.captcha.core.service.RedisCaptchaServiceImpl;
-import com.xingyuv.captcha.properties.AjCaptchaProperties;
-import com.xingyuv.captcha.service.CaptchaCacheService;
-import com.xingyuv.captcha.service.impl.CaptchaServiceFactory;
-import org.springframework.boot.autoconfigure.AutoConfiguration;
-import org.springframework.context.annotation.Bean;
-import org.springframework.data.redis.core.StringRedisTemplate;
-
-import jakarta.annotation.Resource;
-
-@AutoConfiguration
-public class YudaoCaptchaConfiguration {
-
-    @Resource
-    private StringRedisTemplate stringRedisTemplate;
-
-    @Bean
-    public CaptchaCacheService captchaCacheService(AjCaptchaProperties config) {
-        // 缓存类型 redis/local/....
-        CaptchaCacheService ret = CaptchaServiceFactory.getCache(config.getCacheType().name());
-        if (ret instanceof RedisCaptchaServiceImpl) {
-            ((RedisCaptchaServiceImpl) ret).setStringRedisTemplate(stringRedisTemplate);
-        }
-        return ret;
-    }
-
-}
-package cn.iocoder.yudao.framework.captcha.core.enums;
-
-/**
- * 验证码 Redis Key 枚举类
- *
- * @author 芋道源码
- */
-public interface CaptchaRedisKeyConstants {
-
-    /**
-     * 验证码的请求限流
-     *
-     * KEY 格式：AJ.CAPTCHA.REQ.LIMIT-%s-%s
-     * VALUE 数据类型：String // 例如说：验证失败 5 次，get 接口锁定
-     * 过期时间：60 秒
-     */
-    String AJ_CAPTCHA_REQ_LIMIT = "AJ.CAPTCHA.REQ.LIMIT-%s-%s";
-
-    /**
-     * 验证码的坐标
-     *
-     * KEY 格式：RUNNING:CAPTCHA:%s // AbstractCaptchaService.REDIS_CAPTCHA_KEY
-     * VALUE 数据类型：String // PointVO.class {"secretKey":"PP1w2Frr2KEejD2m","x":162,"y":5}
-     * 过期时间：120 秒
-     */
-    String AJ_CAPTCHA_RUNNING = "RUNNING:CAPTCHA:%s";
-
-}
-cn.iocoder.yudao.framework.captcha.core.service.RedisCaptchaServiceImpl
-cn.iocoder.yudao.framework.captcha.config.YudaoCaptchaConfiguration
 \ No newline at end of file
@@ -99,11 +99,6 @@
         </dependency>
  
         <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-captcha</artifactId>
-        </dependency>
-
-        <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-mail</artifactId>
         </dependency>
@@ -135,6 +130,11 @@
             <groupId>com.tencentcloudapi</groupId>
             <artifactId>tencentcloud-sdk-java-sms</artifactId> <!-- 短信（腾讯云） -->
         </dependency>
+
+        <dependency>
+            <groupId>com.xingyuv</groupId>
+            <artifactId>spring-boot-starter-captcha-plus</artifactId> <!-- 验证码，一般用于登录使用 -->
+        </dependency>
     </dependencies>
  
 </project>
+package cn.iocoder.yudao.module.system.framework.captcha.config;
+
+import cn.iocoder.yudao.module.system.framework.captcha.core.RedisCaptchaServiceImpl;
+import com.xingyuv.captcha.properties.AjCaptchaProperties;
+import com.xingyuv.captcha.service.CaptchaCacheService;
+import com.xingyuv.captcha.service.impl.CaptchaServiceFactory;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.redis.core.StringRedisTemplate;
+
+/**
+ * 验证码的配置类
+ *
+ * @author 芋道源码
+ */
+@Configuration(proxyBeanMethods = false)
+public class YudaoCaptchaConfiguration {
+
+    @Bean
+    public CaptchaCacheService captchaCacheService(AjCaptchaProperties config,
+                                                   StringRedisTemplate stringRedisTemplate) {
+        CaptchaCacheService captchaCacheService = CaptchaServiceFactory.getCache(config.getCacheType().name());
+        if (captchaCacheService instanceof RedisCaptchaServiceImpl) {
+            ((RedisCaptchaServiceImpl) captchaCacheService).setStringRedisTemplate(stringRedisTemplate);
+        }
+        return captchaCacheService;
+    }
+
+}
-package cn.iocoder.yudao.framework.captcha.core.service;
+package cn.iocoder.yudao.module.system.framework.captcha.core;
  
 import com.xingyuv.captcha.service.CaptchaCacheService;
-import lombok.AllArgsConstructor;
-import lombok.NoArgsConstructor;
+import lombok.Setter;
 import org.springframework.data.redis.core.StringRedisTemplate;
  
-import jakarta.annotation.Resource;
 import java.util.concurrent.TimeUnit;
  
 /**
@@ -13,11 +11,9 @@ import java.util.concurrent.TimeUnit;
  *
  * @author 星语
  */
-@NoArgsConstructor // 保证 aj-captcha 的 SPI 创建
-@AllArgsConstructor
+@Setter
 public class RedisCaptchaServiceImpl implements CaptchaCacheService {
  
-    @Resource // 保证 aj-captcha 的 SPI 创建时的注入
     private StringRedisTemplate stringRedisTemplate;
  
     @Override
@@ -25,10 +21,6 @@ public class RedisCaptchaServiceImpl implements CaptchaCacheService {
         return "redis";
     }
  
-    public void setStringRedisTemplate(StringRedisTemplate stringRedisTemplate) {
-        this.stringRedisTemplate = stringRedisTemplate;
-    }
-
     @Override
     public void set(String key, String value, long expiresInSeconds) {
         stringRedisTemplate.opsForValue().set(key, value, expiresInSeconds, TimeUnit.SECONDS);
 /**
  * 验证码拓展
- * 1. 基于 aj-captcha 实现滑块验证码，文档：https://ajcaptcha.beliefteam.cn/captcha-doc/
+ *
+ * 基于 aj-captcha 实现滑块验证码，文档：https://ajcaptcha.beliefteam.cn/captcha-doc/
  *
  * @author 星语
  */
-package cn.iocoder.yudao.framework.captcha;
+package cn.iocoder.yudao.module.system.framework.captcha;
 \ No newline at end of file
+cn.iocoder.yudao.module.system.framework.captcha.core.RedisCaptchaServiceImpl
@@ -207,8 +207,8 @@ public class AdminAuthServiceImplTest extends BaseDbUnitTest {
     public void testSmsLogin_success() {
         // 准备参数
         String mobile = randomString();
-        String scene = randomString();
-        AuthSmsLoginReqVO reqVO = new AuthSmsLoginReqVO(mobile, scene);
+        String code = randomString();
+        AuthSmsLoginReqVO reqVO = new AuthSmsLoginReqVO(mobile, code);
         // mock 方法（用户信息）
         AdminUserDO user = randomPojo(AdminUserDO.class, o -> o.setId(1L));
         when(userService.getUserByMobile(eq(mobile))).thenReturn(user);