SpringBoot三分钟实现Kaptcha图形验证码

淡淡的烟草味﹌ 2023-07-09 16:22 1阅读 0赞

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw_size_16_color_FFFFFF_t_70][]

## Kaptcha介绍 ##

介绍摘自：[https://www.jianshu.com/p/a3525990cd82][https_www.jianshu.com_p_a3525990cd82]

Kaptcha 是一个可高度配置的实用验证码生成工具，可自由配置的选项如：

*  验证码的字体
 *  验证码字体的大小
 *  验证码字体的字体颜色
 *  验证码内容的范围(数字，字母，中文汉字！)
 *  验证码图片的大小，边框，边框粗细，边框颜色
 *  验证码的干扰线
 *  验证码的样式(鱼眼样式、3D、普通模糊、...)

### Kaptcha 详细配置表 ###

<table> 
 <thead> 
  <tr> 
   <th>Constant</th> 
   <th>描述</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>kaptcha.border</td> 
   <td>图片边框，合法值：yes , no</td> 
   <td>yes</td> 
  </tr> 
  <tr> 
   <td>kaptcha.border.color</td> 
   <td>边框颜色，合法值： r,g,b (and optional alpha) 或者 white,black,blue.</td> 
   <td>black</td> 
  </tr> 
  <tr> 
   <td>kaptcha.image.width</td> 
   <td>图片宽</td> 
   <td>200</td> 
  </tr> 
  <tr> 
   <td>kaptcha.image.height</td> 
   <td>图片高</td> 
   <td>50</td> 
  </tr> 
  <tr> 
   <td>kaptcha.producer.impl</td> 
   <td>图片实现类</td> 
   <td>com.google.code.kaptcha.impl.DefaultKaptcha</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.impl</td> 
   <td>文本实现类</td> 
   <td>com.google.code.kaptcha.text.impl.DefaultTextCreator</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.char.string</td> 
   <td>文本集合，验证码值从此集合中获取</td> 
   <td>abcde2345678gfynmnpwx</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.char.length</td> 
   <td>验证码长度</td> 
   <td>5</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.font.names</td> 
   <td>字体</td> 
   <td>Arial, Courier</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.font.size</td> 
   <td>字体大小</td> 
   <td>40px.</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.font.color</td> 
   <td>字体颜色，合法值： r,g,b 或者 white,black,blue.</td> 
   <td>black</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.char.space</td> 
   <td>文字间隔</td> 
   <td>2</td> 
  </tr> 
  <tr> 
   <td>kaptcha.noise.impl</td> 
   <td>干扰实现类</td> 
   <td>com.google.code.kaptcha.impl.DefaultNoise</td> 
  </tr> 
  <tr> 
   <td>kaptcha.noise.color</td> 
   <td>干扰 颜色，合法值： r,g,b 或者 white,black,blue.</td> 
   <td>black</td> 
  </tr> 
  <tr> 
   <td>kaptcha.obscurificator.impl</td> 
   <td>图片样式：&lt;br /&gt;水纹 com.google.code.kaptcha.impl.WaterRipple &lt;br /&gt; 鱼眼 com.google.code.kaptcha.impl.FishEyeGimpy &lt;br /&gt; 阴影 com.google.code.kaptcha.impl.ShadowGimpy</td> 
   <td>com.google.code.kaptcha.impl.WaterRipple</td> 
  </tr> 
  <tr> 
   <td>kaptcha.background.impl</td> 
   <td>背景实现类</td> 
   <td>com.google.code.kaptcha.impl.DefaultBackground</td> 
  </tr> 
  <tr> 
   <td>kaptcha.background.clear.from</td> 
   <td>背景颜色渐变，开始颜色</td> 
   <td>light grey</td> 
  </tr> 
  <tr> 
   <td>kaptcha.background.clear.to</td> 
   <td>背景颜色渐变， 结束颜色</td> 
   <td>white</td> 
  </tr> 
  <tr> 
   <td>kaptcha.word.impl</td> 
   <td>文字渲染器</td> 
   <td>com.google.code.kaptcha.text.impl.DefaultWordRenderer</td> 
  </tr> 
  <tr> 
   <td>kaptcha.session.key</td> 
   <td>session key</td> 
   <td>KAPTCHA_SESSION_KEY</td> 
  </tr> 
  <tr> 
   <td>kaptcha.session.date</td> 
   <td>session date</td> 
   <td>KAPTCHA_SESSION_DATE</td> 
  </tr> 
 </tbody> 
</table>

**纯默认效果图**

![20200229134556413.png][]

**自定义配置效果图**

![20200229135133984.png][]

## Coding ##

**pom.xml**

<dependency>
        <groupId>com.github.penggle</groupId>
        <artifactId>kaptcha</artifactId>
        <version>2.3.2</version>
    </dependency>

**KaptchaConfig****-纯默认**

**KaptchaConfig****-自定义配置**

package com.saltedfish.www;
    
    import com.google.code.kaptcha.impl.DefaultKaptcha;
    import com.google.code.kaptcha.util.Config;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    import java.util.Properties;
    
    @Configuration
    public class KaptchaConfig {
    
        @Bean
        public DefaultKaptcha getDefaultKaptcha() {
            DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
            Properties properties = new Properties();
            properties.setProperty("kaptcha.image.width", "150");
            properties.setProperty("kaptcha.textproducer.char.length", "4");
            properties.setProperty("kaptcha.textproducer.font.color", "red");
            properties.setProperty("kaptcha.textproducer.char.space", "3");
            defaultKaptcha.setConfig(new Config(properties));
            return defaultKaptcha;
        }
    
    }

**Controller**

@Autowired
    private DefaultKaptcha defaultKaptcha;
    
    private static final String SESSION_KEY = "KAPTCHA_SESSION_KEY";
    
    @GetMapping("captcha")
    public void captcha(HttpServletRequest request, HttpServletResponse response) throws IOException {
        byte[] captchaChallengeAsJpeg = null;
        ByteArrayOutputStream jpegOutputStream = new ByteArrayOutputStream();
        try {
            String captcha = defaultKaptcha.createText();
            request.getSession().setAttribute(SESSION_KEY, captcha);
            BufferedImage challenge = defaultKaptcha.createImage(captcha);
            ImageIO.write(challenge, "jpg", jpegOutputStream);
        } catch (IllegalArgumentException e) {
            response.sendError(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
    
        captchaChallengeAsJpeg = jpegOutputStream.toByteArray();
        response.setHeader("Cache-Control", "no-store");
        response.setHeader("Pragma", "no-cache");
        response.setDateHeader("Expires", 0);
        response.setContentType("image/jpeg");
        ServletOutputStream outputStream = response.getOutputStream();
        outputStream.write(captchaChallengeAsJpeg);
        outputStream.flush();
        outputStream.close();
    }

**html**

对你有帮助的话，右上角给个赞呗~

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200305114938848.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw==,size_16,color_FFFFFF,t_70
[https_www.jianshu.com_p_a3525990cd82]: https://www.jianshu.com/p/a3525990cd82
[20200229134556413.png]: https://img-blog.csdnimg.cn/20200229134556413.png
[20200229135133984.png]: https://img-blog.csdnimg.cn/20200229135133984.png