Fetch the repository succeeded.
<!-- maven导入 -->
<dependency>
<groupId>cloud.tianai.captcha</groupId>
<artifactId>tianai-captcha-springboot-starter</artifactId>
<version>1.3.2</version>
</dependency>
package cloud.tianai.captcha.readme;
import cloud.tianai.captcha.spring.annotation.Captcha;
import cloud.tianai.captcha.spring.request.CaptchaRequest;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import java.util.Map;
@RestController
public class Test {
// 只需要在需要验证的controller层加入 @Captcha 注解,
// 并且接受的参数指定成CaptchaRequest即可自动进行校验
// 自己真实的参数可以写到 CaptchaRequest对象的泛型中
// 如果校验失败,会抛出CaptchaValidException异常
// 对校验失败的处理,可以使用sping的全局异常拦截CaptchaValidException异常进行处理
@Captcha("SLIDER")
@PostMapping("/login")
public String login(@RequestBody CaptchaRequest<Map> request) {
// 进入这个方法就说明已经校验成功了
return "success";
}
}
package cloud.tianai.captcha.readme;
import cloud.tianai.captcha.common.constant.CaptchaTypeConstant;
import cloud.tianai.captcha.spring.application.CaptchaImageType;
import cloud.tianai.captcha.spring.application.ImageCaptchaApplication;
import cloud.tianai.captcha.spring.vo.CaptchaResponse;
import cloud.tianai.captcha.spring.vo.ImageCaptchaVO;
import cloud.tianai.captcha.validator.common.model.dto.ImageCaptchaTrack;
import org.springframework.beans.factory.annotation.Autowired;
public class Test2 {
@Autowired
private ImageCaptchaApplication application;
public void test() {
// 生成滑块验证码 该方法会通过request获取浏览器内核是否是谷歌内核,如果是则返回webp类型的图片 否则返回jpeg+png类型的图片
// 也可以手动指定返回哪种类型的 只需要在request中提供 key为captcha-type的参数(可以放到参数中或者header中) , 值为 webp、jpeg-png
// 来通过参数选择返回哪种类型的图片
CaptchaResponse<ImageCaptchaVO> res1 = application.generateCaptcha(CaptchaTypeConstant.SLIDER);
// 也可以用编码判断返回哪种类型的图片, 返回的图片,
// 返回 底图是jpeg,滑块部分是png类型的图片
res1 = application.generateCaptcha(CaptchaImageType.JPEG_PNG);
// *** 注意,要生成webp类型的图片时需要手动将webp的扩展导入到系统中 ,参考: https://bitbucket.org/luciad/webp-imageio
// res1 = application.generateCaptcha(CaptchaTypeConstant.SLIDER, CaptchaImageType.WEBP);
// 其它扩展方法可以自己在源码中查看,都有详细注释
// 匹配验证码是否正确
// 该参数包含了滑动轨迹滑动时间等数据,用于校验滑块验证码。 由前端传入
ImageCaptchaTrack sliderCaptchaTrack = new ImageCaptchaTrack();
boolean match = application.matching(res1.getId(), sliderCaptchaTrack);
}
}
# 滑块验证码配置, 详细请看 cloud.tianai.captcha.autoconfiguration.ImageCaptchaProperties 类
captcha:
# 如果项目中使用到了redis,滑块验证码会自动把验证码数据存到redis中, 这里配置redis的key的前缀,默认是captcha:slider
prefix: captcha
# 验证码过期时间,默认是2分钟,单位毫秒, 可以根据自身业务进行调整
expire:
# 默认缓存时间 2分钟
default: 10000
# 针对 点选验证码 过期时间设置为 2分钟, 因为点选验证码验证比较慢,把过期时间调整大一些
WORD_IMAGE_CLICK: 20000
# 使用加载系统自带的资源, 默认是true
init-default-resource: false
cache:
# 缓存控制, 默认为false不开启
enabled: true
# 验证码会提前缓存一些生成好的验证数据, 默认是20
cacheSize: 20
# 缓存拉取失败后等待时间 默认是 5秒钟
wait-time: 5000
# 缓存检查间隔 默认是2秒钟
period: 2000
secondary:
# 二次验证, 默认false 不开启
enabled: false
# 二次验证过期时间, 默认 2分钟
expire: 120000
# 二次验证缓存key前缀,默认是 captcha:secondary
keyPrefix: "captcha:secondary"
依赖于 tianai-captcha 的高扩展性, 可以自定义 如下实现 然后直接注入到spring中即可替换默认实现,实现自定义扩展
ImageCaptchaGenerator
) -- 主要负责生成滑块验证码所需的图片ImageCaptchaValidator
) -- 主要负责校验用户滑动的行为轨迹是否合规ImageCaptchaResourceManager
) -- 主要负责读取验证码背景图片和模板图片等ResourceStore
) -- 负责存储背景图和模板图ResourceProvider
) -- 负责将资源存储器中对应的资源转换为文件流ImageCaptchaApplication
) ,上面一些接口的组合和增强,比如负责把验证的数据存到缓存中,用户一般直接使用这个接口方便的生成滑块图片和校验数据SpringMultiImageCaptchaGenerator
基于Spring的多验证码生成器
MultiImageCaptchaGenerator
进行扩展ImageCaptchaGeneratorProvider
然后注入到spring中实现自定义验证码扩展,也可以通过该方法替换掉默认的实现SecondaryVerificationApplication
二次验证扩展
ImageCaptchaApplication
进行扩展 实现了二次验证功能,captcha.secondary.endbled=true
进行手动开启package cloud.tianai.captcha.readme;
import cloud.tianai.captcha.spring.application.ImageCaptchaApplication;
import cloud.tianai.captcha.spring.plugins.secondary.SecondaryVerificationApplication;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
public class Test3 {
@Autowired
private ImageCaptchaApplication sca;
@GetMapping("/check2")
@ResponseBody
public boolean check2Captcha(@RequestParam("id") String id) {
// 如果开启了二次验证
if (sca instanceof SecondaryVerificationApplication) {
return ((SecondaryVerificationApplication) sca).secondaryVerification(id);
}
return false;
}
}
Sign in to post a comment
Activity
Community
Health
Trend
Influence
:Code submit frequency
:React/respond to issue & PR etc.
:Well-balanced team members and collaboration
:Recent popularity of project
:Star counts, download counts etc.
Repository Comments ( 15 )