Spring Boot 配置Kaptcha（谷歌验证码工具）（生成验证码、验证验证码）

喜欢ヅ旅行 2022-09-12 06:51 445阅读 0赞

# 1 Kaptcha #

## 1.1 Kaptcha简介 ##

Kaptcha 是一个扩展自simplecaptcha的验证码库，默认情况下，Kaptcha非常易于设置和使用，并且默认输出会产生一个很难验证的验证码。默认情况下，它生成的验证码看起来与上面的非常相似。如果您想更改输出的外观，则有几个配置选项，并且该框架是模块化的，因此您可以编写自己的变形代码。

## 1.2 Kaptcha详细配置表 ##

<table style="width:700px;"> 
 <thead> 
  <tr> 
   <th colspan="4">Kaptcha常用属性</th> 
  </tr> 
  <tr> 
   <th style="width:76px;">序号</th> 
   <th style="width:182px;">属性名</th> 
   <th style="width:250px;">描述</th> 
   <th style="width:245px;">示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="width:76px;">1</td> 
   <td style="width:182px;">kaptcha.width</td> 
   <td style="width:250px;">验证码宽度</td> 
   <td style="width:245px;">200</td> 
  </tr> 
  <tr> 
   <td style="width:76px;">2</td> 
   <td style="width:182px;">kaptcha.height</td> 
   <td style="width:250px;">验证码高度</td> 
   <td style="width:245px;">50</td> 
  </tr> 
  <tr> 
   <th colspan="4">Kaptcha border（边框）属性</th> 
  </tr> 
  <tr> 
   <th style="width:76px;">序号</th> 
   <th style="width:182px;">属性名</th> 
   <th style="width:250px;">描述</th> 
   <th style="width:245px;">示例</th> 
  </tr> 
  <tr> 
   <td style="width:76px;">1</td> 
   <td style="width:182px;">kaptcha.border.enabled</td> 
   <td style="width:250px;">是否显示边框</td> 
   <td style="width:245px;">true</td> 
  </tr> 
  <tr> 
   <td style="width:76px;">2</td> 
   <td style="width:182px;">kaptcha.border.color</td> 
   <td style="width:250px;">边框颜色</td> 
   <td style="width:245px;">black</td> 
  </tr> 
  <tr> 
   <td style="width:76px;">3</td> 
   <td style="width:182px;">kaptcha.border.thickness</td> 
   <td style="width:250px;">边框厚度</td> 
   <td style="width:245px;">2</td> 
  </tr> 
  <tr> 
   <th colspan="4">Kaptcha content（文本）属性</th> 
  </tr> 
  <tr> 
   <th style="width:76px;">序号</th> 
   <th style="width:182px;">属性名</th> 
   <th style="width:250px;">描述</th> 
   <th style="width:245px;">示例</th> 
  </tr> 
  <tr> 
   <td style="width:76px;">1</td> 
   <td style="width:182px;">kaptcha.content.length</td> 
   <td style="width:250px;">验证码文本长度</td> 
   <td style="width:245px;">5</td> 
  </tr> 
  <tr> 
   <td style="width:76px;">2</td> 
   <td style="width:182px;">kaptcha.content.source</td> 
   <td style="width:250px;">文本源</td> 
   <td style="width:245px;">abcde2345678gfynmnpwx</td> 
  </tr> 
  <tr> 
   <td style="width:76px;">3</td> 
   <td style="width:182px;">kaptcha.content.space</td> 
   <td style="width:250px;">文本间隔</td> 
   <td style="width:245px;">2</td> 
  </tr> 
  <tr> 
   <th colspan="4">Kaptcha font（字体）属性</th> 
  </tr> 
  <tr> 
   <th style="width:76px;">序号</th> 
   <th style="width:182px;">属性名</th> 
   <th style="width:250px;">描述</th> 
   <th style="width:245px;">示例</th> 
  </tr> 
  <tr> 
   <td style="width:76px;">1</td> 
   <td style="width:182px;">kaptcha.font.name</td> 
   <td style="width:250px;">字体名称</td> 
   <td style="width:245px;">Arial</td> 
  </tr> 
  <tr> 
   <td style="width:76px;">2</td> 
   <td style="width:182px;">kaptcha.font.size</td> 
   <td style="width:250px;">字体大小</td> 
   <td style="width:245px;">40</td> 
  </tr> 
  <tr> 
   <td style="width:76px;">3</td> 
   <td style="width:182px;">kaptcha.font.color</td> 
   <td style="width:250px;">字体颜色</td> 
   <td style="width:245px;">black</td> 
  </tr> 
  <tr> 
   <th colspan="4">Kaptcha background-color（背景颜色）属性</th> 
  </tr> 
  <tr> 
   <th style="width:76px;">序号</th> 
   <th style="width:182px;">属性名</th> 
   <th style="width:250px;">描述</th> 
   <th style="width:245px;">示例</th> 
  </tr> 
  <tr> 
   <td style="width:76px;">1</td> 
   <td style="width:182px;">kaptcha.background-color.from</td> 
   <td style="width:250px;">背景颜色（开始渐变色）</td> 
   <td style="width:245px;">lightGray</td> 
  </tr> 
  <tr> 
   <td style="width:76px;">2</td> 
   <td style="width:182px;">kaptcha.background-color.to</td> 
   <td style="width:250px;">背景颜色（结束渐变色）</td> 
   <td style="width:245px;">white</td> 
  </tr> 
 </tbody> 
