优化

2026-05-07 06:04:34 +08:00 · 2022-05-07 11:14:15 +08:00
parent d802fd481a
commit afbb88c67d
46 changed files with 376 additions and 260 deletions
@@ -1,4 +1,4 @@
-这是一个滑块验证码的实现
+这是一个行为验证码的实现

 ## [在线体验](https://www.tianai.cloud)

@@ -6,18 +6,27 @@

 ![](image/1.png)
 ![](image/2.png)
-![](image/3.png)
 ![](image/4.png)
 ![](image/5.png)
 ![](image/6.png)
+![](image/7.png)
+![](image/9.png)
+![](image/10.png)
+![](image/11.png)
+![](image/12.png)

- 该滑块验证码实现了 普通图片和 **webp**图片两种格式
- java获取滑块验证码例子
+## 简单介绍
+- tianai-captcha 目前支持的行为验证码类型
+    - 滑块验证码
+    - 旋转验证码
+    - 滑动还原验证码
+    - 文字点选验证码
+    - 后面会陆续支持市面上更多好玩的验证码玩法... 敬请期待
+
+- 该滑块验证码实现了 普通图片和 **webp**(拷贝github大神开源的webp图片生成代码)图片两种格式

 ## 快速上手

-
-
 如果是SpringBoot开发者可直接使用SpringBoot快速启动器[tianai-captcha-springboot-starter](https://gitee.com/tianai/tianai-captcha-springboot-starter)

 ### 1. 导入xml
@@ -27,47 +36,59 @@
 <dependency>
    <groupId>cloud.tianai.captcha</groupId>
    <artifactId>tianai-captcha</artifactId>
-    <version>1.3.0.RELEASE</version>
+    <version>1.3.1</version>
 </dependency>
 ```

-### 2. 使用 `SliderCaptchaGenerator`生成器生成滑块验证码
+### 2. 使用 `ImageCaptchaGenerator`生成器生成验证码

 ```java
-import cloud.tianai.captcha.template.slider.generator.impl.StandardSliderImageCaptchaGenerator;
-import cloud.tianai.captcha.template.slider.generator.impl.StandardSliderCaptchaGenerator;
-import cloud.tianai.captcha.template.slider.resource.ImageCaptchaResourceManager;
-import cloud.tianai.captcha.template.slider.resource.impl.DefaultImageCaptchaResourceManager;
+import cloud.tianai.captcha.common.constant.CaptchaTypeConstant;
+import cloud.tianai.captcha.generator.common.model.dto.ImageCaptchaInfo;
+import cloud.tianai.captcha.generator.impl.MultiImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.impl.StandardSliderImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.impl.StandardSliderCaptchaGenerator;
+import cloud.tianai.captcha.resource.ImageCaptchaResourceManager;
+import cloud.tianai.captcha.resource.impl.DefaultImageCaptchaResourceManager;

 public class Test {
    public static void main(String[] args) throws InterruptedException {
        ImageCaptchaResourceManager imageCaptchaResourceManager = new DefaultImageCaptchaResourceManager();
-        StandardSliderImageCaptchaGenerator sliderCaptchaGenerator = new StandardSliderImageCaptchaGenerator(imageCaptchaResourceManager, true);
-        // 生成滑块图片
-        SliderCaptchaInfo slideImageInfo = sliderCaptchaGenerator.generateCaptchaImage();
-        System.out.println(slideImageInfo);
+        MultiImageCaptchaGenerator imageCaptchaGenerator = new MultiImageCaptchaGenerator(imageCaptchaResourceManager, true);
+        /*
+                生成滑块验证码图片, 可选项
+                SLIDER (滑块验证码)
+                ROTATE (旋转验证码)
+                CONCAT (滑动还原验证码)
+                WORD_IMAGE_CLICK (文字点选验证码)
+                
+                更多验证码支持 详见 cloud.tianai.captcha.common.constant.CaptchaTypeConstant
+         */
+        ImageCaptchaInfo imageCaptchaInfo = imageCaptchaGenerator.generateCaptchaImage(CaptchaTypeConstant.SLIDER);
+        System.out.println(imageCaptchaInfo);

        // 负责计算一些数据存到缓存中，用于校验使用
-        // SliderCaptchaValidator负责校验用户滑动滑块是否正确和生成滑块的一些校验数据; 比如滑块到凹槽的百分比值
-        SliderCaptchaValidator sliderCaptchaValidator = new BasicCaptchaTrackValidator();
+        // ImageCaptchaValidator负责校验用户滑动滑块是否正确和生成滑块的一些校验数据; 比如滑块到凹槽的百分比值
+        ImageCaptchaValidator imageCaptchaValidator = new BasicCaptchaTrackValidator();
        // 这个map数据应该存到缓存中，校验的时候需要用到该数据
-        Map<String, Object> map = sliderCaptchaValidator.generateSliderCaptchaValidData(slideImageInfo);
+        Map<String, Object> map = imageCaptchaValidator.generateSliderCaptchaValidData(imageCaptchaInfo);
    }
 }
 ```

-### 3. 使用`SliderCaptchaValidator`校验器 验证
+### 3. 使用`ImageCaptchaGenerator`校验器 验证

 ```java
-import cloud.tianai.captcha.template.slider.generator.ImageCaptchaGenerator;
-import cloud.tianai.captcha.template.slider.generator.SliderCaptchaGenerator;
+import cloud.tianai.captcha.generator.ImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.SliderCaptchaGenerator;
+import cloud.tianai.captcha.validator.ImageCaptchaValidator;

 public class Test2 {
    public static void main(String[] args) {
-        ImageCaptchaGenerator sliderCaptchaValidator = new BasicCaptchaTrackValidator();
+        ImageCaptchaValidator sliderCaptchaValidator = new BasicCaptchaTrackValidator();

        // 用户传来的行为轨迹和进行校验 
-        // - sliderCaptchaTrack为前端传来的滑动轨迹数据
+        // - imageCaptchaTrack为前端传来的滑动轨迹数据
        // - map 为生成验证码时缓存的map数据
        boolean check = sliderCaptchaValidator.valid(imageCaptchaTrack, map);
        // 如果只想校验用户是否滑到指定凹槽即可，也可以使用
@@ -80,14 +101,14 @@ public class Test2 {

 ## 整体架构设计

-> tianai-captcha 验证码整体分为 生成器(`SliderCaptchaGenerator`)、校验器(`SliderCaptchaValidato`r)、资源管理器(`SliderCaptchaResourceManager`)
+> tianai-captcha 验证码整体分为 生成器(`ImageCaptchaGenerator`)、校验器(`ImageCaptchaValidator`)、资源管理器(`ImageCaptchaResourceManager`)
 > 其中生成器、校验器、资源管理器等都是基于接口模式实现 可插拔的，可以替换为自定义实现，灵活度高

- 生成器(`SliderCaptchaGenerator`)
+- 生成器(`ImageCaptchaGenerator`)
    - 主要负责生成滑块验证码所需的图片
- 校验器(`SliderCaptchaValidator`)
+- 校验器(`ImageCaptchaValidator`)
    - 主要负责校验用户滑动的行为轨迹是否合规
- 资源管理器(`SliderCaptchaResourceManager`)
+- 资源管理器(`ImageCaptchaResourceManager`)
    - 主要负责读取验证码背景图片和模板图片等
    - 资源管理器细分为 资源存储(`ResourceStore`)、资源提供者(`ResourceProvider`)
        - 资源存储(`ResourceStore`) 负责存储背景图和模板图
@@ -95,17 +116,26 @@ public class Test2 {
            - 一般资源存储器中存储的是图片的url地址或者id之类， 资源提供者 就是负责将url或者别的id转换为真正的图片文件

 ## 扩展
+
 ### 生成带有混淆滑块的图片

 ```java
+import cloud.tianai.captcha.common.constant.CaptchaTypeConstant;
+import cloud.tianai.captcha.generator.ImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.common.model.dto.ImageCaptchaInfo;
+import cloud.tianai.captcha.generator.impl.MultiImageCaptchaGenerator;
+import cloud.tianai.captcha.resource.ImageCaptchaResourceManager;
+import cloud.tianai.captcha.resource.impl.DefaultImageCaptchaResourceManager;
+
 public class Test {
    public static void main(String[] args) {
        // 资源管理器
-        SliderCaptchaResourceManager imageCaptchaResourceManager = new DefaultSliderCaptchaResourceManager();
+        ImageCaptchaResourceManager imageCaptchaResourceManager = new DefaultImageCaptchaResourceManager();
        // 标准验证码生成器
-        StandardSliderCaptchaGenerator sliderCaptchaGenerator = new StandardSliderCaptchaGenerator(imageCaptchaResourceManager, true);
-        // 生成滑块图片
-        SliderCaptchaInfo slideImageInfo = sliderCaptchaGenerator.generateSlideImageInfo(GenerateParam.builder()
+        ImageCaptchaGenerator imageCaptchaGenerator = new MultiImageCaptchaGenerator(imageCaptchaResourceManager, true);
+        // 生成 具有混淆的 滑块验证码 (目前只有滑块验证码支持混淆滑块， 旋转验证，滑动还原，点选验证 均不支持混淆功能)
+        ImageCaptchaInfo imageCaptchaInfo = imageCaptchaGenerator.generateCaptchaImage(GenerateParam.builder()
+                .type(CaptchaTypeConstant.SLIDER)
                .sliderFormatName("jpeg")
                .backgroundFormatName("png")
                // 是否添加混淆滑块
@@ -118,18 +148,23 @@ public class Test {
 ### 生成webp格式的滑块图片

 ```java
+import cloud.tianai.captcha.common.constant.CaptchaTypeConstant;
+import cloud.tianai.captcha.generator.ImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.impl.MultiImageCaptchaGenerator;
+import cloud.tianai.captcha.resource.ImageCaptchaResourceManager;
+import cloud.tianai.captcha.resource.impl.DefaultImageCaptchaResourceManager;
+
 public class Test {
    public static void main(String[] args) {
        // 资源管理器
-        SliderCaptchaResourceManager imageCaptchaResourceManager = new DefaultSliderCaptchaResourceManager();
+        ImageCaptchaResourceManager imageCaptchaResourceManager = new DefaultImageCaptchaResourceManager();
        // 标准验证码生成器
-        StandardSliderCaptchaGenerator sliderCaptchaGenerator = new StandardSliderCaptchaGenerator(imageCaptchaResourceManager, true);
-        // 生成滑块图片
+        ImageCaptchaGenerator imageCaptchaGenerator = new MultiImageCaptchaGenerator(imageCaptchaResourceManager, true);
+        // 生成旋转验证码 图片类型为 webp
        SliderCaptchaInfo slideImageInfo = sliderCaptchaGenerator.generateSlideImageInfo(GenerateParam.builder()
+                .type(CaptchaTypeConstant.ROTATE)
                .sliderFormatName("webp")
                .backgroundFormatName("webp")
-                // 是否添加混淆滑块
-                .obfuscate(false)
                .build());
    }
 }
@@ -140,8 +175,16 @@ public class Test {
 - 自定义图片资源大小为 590*360 格式为jpg

 ```java
- public class Test {
+ import cloud.tianai.captcha.resource.ImageCaptchaResourceManager;
+import cloud.tianai.captcha.resource.ResourceStore;
+import cloud.tianai.captcha.resource.common.model.dto.Resource;
+import cloud.tianai.captcha.resource.impl.DefaultImageCaptchaResourceManager;
+import cloud.tianai.captcha.resource.impl.provider.ClassPathResourceProvider;
+import cloud.tianai.captcha.resource.impl.provider.URLResourceProvider;
+
+public class Test {
    public static void main(String[] args) {
+        ImageCaptchaResourceManager imageCaptchaResourceManager = new DefaultImageCaptchaResourceManager();
        // 通过资源管理器或者资源存储器
        ResourceStore resourceStore = imageCaptchaResourceManager.getResourceStore();
        // 添加classpath目录下的 aa.jpg 图片      
@@ -162,11 +205,17 @@ public class Test {
    - 模板大小为 110*360 格式为png，该图为固定格式，是一张纯透明图片

 ```java
- public class Test {
+import cloud.tianai.captcha.generator.common.constant.SliderCaptchaConstant;
+import cloud.tianai.captcha.resource.ImageCaptchaResourceManager;
+import cloud.tianai.captcha.resource.ResourceStore;
+import cloud.tianai.captcha.resource.impl.DefaultImageCaptchaResourceManager;
+
+public class Test {
    public static void main(String[] args) {
+        ImageCaptchaResourceManager imageCaptchaResourceManager = new DefaultImageCaptchaResourceManager();
        // 通过资源管理器或者资源存储器
        ResourceStore resourceStore = imageCaptchaResourceManager.getResourceStore();
-        // 添加模板.模板图片由三张图片组成
+        // 添加滑块验证码模板.模板图片由三张图片组成
        Map<String, Resource> template1 = new HashMap<>(4);
        template1.put(SliderCaptchaConstant.TEMPLATE_ACTIVE_IMAGE_NAME, new Resource(ClassPathResourceProvider.NAME, "/active.png"));
        template1.put(SliderCaptchaConstant.TEMPLATE_FIXED_IMAGE_NAME, new Resource(ClassPathResourceProvider.NAME, "/fixed.png"));
@@ -181,45 +230,61 @@ public class Test {
 - 清除内置的图片资源和模板资源

 ```java
+import cloud.tianai.captcha.generator.ImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.impl.MultiImageCaptchaGenerator;
+
 public class Test {
    public static void main(String[] args) {
        //为方便快速上手 系统本身自带了一张图片和两套滑块模板，如果不想用系统自带的可以不让它加载系统自带的
        // 第二个构造参数设置为false时将不加载默认的图片和模板
-        SliderCaptchaGenerator sliderCaptchaGenerator = new StandardSliderCaptchaGenerator(imageCaptchaResourceManager, false);
+        ImageCaptchaGenerator imageCaptchaGenerator = new MultiImageCaptchaGenerator(imageCaptchaResourceManager, false);
    }
 }
 ```

-### 自定义 `SliderCaptchaValidator` 校验器
+### 自定义 `imageCaptchaValidator` 校验器

 ```java
 // 该接口负责对用户滑动验证码后传回的数据进行校验，比如滑块是否滑到指定位置，滑块行为轨迹是否正常等等
 // 该接口的默认实现有 
-// SimpleSliderCaptchaValidator 校验用户是否滑到了指定缺口处
-// BasicCaptchaTrackValidator 是对 SimpleSliderCaptchaValidator增强
-// BasicCaptchaTrackValidator是对SimpleSliderCaptchaValidator的增强 对滑动轨迹进行了简单的验证
+// SimpleImageCaptchaValidator 校验用户是否滑到了指定缺口处
+// BasicCaptchaTrackValidator 是对 SimpleImageCaptchaValidator增强
+// BasicCaptchaTrackValidator是对SimpleImageCaptchaValidator的增强 对滑动轨迹进行了简单的验证
 // 友情提示 因为BasicCaptchaTrackValidator 里面校验滑动轨迹的算法已经开源，有强制要求的建议重写该接口的方法，避免被破解
 ```

 ### 自定义 `ResourceProvider` 实现自定义文件读取策略， 比如 oss之类的

 ```java
- public class Test {
+ import cloud.tianai.captcha.generator.ImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.impl.MultiImageCaptchaGenerator;
+import cloud.tianai.captcha.resource.ImageCaptchaResourceManager;
+import cloud.tianai.captcha.resource.impl.DefaultImageCaptchaResourceManager;
+
+public class Test {
    public static void main(String[] args) {
        // 实现了 ResourceProvider 后
-        SliderCaptchaResourceManager imageCaptchaResourceManager = new DefaultSliderCaptchaResourceManager();
-        StandardSliderCaptchaGenerator sliderCaptchaGenerator = new StandardSliderCaptchaGenerator(imageCaptchaResourceManager, true);
+        ImageCaptchaResourceManager imageCaptchaResourceManager = new DefaultImageCaptchaResourceManager();
+        ImageCaptchaGenerator imageCaptchaGenerator = new MultiImageCaptchaGenerator(imageCaptchaResourceManager, true);
        // 注册
        imageCaptchaResourceManager.registerResourceProvider(new CustomResourceProvider());
    }
 }
 ```

-### 扩展，对`StandardSliderCaptchaGenerator`增加了缓存模块
+### 扩展，对`StandardImageCaptchaGenerator`增加了缓存模块

 > 由于实时生成滑块图片可能会有一点性能影响，内部基于`StandardSliderCaptchaGenerator`进行了提前缓存生成好的图片，`CacheSliderCaptchaGenerator` 这只是基本的缓存逻辑，比较简单，用户可以定义一些更加有意思的扩展，用于突破性能瓶颈

 ```java
+import cloud.tianai.captcha.common.constant.CaptchaTypeConstant;
+import cloud.tianai.captcha.generator.ImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.common.model.dto.ImageCaptchaInfo;
+import cloud.tianai.captcha.generator.impl.CacheImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.impl.MultiImageCaptchaGenerator;
+import cloud.tianai.captcha.resource.ImageCaptchaResourceManager;
+import cloud.tianai.captcha.resource.impl.DefaultImageCaptchaResourceManager;
+
 public class Test {
    public static void main(String[] args) throws InterruptedException {
        // 使用 CacheSliderCaptchaGenerator 对滑块验证码进行缓存，使其提前生成滑块图片
@@ -227,17 +292,16 @@ public class Test {
        // 参数二: 默认提前缓存多少个
        // 参数三: 出错后 等待xx时间再进行生成
        // 参数四: 检查时间间隔    
-        SliderCaptchaResourceManager imageCaptchaResourceManager = new DefaultSliderCaptchaResourceManager();
-        SliderCaptchaGenerator sliderCaptchaGenerator = new CacheSliderCaptchaGenerator(new StandardSliderCaptchaGenerator(imageCaptchaResourceManager, true), 10, 1000, 100);
+        ImageCaptchaResourceManager imageCaptchaResourceManager = new DefaultImageCaptchaResourceManager();
+        ImageCaptchaGenerator imageCaptchaGenerator = new CacheImageCaptchaGenerator(new MultiImageCaptchaGenerator(imageCaptchaResourceManager, true), 10, 1000, 100);
        // 生成滑块图片
-        SliderCaptchaInfo slideImageInfo = sliderCaptchaGenerator.generateSlideImageInfo();
+        ImageCaptchaInfo slideImageInfo = imageCaptchaGenerator.generateCaptchaImage(CaptchaTypeConstant.SLIDER);
        // 获取背景图片的base64
        String backgroundImage = slideImageInfo.getBackgroundImage();
        // 获取滑块图片
-        slideImageInfo.getSliderImage();
+        String sliderImage = slideImageInfo.getSliderImage();
        System.out.println(slideImageInfo);
    }
 }
 ```
-
 # qq群: 1021884609