Kaptcha 是 Google 的⼀个⾼度可配置的实⽤验证码⽣成⼯具,我们选择的是⼀个适配SpringBoot的 开源项⽬
生成的验证码效果如下:
原理
验证码可以客户端生成,也可以服务器生成. 对于普通的字符验证码, 后端通常分两部分:
⼀:⽣成验证码内容, 根据验证码内容和⼲扰项等, ⽣成图⽚, 返回给客户端
二:把验证码内容存储起来, 校验时取出来进⾏对⽐.
kaptcha插件选择把验证码的内容存储在 Session 里.
流程
一.引入依赖
在 pom.xml 文件中引入下面的依赖
<dependency>
<groupId>com.oopsguy.kaptcha</groupId>
<artifactId>kaptcha-spring-boot-starter</artifactId>
<version>1.0.0-beta-2</version>
</dependency>
二.生成验证码
这里介绍一个简单的方式快速生成验证码
通过配置文件,配置验证码⽣成器,代码如下:
kaptcha:
items:
# home captcha
home:
path: /home/captcha
session:
key: HOME_KAPTCHA_SESSION_KEY
date: HOME_KAPTCHA_SESSION_DATE
# admin captcha
admin:
path: /admin/captcha
session:
key: ADMIN_KAPTCHA_SESSION_KEY
date: ADMIN_KAPTCHA_SESSION_DATE
在上述代码中,home 表示验证码生成器的名称,path 表示验证码生成器的访问路径,session 表示验证码生成器存储到 Session 中的内容,key 表示验证码的内容,date 表示验证码的创建时间,在对验证码进行校验的时候会用到
配置后,可以直接访问 http://XXXX:port/home/captcha 即可⽣成验证码
Kaptcha详细配置
我们对于生成的验证码可能有特殊的要求,这里整理了关于验证码生成器的一些配置,需要设置的可以添加到配置文件中
三.判断验证码是否正确
用户输入验证码以后,我们要检查用户输入的验证码是否正确,代码如下:
public class EnrollService {
//在 session 中校验码内容对应的 key 值
private final String TRUE_CHECK_CODE="CHECK_KAPTCHA_SESSION_KEY";
//在 session 中校验码创建时间对应的 key 值
private final String CREATE_TIME_CHECK="CHECK_KAPTCHA_SESSION_DATE";
//校验码的有效时间 2 分钟
private final long CHECK_CODE_TIME=2*60*1000;
/**
* 检查用户输入的校验码是否正确
* */
public boolean inspectCheckCodeService(String checkCode, HttpSession session){
if(!StringUtils.hasLength(checkCode)){
return false;
}
//Kaptcha 插件会将校验码的内容和创建的时间放到 Session 中
//获取正确的校验码内容
String tCheckCode=(String) session.getAttribute(TRUE_CHECK_CODE);
//获取校验码的创建时间
Date timeCheckCode=(Date) session.getAttribute(CREATE_TIME_CHECK);
if(checkCode.equals(tCheckCode)){
//用户输入的校验码正确
if(timeCheckCode==null||System.currentTimeMillis()-timeCheckCode.getTime()<CHECK_CODE_TIME){
return true;
}
return false;
}
//前端传来的校验码错误
return false;
}
}