1.5.0重构;

修复一大堆已知问题，优化代码，增加 application 类，重构拦截器组件，添加缓存模块，
2024-07-12 14:54:25 +08:00
parent db2f409783
commit 2cfb72349d
42 changed files with 2311 additions and 192 deletions
@@ -0,0 +1,152 @@
+package cloud.tianai.captcha.application;
+
+
+import cloud.tianai.captcha.application.vo.CaptchaResponse;
+import cloud.tianai.captcha.application.vo.ImageCaptchaVO;
+import cloud.tianai.captcha.cache.CacheStore;
+import cloud.tianai.captcha.common.response.ApiResponse;
+import cloud.tianai.captcha.generator.ImageCaptchaGenerator;
+import cloud.tianai.captcha.generator.common.model.dto.GenerateParam;
+import cloud.tianai.captcha.interceptor.CaptchaInterceptor;
+import cloud.tianai.captcha.resource.ImageCaptchaResourceManager;
+import cloud.tianai.captcha.validator.ImageCaptchaValidator;
+import cloud.tianai.captcha.validator.common.model.dto.ImageCaptchaTrack;
+
+/**
+ * @Author: 天爱有情
+ * @Date 2020/5/29 8:33
+ * @Description 滑块验证码应用程序
+ */
+public interface ImageCaptchaApplication {
+
+    /**
+     * 生成滑块验证码
+     *
+     * @return
+     */
+    CaptchaResponse<ImageCaptchaVO> generateCaptcha();
+
+    /**
+     * 生成滑块验证码
+     *
+     * @param type type类型
+     * @return CaptchaResponse<SliderCaptchaVO>
+     */
+    CaptchaResponse<ImageCaptchaVO> generateCaptcha(String type);
+
+    /**
+     * 生成滑块验证码
+     *
+     * @param captchaImageType 要生成webp还是jpg类型的图片
+     * @return CaptchaResponse<SliderCaptchaVO>
+     */
+    CaptchaResponse<ImageCaptchaVO> generateCaptcha(CaptchaImageType captchaImageType);
+
+    /**
+     * 生成验证码
+     *
+     * @param type             type
+     * @param captchaImageType CaptchaImageType
+     * @return CaptchaResponse<ImageCaptchaVO>
+     */
+    CaptchaResponse<ImageCaptchaVO> generateCaptcha(String type, CaptchaImageType captchaImageType);
+
+
+    /**
+     * 生成滑块验证码
+     *
+     * @param param param
+     * @return CaptchaResponse<SliderCaptchaVO>
+     */
+    CaptchaResponse<ImageCaptchaVO> generateCaptcha(GenerateParam param);
+
+    /**
+     * 匹配
+     *
+     * @param id                验证码的ID
+     * @param imageCaptchaTrack 滑动轨迹
+     * @return 匹配成功返回true， 否则返回false
+     */
+    ApiResponse<?> matching(String id, ImageCaptchaTrack imageCaptchaTrack);
+
+    /**
+     * 兼容一下旧版本，新版本建议使用 {@link ImageCaptchaApplication#matching(String, ImageCaptchaTrack)}
+     *
+     * @param id         id
+     * @param percentage 百分比数据
+     * @return boolean
+     */
+    @Deprecated
+    boolean matching(String id, Float percentage);
+
+    /**
+     * 查询该ID是属于哪个验证码类型
+     *
+     * @param id id
+     * @return String
+     */
+    String getCaptchaTypeById(String id);
+
+    /**
+     * 获取验证码资源管理器
+     *
+     * @return SliderCaptchaResourceManager
+     */
+    ImageCaptchaResourceManager getImageCaptchaResourceManager();
+
+    /**
+     * 设置 SliderCaptchaValidator 验证码验证器
+     *
+     * @param imageCaptchaValidator imageCaptchaValidator
+     */
+    void setImageCaptchaValidator(ImageCaptchaValidator imageCaptchaValidator);
+
+    /**
+     * 设置 ImageCaptchaGenerator 验证码生成器
+     *
+     * @param imageCaptchaGenerator SliderCaptchaGenerator
+     */
+    void setImageCaptchaGenerator(ImageCaptchaGenerator imageCaptchaGenerator);
+
+    /**
+     * 获取拦截器
+     *
+     * @return CaptchaInterceptor
+     */
+    CaptchaInterceptor getCaptchaInterceptor();
+    /**
+     * 设置 拦截器
+     *
+     * @param captchaInterceptor captchaInterceptor
+     */
+    void setCaptchaInterceptor(CaptchaInterceptor captchaInterceptor);
+
+    /**
+     * 设置 缓存存储器
+     *
+     * @param cacheStore cacheStore
+     */
+    void setCacheStore(CacheStore cacheStore);
+
+    /**
+     * 获取验证码验证器
+     *
+     * @return SliderCaptchaValidator
+     */
+    ImageCaptchaValidator getImageCaptchaValidator();
+
+    /**
+     * 获取验证码生成器
+     *
+     * @return SliderCaptchaTemplate
+     */
+    ImageCaptchaGenerator getImageCaptchaGenerator();
+
+    /**
+     * 获取缓存存储器
+     *
+     * @return CacheStore
+     */
+    CacheStore getCacheStore();
+
+}