《SpringBoot2.0 实战》系列-集成kaptcha实现验证码的生成校验

最新推荐文章于 2023-11-18 12:52:46 发布

葫芦胡

最新推荐文章于 2023-11-18 12:52:46 发布

阅读量852

点赞数 1

分类专栏： springboot2.0实战文章标签： kaptcha 图形验证码 springboot2.0实战

本文链接：https://blog.csdn.net/HXNLYW/article/details/100013220

版权

springboot2.0实战专栏收录该内容

24 篇文章 3 订阅

订阅专栏

简介

kaptcha-spring-boot-starter 基于 springBoot 和 Google Kaptcha 验证码组件，支持jdk1.7+,kaptcha-spring-boot-starter可以很方便的集成验证码到你的系统中。

快速开始

增加相关依赖包

<!--kaptcha 图形验证码-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>kaptcha-spring-boot-starter</artifactId>
    <version>1.1.0</version>
</dependency>

配置

# kaptcha 图形验证码
kaptcha:
  height: 50
  width: 200
  content:
    length: 4
    source: abcdefghjklmnopqrstuvwxyz23456789
    space: 2
  font:
    color: black
    name: Arial
    size: 40
  background-color:
    from: lightGray
    to: white
  border:
    enabled: true
    color: black
    thickness: 1

统一异常捕获

/**
 * 统一异常处理器
 * @author gourd
 */
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
	

	/**
	 * 处理验证码校验异常
	 * @param kaptchaException
	 * @return
	 */
	@ExceptionHandler(value = KaptchaException.class)
	public BaseResponse kaptchaExceptionHandler(KaptchaException kaptchaException) {
		if (kaptchaException instanceof KaptchaIncorrectException) {
			return BaseResponse.failure("验证码不正确");
		} else if (kaptchaException instanceof KaptchaNotFoundException) {
			return BaseResponse.failure("验证码未找到");
		} else if (kaptchaException instanceof KaptchaTimeoutException) {
			return BaseResponse.failure("验证码过期");
		} else {
			return BaseResponse.failure("验证码渲染失败");
		}

	}

}

controller调用

/**
 * 图形验证码控制器
 * @author gourd
 */
@RestController
@RequestMapping("/kaptcha")
@Api(tags = "kaptcha", description = "kaptcha操作" )
public class KaptchaController {

  @Autowired
  private Kaptcha kaptcha;

  @GetMapping("/render")
  @ApiOperation(value = "生成验证码")
  public BaseResponse render() {
    kaptcha.render();
    return BaseResponse.ok("生成验证码成功");
  }

  @PostMapping("/valid")
  @ApiOperation(value = "校验验证码")
  public BaseResponse validDefaultTime(@RequestParam String code) {
    //默认过期时间900秒
    boolean validate = kaptcha.validate(code);
    if(!validate){
      BaseResponse.failure("验证码校验失败");
    }
    return BaseResponse.ok("验证码校验成功");
  }

  @PostMapping("/validTime")
  @ApiOperation(value = "校验验证码")
  public BaseResponse validWithTime(@RequestParam String code,@RequestParam Long times) {
    boolean validate =kaptcha.validate(code, times);
    if(!validate){
      BaseResponse.failure("验证码校验失败");
    }
    return BaseResponse.ok("验证码校验成功");
  }

}

h5页面

<!DOCTYPE html>
<html xmlns:layout="http://www.w3.org/1999/xhtml" layout:decorator="layout">
<head lang="en">
    <meta charset="UTF-8"></meta>
    <title>验证码</title>
    <script src="http://apps.bdimg.com/libs/jquery/2.1.4/jquery.min.js"></script>
</head>
<body>
<div>
    <!-- 后面添加参数起到清除缓存作用 -->
    <img alt="验证码" onclick="this.src='/hu/kaptcha/render?d='+new Date()*1"  src="/hu/kaptcha/render"/>
</div>
<form id="form">
    <input type="text" name="code" />
    <input value="提交" type="button" onclick="validate()"/>
</form>
</body>
<script>
    // 匿名函数的写法
    var validate = function(){
        $.ajax({
            //几个参数需要注意一下
            type: "POST",//方法类型
            dataType: "json",//预期服务器返回的数据类型
            url: "/hu/kaptcha/valid" ,//url
            data: $('#form').serialize(),
            success: function (result) {
                alert(result.msg);
            },
            error : function() {
                alert("异常！");
            }
        });
    }

</script>
</html>

测试效果

附配置信息表

Constant	描述	默认值
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
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	背景颜色渐变，开始颜色	lightGray
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