</table>

# 2 Maven依赖 #

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>kaptcha-spring-boot-starter</artifactId>
                <version>1.1.0</version>
            </dependency>

# 3 Spring Boot配置 #

#验证码宽度
    kaptcha.width=200
    #验证码高度
    kaptcha.height=50
    #验证码内容长度
    kaptcha.content.length=4
    #验证码内容源
    kaptcha.content.source=ABCDEFGHIJKLMNOPQRSTUVWXYZ2345678923456789
    #验证码内容间隔
    kaptcha.content.space=2
    #验证码字体名称
    kaptcha.font.name=Arial
    #验证码字体大小
    kaptcha.font.size=40
    #验证码字体颜色
    kaptcha.font.color=black
    #验证码背景颜色（开始颜色）
    kaptcha.background-color.from=lightGray
    #验证码背景颜色（结束颜色）
    kaptcha.background-color.to=white
    #验证码是否显示边框
    kaptcha.border.enabled=true
    #验证码边框颜色
    kaptcha.border.color=black
    #验证码边框厚度
    kaptcha.border.thickness=1

# 4 调试代码 #

package com.controller;
    
    import com.baomidou.kaptcha.Kaptcha;
    import com.baomidou.kaptcha.exception.KaptchaIncorrectException;
    import com.baomidou.kaptcha.exception.KaptchaNotFoundException;
    import com.baomidou.kaptcha.exception.KaptchaTimeoutException;
    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.RestController;
    
    @RestController
    public class KaptchaController {
        @Autowired
        private Kaptcha kaptcha;
    
        /**
         * 获取Kaptcha验证码
         */
        @GetMapping("/getKaptchaImg")
        public void getKaptchaImg() {
            //默认900秒
            kaptcha.render();
        }
    
        /**
         * 验证验证码
         *
         * @param code 验证码
         * @return
         */
        @GetMapping("/validCode")
        public String validCode(@RequestParam String code) {
            try {
                kaptcha.validate(code);
            } catch (Exception e) {
                if (e instanceof KaptchaIncorrectException) {
                    return "验证码不正确";
                } else if (e instanceof KaptchaNotFoundException) {
                    return "验证码未找到";
                } else if (e instanceof KaptchaTimeoutException) {
                    return "验证码过期";
                } else {
                    return "验证码渲染失败";
                }
            }
            return "验证通过";
        }
    }

# 5 调试结果 #

## 5.1 生成验证码  ##

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_13_color_FFFFFF_t_70_g_se_x_16][]

## 5.2 验证验证码 ##

### 5.2.1 验证通过 ###

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_20_color_FFFFFF_t_70_g_se_x_16][]

### 5.2.2 验证码不存在 ###

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_20_color_FFFFFF_t_70_g_se_x_16 1][]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_13_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/1211d7310cde464f8967e6953ef52ed4.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/bd076865e9d14df1adb1ce2ff83e576f.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/704bf3e2944f48f0a58394a73b47569d.png