调整包结构 更改版本为1.3.1

This commit is contained in:
天爱有情
2022-04-20 12:00:45 +08:00
parent e9e60b9178
commit ef04a4e5a7
29 changed files with 95 additions and 71 deletions
+1 -1
View File
@@ -4,7 +4,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>cloud.tianai.captcha</groupId>
<artifactId>tianai-captcha</artifactId>
<version>1.2.7</version>
<version>1.3.1</version>
<name>tianai-captcha</name>
<description>滑块验证码</description>
+9 -9
View File
@@ -24,7 +24,7 @@
<dependency>
<groupId>cloud.tianai.captcha</groupId>
<artifactId>tianai-captcha</artifactId>
<version>1.2.7</version>
<version>1.3.1</version>
</dependency>
```
### 2. 使用 `SliderCaptchaTemplate`获取滑块验证码
@@ -65,9 +65,9 @@ check =sliderCaptchaValidator.checkPercentage(0.2f, percentage);
```java
SliderCaptchaResourceManager sliderCaptchaResourceManager = new DefaultSliderCaptchaResourceManager();
StandardSliderCaptchaTemplate sliderCaptchaTemplate = new StandardSliderCaptchaTemplate(sliderCaptchaResourceManager, true);
StandardSliderCaptchaGenerator sliderCaptchaGenerator = new StandardSliderCaptchaGenerator(sliderCaptchaResourceManager, true);
// 生成滑块图片
SliderCaptchaInfo slideImageInfo = sliderCaptchaTemplate.getSlideImageInfo(GenerateParam.builder()
SliderCaptchaInfo slideImageInfo = sliderCaptchaGenerator.generateSlideImageInfo(GenerateParam.builder()
.sliderFormatName("jpeg")
.backgroundFormatName("png")
// 是否添加混淆滑块
@@ -79,9 +79,9 @@ SliderCaptchaInfo slideImageInfo = sliderCaptchaTemplate.getSlideImageInfo(Gener
```java
SliderCaptchaResourceManager sliderCaptchaResourceManager = new DefaultSliderCaptchaResourceManager();
StandardSliderCaptchaTemplate sliderCaptchaTemplate = new StandardSliderCaptchaTemplate(sliderCaptchaResourceManager, true);
StandardSliderCaptchaGenerator sliderCaptchaGenerator = new StandardSliderCaptchaGenerator(sliderCaptchaResourceManager, true);
// 生成滑块图片
SliderCaptchaInfo slideImageInfo = sliderCaptchaTemplate.getSlideImageInfo(GenerateParam.builder()
SliderCaptchaInfo slideImageInfo = sliderCaptchaGenerator.generateSlideImageInfo(GenerateParam.builder()
.sliderFormatName("webp")
.backgroundFormatName("webp")
// 是否添加混淆滑块
@@ -124,7 +124,7 @@ SliderCaptchaInfo slideImageInfo = sliderCaptchaTemplate.getSlideImageInfo(Gener
```java
//为方便快速上手 系统本身自带了一张图片和两套滑块模板,如果不想用系统自带的可以不让它加载系统自带的
// 第二个构造参数设置为false时将不加载默认的图片和模板
SliderCaptchaTemplate sliderCaptchaTemplate = new DefaultSliderCaptchaTemplate(sliderCaptchaResourceManager, false);
SliderCaptchaGenerator sliderCaptchaTemplate = new StandardSliderCaptchaGenerator(sliderCaptchaResourceManager, false);
```
### 自定义 `SliderCaptchaValidator` 校验器
@@ -143,7 +143,7 @@ SliderCaptchaInfo slideImageInfo = sliderCaptchaTemplate.getSlideImageInfo(Gener
```java
// 实现了 ResourceProvider 后
SliderCaptchaResourceManager sliderCaptchaResourceManager = new DefaultSliderCaptchaResourceManager();
StandardSliderCaptchaTemplate sliderCaptchaTemplate = new StandardSliderCaptchaTemplate(sliderCaptchaResourceManager, true);
StandardSliderCaptchaGenerator sliderCaptchaGenerator = new StandardSliderCaptchaGenerator(sliderCaptchaResourceManager, true);
// 注册
sliderCaptchaResourceManager.registerResourceProvider(new CustomResourceProvider());
```
@@ -157,9 +157,9 @@ public static void main(String[] args) throws InterruptedException {
// 参数三: 出错后 等待xx时间再进行生成
// 参数四: 检查时间间隔
SliderCaptchaResourceManager sliderCaptchaResourceManager = new DefaultSliderCaptchaResourceManager();
DefaultSliderCaptchaTemplate sliderCaptchaTemplate = new CacheSliderCaptchaTemplate(new StandardSliderCaptchaTemplate(sliderCaptchaResourceManager, true), 10, 1000, 100);
SliderCaptchaGenerator sliderCaptchaGenerator = new CacheSliderCaptchaGenerator(new StandardSliderCaptchaGenerator(sliderCaptchaResourceManager, true), 10, 1000, 100);
// 生成滑块图片
SliderCaptchaInfo slideImageInfo = sliderCaptchaTemplate.getSlideImageInfo();
SliderCaptchaInfo slideImageInfo = sliderCaptchaGenerator.generateSlideImageInfo();
// 获取背景图片的base64
String backgroundImage = slideImageInfo.getBackgroundImage();
// 获取滑块图片
@@ -1,4 +1,4 @@
package cloud.tianai.captcha.template.slider.exception;
package cloud.tianai.captcha.template.slider.common.exception;
public class SliderCaptchaException extends RuntimeException{
public SliderCaptchaException() {
@@ -1,4 +1,4 @@
package cloud.tianai.captcha.template.slider.util;
package cloud.tianai.captcha.template.slider.common.util;
import lombok.SneakyThrows;
@@ -14,7 +14,7 @@
* limitations under the License.
*/
package cloud.tianai.captcha.template.slider.util;
package cloud.tianai.captcha.template.slider.common.util;
import java.util.*;
@@ -1,4 +1,4 @@
package cloud.tianai.captcha.template.slider.util;
package cloud.tianai.captcha.template.slider.common.util;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicInteger;
@@ -14,7 +14,7 @@
* limitations under the License.
*/
package cloud.tianai.captcha.template.slider.util;
package cloud.tianai.captcha.template.slider.common.util;
import java.lang.reflect.Array;
import java.util.Arrays;
@@ -1,6 +1,9 @@
package cloud.tianai.captcha.template.slider.generator;
import cloud.tianai.captcha.template.slider.generator.common.model.dto.GenerateParam;
import cloud.tianai.captcha.template.slider.generator.common.model.dto.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.resource.SliderCaptchaResourceManager;
import cloud.tianai.captcha.template.slider.validator.SliderCaptchaValidator;
/**
* @Author: 天爱有情
@@ -14,25 +17,25 @@ public interface SliderCaptchaGenerator {
*
* @return SliderCaptchaInfo
*/
SliderCaptchaInfo getSlideImageInfo();
SliderCaptchaInfo generateSlideImageInfo();
/**
* 获取滑块验证码
* 生成滑块验证码
*
* @param targetFormatName jpeg或者webp格式
* @param matrixFormatName png或者webp格式
* @return SliderCaptchaInfo
*/
SliderCaptchaInfo getSlideImageInfo(String targetFormatName, String matrixFormatName);
SliderCaptchaInfo generateSlideImageInfo(String targetFormatName, String matrixFormatName);
/**
* 获取滑块验证码
* 生成滑块验证码
*
* @param param 生成参数
* @return SliderCaptchaInfo
*/
SliderCaptchaInfo getSlideImageInfo(GenerateParam param);
SliderCaptchaInfo generateSlideImageInfo(GenerateParam param);
/**
* 百分比对比
@@ -40,7 +43,11 @@ public interface SliderCaptchaGenerator {
* @param newPercentage 用户百分比
* @param oriPercentage 原百分比
* @return true 成功 false 失败
* <p>
* 废除 建议使用
* @see SliderCaptchaValidator 进行校验
*/
@Deprecated
boolean percentageContrast(Float newPercentage, Float oriPercentage);
/**
@@ -1,4 +1,4 @@
package cloud.tianai.captcha.template.slider.generator;
package cloud.tianai.captcha.template.slider.generator.common.constant;
/**
* @Author: 天爱有情
@@ -1,4 +1,4 @@
package cloud.tianai.captcha.template.slider.generator;
package cloud.tianai.captcha.template.slider.generator.common.model.dto;
import lombok.AllArgsConstructor;
import lombok.Builder;
@@ -1,4 +1,4 @@
package cloud.tianai.captcha.template.slider.generator;
package cloud.tianai.captcha.template.slider.generator.common.model.dto;
import lombok.AllArgsConstructor;
import lombok.Data;
@@ -1,9 +1,9 @@
package cloud.tianai.captcha.template.slider.generator.impl;
import cloud.tianai.captcha.template.slider.generator.GenerateParam;
import cloud.tianai.captcha.template.slider.generator.common.model.dto.GenerateParam;
import cloud.tianai.captcha.template.slider.generator.SliderCaptchaGenerator;
import cloud.tianai.captcha.template.slider.generator.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.util.NamedThreadFactory;
import cloud.tianai.captcha.template.slider.generator.common.model.dto.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.common.util.NamedThreadFactory;
import cloud.tianai.captcha.template.slider.resource.SliderCaptchaResourceManager;
import lombok.Getter;
import lombok.Setter;
@@ -71,7 +71,7 @@ public class CacheSliderCaptchaGenerator implements SliderCaptchaGenerator {
if (pos.get() >= size) {
return;
}
SliderCaptchaInfo slideImageInfo = target.getSlideImageInfo(generateParam);
SliderCaptchaInfo slideImageInfo = target.generateSlideImageInfo(generateParam);
if (slideImageInfo != null) {
boolean addStatus = queue.offer(slideImageInfo);
if (addStatus) {
@@ -101,17 +101,17 @@ public class CacheSliderCaptchaGenerator implements SliderCaptchaGenerator {
@SneakyThrows
@Override
public SliderCaptchaInfo getSlideImageInfo() {
return getSlideImageInfo(this.requiredGetCaptcha);
public SliderCaptchaInfo generateSlideImageInfo() {
return generateSlideImageInfo(this.requiredGetCaptcha);
}
@SneakyThrows
public SliderCaptchaInfo getSlideImageInfo(boolean requiredGetCaptcha) {
public SliderCaptchaInfo generateSlideImageInfo(boolean requiredGetCaptcha) {
SliderCaptchaInfo poll = queue.poll();
if (poll == null && requiredGetCaptcha) {
log.warn("滑块验证码缓存不足, genParam:{}", generateParam);
// 如果池内没数据, 则直接生成
return target.getSlideImageInfo(generateParam);
return target.generateSlideImageInfo(generateParam);
}
// 减1
pos.decrementAndGet();
@@ -119,13 +119,13 @@ public class CacheSliderCaptchaGenerator implements SliderCaptchaGenerator {
}
@Override
public SliderCaptchaInfo getSlideImageInfo(String targetFormatName, String matrixFormatName) {
return target.getSlideImageInfo(targetFormatName, matrixFormatName);
public SliderCaptchaInfo generateSlideImageInfo(String targetFormatName, String matrixFormatName) {
return target.generateSlideImageInfo(targetFormatName, matrixFormatName);
}
@Override
public SliderCaptchaInfo getSlideImageInfo(GenerateParam param) {
return target.getSlideImageInfo(param);
public SliderCaptchaInfo generateSlideImageInfo(GenerateParam param) {
return target.generateSlideImageInfo(param);
}
@Override
@@ -1,11 +1,11 @@
package cloud.tianai.captcha.template.slider.generator.impl;
import cloud.tianai.captcha.template.slider.generator.GenerateParam;
import cloud.tianai.captcha.template.slider.generator.SliderCaptchaConstant;
import cloud.tianai.captcha.template.slider.generator.common.model.dto.GenerateParam;
import cloud.tianai.captcha.template.slider.generator.common.constant.SliderCaptchaConstant;
import cloud.tianai.captcha.template.slider.generator.SliderCaptchaGenerator;
import cloud.tianai.captcha.template.slider.generator.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.resource.provider.ClassPathResourceProvider;
import cloud.tianai.captcha.template.slider.resource.Resource;
import cloud.tianai.captcha.template.slider.generator.common.model.dto.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.resource.impl.provider.ClassPathResourceProvider;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import cloud.tianai.captcha.template.slider.resource.ResourceStore;
import cloud.tianai.captcha.template.slider.resource.SliderCaptchaResourceManager;
import lombok.Getter;
@@ -21,7 +21,7 @@ import java.io.InputStream;
import java.util.*;
import java.util.concurrent.ThreadLocalRandom;
import static cloud.tianai.captcha.template.slider.util.CaptchaImageUtils.*;
import static cloud.tianai.captcha.template.slider.common.util.CaptchaImageUtils.*;
/**
* @Author: 天爱有情
@@ -68,14 +68,14 @@ public class StandardSliderCaptchaGenerator implements SliderCaptchaGenerator {
}
@Override
public SliderCaptchaInfo getSlideImageInfo() {
return getSlideImageInfo(defaultBgImageType, defaultSliderImageType);
public SliderCaptchaInfo generateSlideImageInfo() {
return generateSlideImageInfo(defaultBgImageType, defaultSliderImageType);
}
@SneakyThrows
@Override
public SliderCaptchaInfo getSlideImageInfo(String backgroundFormatName, String sliderFormatName) {
return getSlideImageInfo(GenerateParam.builder()
public SliderCaptchaInfo generateSlideImageInfo(String backgroundFormatName, String sliderFormatName) {
return generateSlideImageInfo(GenerateParam.builder()
.backgroundFormatName(backgroundFormatName)
.sliderFormatName(sliderFormatName)
.obfuscate(false)
@@ -84,7 +84,7 @@ public class StandardSliderCaptchaGenerator implements SliderCaptchaGenerator {
@SneakyThrows
@Override
public SliderCaptchaInfo getSlideImageInfo(GenerateParam param) {
public SliderCaptchaInfo generateSlideImageInfo(GenerateParam param) {
Boolean obfuscate = param.getObfuscate();
Map<String, Resource> templateImages = sliderCaptchaResourceManager.randomGetTemplate();
if (templateImages == null || templateImages.isEmpty()) {
@@ -174,7 +174,6 @@ public class StandardSliderCaptchaGenerator implements SliderCaptchaGenerator {
* @param bufferedImage 图片
* @param formatType 格式化类型
* @return String
* @throws IOException
*/
public String transform(BufferedImage bufferedImage, String formatType) throws IOException {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
@@ -1,7 +1,7 @@
package cloud.tianai.captcha.template.slider.resource.provider;
package cloud.tianai.captcha.template.slider.resource;
import cloud.tianai.captcha.template.slider.resource.ResourceProvider;
import cloud.tianai.captcha.template.slider.resource.Resource;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import java.io.InputStream;
@@ -1,5 +1,7 @@
package cloud.tianai.captcha.template.slider.resource;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import java.io.InputStream;
/**
@@ -1,5 +1,7 @@
package cloud.tianai.captcha.template.slider.resource;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import java.util.List;
import java.util.Map;
@@ -1,5 +1,7 @@
package cloud.tianai.captcha.template.slider.resource;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
@@ -1,4 +1,4 @@
package cloud.tianai.captcha.template.slider.resource;
package cloud.tianai.captcha.template.slider.resource.common.model.dto;
import cloud.tianai.captcha.template.slider.resource.ResourceProvider;
import lombok.AllArgsConstructor;
@@ -1,4 +1,7 @@
package cloud.tianai.captcha.template.slider.resource;
package cloud.tianai.captcha.template.slider.resource.impl;
import cloud.tianai.captcha.template.slider.resource.ResourceStore;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import java.util.ArrayList;
import java.util.Collections;
@@ -1,8 +1,12 @@
package cloud.tianai.captcha.template.slider.resource;
package cloud.tianai.captcha.template.slider.resource.impl;
import cloud.tianai.captcha.template.slider.resource.provider.ClassPathResourceProvider;
import cloud.tianai.captcha.template.slider.resource.provider.FileResourceProvider;
import cloud.tianai.captcha.template.slider.resource.provider.URLResourceProvider;
import cloud.tianai.captcha.template.slider.resource.ResourceProvider;
import cloud.tianai.captcha.template.slider.resource.ResourceStore;
import cloud.tianai.captcha.template.slider.resource.SliderCaptchaResourceManager;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import cloud.tianai.captcha.template.slider.resource.impl.provider.ClassPathResourceProvider;
import cloud.tianai.captcha.template.slider.resource.impl.provider.FileResourceProvider;
import cloud.tianai.captcha.template.slider.resource.impl.provider.URLResourceProvider;
import java.io.InputStream;
import java.util.ArrayList;
@@ -1,6 +1,7 @@
package cloud.tianai.captcha.template.slider.resource.provider;
package cloud.tianai.captcha.template.slider.resource.impl.provider;
import cloud.tianai.captcha.template.slider.resource.Resource;
import cloud.tianai.captcha.template.slider.resource.AbstractResourceProvider;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import java.io.InputStream;
@@ -1,6 +1,7 @@
package cloud.tianai.captcha.template.slider.resource.provider;
package cloud.tianai.captcha.template.slider.resource.impl.provider;
import cloud.tianai.captcha.template.slider.resource.Resource;
import cloud.tianai.captcha.template.slider.resource.AbstractResourceProvider;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import lombok.SneakyThrows;
import java.io.FileInputStream;
@@ -1,6 +1,7 @@
package cloud.tianai.captcha.template.slider.resource.provider;
package cloud.tianai.captcha.template.slider.resource.impl.provider;
import cloud.tianai.captcha.template.slider.resource.Resource;
import cloud.tianai.captcha.template.slider.resource.AbstractResourceProvider;
import cloud.tianai.captcha.template.slider.resource.common.model.dto.Resource;
import lombok.SneakyThrows;
import java.io.InputStream;
@@ -1,6 +1,7 @@
package cloud.tianai.captcha.template.slider.validator;
import cloud.tianai.captcha.template.slider.generator.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.generator.common.model.dto.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.validator.common.model.dto.SliderCaptchaTrack;
import java.util.Map;
@@ -1,7 +1,5 @@
package cloud.tianai.captcha.template.slider.validator;
package cloud.tianai.captcha.template.slider.validator.common.model.dto;
import cloud.tianai.captcha.template.slider.util.CollectionUtils;
import cloud.tianai.captcha.template.slider.util.ObjectUtils;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@@ -1,7 +1,8 @@
package cloud.tianai.captcha.template.slider.validator;
package cloud.tianai.captcha.template.slider.validator.impl;
import cloud.tianai.captcha.template.slider.util.CollectionUtils;
import cloud.tianai.captcha.template.slider.util.ObjectUtils;
import cloud.tianai.captcha.template.slider.common.util.CollectionUtils;
import cloud.tianai.captcha.template.slider.common.util.ObjectUtils;
import cloud.tianai.captcha.template.slider.validator.common.model.dto.SliderCaptchaTrack;
import java.util.List;
import java.util.Map;
@@ -1,7 +1,9 @@
package cloud.tianai.captcha.template.slider.validator;
package cloud.tianai.captcha.template.slider.validator.impl;
import cloud.tianai.captcha.template.slider.generator.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.util.CollectionUtils;
import cloud.tianai.captcha.template.slider.generator.common.model.dto.SliderCaptchaInfo;
import cloud.tianai.captcha.template.slider.common.util.CollectionUtils;
import cloud.tianai.captcha.template.slider.validator.SliderCaptchaValidator;
import cloud.tianai.captcha.template.slider.validator.common.model.dto.SliderCaptchaTrack;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;