一、介绍
验证码功能位于 cn.hutool.captcha 包中,核心接口为 ICaptcha,此接口定义了以下方法:
createCode: 创建验证码,实现类需同时生成随机验证码字符串和验证码图片
getCode: 获取验证码的文字内容
verify: 验证验证码是否正确,建议忽略大小写
write: 将验证码写出到目标流中
其中write方法只有一个OutputStream,ICaptcha实现类可以根据这个方法封装写出到文件等方法。
AbstractCaptcha 为一个ICaptcha抽象实现类,此类实现了验证码文本生成、非大小写敏感的验证、写出到流和文件等方法,通过继承此抽象类只需实现 createImage 方法定义图形生成规则即可。
二、示例
1、LineCaptcha 线段干扰的验证码
// 定义图形验证码的长和宽
LineCaptcha lineCaptcha = CaptchaUtil.createLineCaptcha(200, 100);
// 图形验证码写出,可以写出到文件,也可以写出到流
lineCaptcha.write("D:/line.png");
// 输出code
System.out.println(lineCaptcha.getCode());
// 验证图形验证码的有效性,返回boolean值
lineCaptcha.verify("12345");
// 重新生成验证码
lineCaptcha.createCode();
效果如下:
2、CircleCaptcha 圆圈干扰验证码
// 定义图形验证码的长、宽、验证码字符数、干扰元素个数
CircleCaptcha captcha = CaptchaUtil.createCircleCaptcha(200, 100);
// 图形验证码写出,可以写出到文件,也可以写出到流
captcha.write("D:/circle.png");
// 验证图形验证码的有效性,返回boolean值
captcha.verify("12345");
效果如下:
3、ShearCaptcha 扭曲干扰验证码
ShearCaptcha captcha = CaptchaUtil.createShearCaptcha(200, 100);
// 图形验证码写出,可以写出到文件,也可以写出到流
captcha.write("D:/shear.png");
// 验证图形验证码的有效性,返回boolean值
captcha.verify("12345");
效果如下:
4、GifCaptcha 验证码
GifCaptcha gifCaptcha = CaptchaUtil.createGifCaptcha(200, 100);
gifCaptcha.write("D:/gif.gif");
1
2
效果如下:
5、写出到浏览器(Servlet输出)
ICaptcha captcha = ...;
captcha.write(response.getOutputStream());
//Servlet的OutputStream记得自行关闭哦!
6、自定义验证码
有时候标准的验证码不满足要求,比如我们希望使用纯字母的验证码、纯数字的验证码、加减乘除的验证码,此时我们就要自定义CodeGenerator。
// 自定义纯数字的验证码(随机5位数字,可重复)
RandomGenerator randomGenerator = new RandomGenerator("0123456789", 5);
LineCaptcha lineCaptcha = CaptchaUtil.createLineCaptcha(200, 100);
lineCaptcha.setGenerator(randomGenerator);
// 自定义验证码内容为四则运算方式
ShearCaptcha shearCaptcha = CaptchaUtil.createShearCaptcha(200, 45);
shearCaptcha.setGenerator(new MathGenerator());