SpringBoot如何集成Kaptcha验证码
作者:爱JAVA的少年闰土
本文介绍了如何在Java开发中使用Kaptcha生成验证码的功能,包括在pom.xml中配置依赖、在系统公共配置类中添加配置、在控制器中添加生成验证码的方法,以及前端页面如何引用,同时,还补充了Kaptcha的更多配置属性及其默认值
SpringBoot集成Kaptcha验证码
简介
在开发中,验证码功能是一个常见且重要的功能,Kaptcha 是大名鼎鼎的谷歌公司提供的一款用于生成验证码的插件,支持高度可配置;
本章将通过一个简单的示例展示如何实现验证码功能
实现步骤
1. 在 pom.xml 配置文件中
添加如下配置:
由于国内限制了谷歌网络的访问,推荐使用下面的依赖下载
<dependency> <groupId>com.github.penggle</groupId> <artifactId>kaptcha</artifactId> <version>2.3.2</version> </dependency>
2. 在系统公共配置类中添加如下代码
当然关于 Kaptcha 的配置也可以添加到 application.properties 配置文件中
@Configuration public class AppConfigure implements WebMvcConfigurer { /** * 验证码配置 */ @Bean public DefaultKaptcha kaptcha() { DefaultKaptcha kaptcha = new DefaultKaptcha(); Properties properties = new Properties(); properties.put("kaptcha.border", "yes"); properties.put("kaptcha.image.width", "100"); properties.put("kaptcha.image.height", "33"); properties.put("kaptcha.session.key", "code"); properties.put("kaptcha.border.color", "105,179,90"); properties.put("kaptcha.textproducer.font.size", "30"); properties.put("kaptcha.textproducer.char.length", "4"); properties.put("kaptcha.textproducer.font.color", "blue"); properties.put("kaptcha.textproducer.font.names", "宋体,楷体,微软雅黑"); kaptcha.setConfig(new Config(properties)); return kaptcha; } }
3. 在 KaptchController.class 中添加提供验证码生成的方法
@Controller @RequestMapping("/kaptcha") @Slf4j public class KaptchaController { @Resource private DefaultKaptcha kaptcha; /** * 申请验证码 */ @GetMapping("/kaptcha") public void getKaptcha(HttpServletRequest request, HttpServletResponse response) { response.setDateHeader("Expires", 0); response.setHeader("Cache-Control", "no-store, no-cache, must-revalidate"); response.addHeader("Cache-Control", "post-check=0, pre-check=0"); response.setHeader("Pragma", "no-cache"); response.setContentType("image/jpeg"); HttpSession session = request.getSession(); ServletOutputStream outputStream = null; try { //生成验证码 String kaptchaText = kaptcha.createText(); // 将验证码保存 5 分钟 CommonUtils.setSession(session, Properties.KAPTCHA.desc(), kaptchaText, Properties.EXPIRETIME_KAPTCHA.value()); log.info("captcha code: " + kaptchaText); //向客户端输出 BufferedImage bufferedImage = kaptcha.createImage(kaptchaText); outputStream = response.getOutputStream(); ImageIO.write(bufferedImage, "jpg", outputStream); outputStream.flush(); } catch (IOException e) { throw new BusinessException(ErrorCode.CLOSE_IO_EXCEPTION); } finally { CommonUtils.closeio(outputStream); } } ...... }
4. 前端页面直接使用 img 标签引用即可
<img src="/kaptcha/kaptcha" id="kaptcha-img" title="点击刷新">
补充:Kaptcha 更多配置
属性(常量) | 描述 | 默认值 |
---|---|---|
kaptcha.border | 图片边框,合法值:yes , no | yes |
kaptcha.border.color | 边框颜色,合法值: r,g,b (and optional alpha) 或者 white,black,blue. | black |
kaptcha.border.thickness | 边框厚度,合法值:>0 | 1 |
kaptcha.image.width | 图片宽 | 200 |
kaptcha.image.height | 图片高 | 50 |
kaptcha.producer.impl | 图片实现类 | com.google.code.kaptcha.impl.DefaultKaptcha |
kaptcha.textproducer.impl | 文本实现类 | com.google.code.kaptcha.text.impl.DefaultTextCreator |
kaptcha.textproducer.char.string | 文本集合,验证码值从此集合中获取 | abcde2345678gfynmnpwx |
kaptcha.textproducer.char.length | 验证码长度 | 5 |
kaptcha.textproducer.font.names | 字体 | Arial, Courier |
kaptcha.textproducer.font.size | 字体大小 | 40px |
kaptcha.textproducer.font.color | 字体颜色,合法值: r,g,b 或者 white,black,blue. | black |
kaptcha.textproducer.char.space | 文字间隔 | 2 |
kaptcha.noise.impl | 干扰实现类 | com.google.code.kaptcha.impl.DefaultNoise |
kaptcha.noise.color | 干扰颜色,合法值: r,g,b 或者 white,black,blue. | black |
kaptcha.obscurificator.impl | 图片样式: 水纹com.google.code.kaptcha.impl.WaterRipple 鱼眼com.google.code.kaptcha.impl.FishEyeGimpy 阴影com.google.code.kaptcha.impl.ShadowGimpy | com.google.code.kaptcha.impl.WaterRipple |
kaptcha.background.impl | 背景实现类 | com.google.code.kaptcha.impl.DefaultBackground |
kaptcha.background.clear.from | 背景颜色渐变,开始颜色 | light grey |
kaptcha.background.clear.to | 背景颜色渐变,结束颜色 | white |
kaptcha.word.impl | 文字渲染器 | com.google.code.kaptcha.text.impl.DefaultWordRenderer |
kaptcha.session.key | session key | KAPTCHA_SESSION_KEY |
kaptcha.session.date | session date | KAPTCHA_SESSION_DATE |
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。