spring boot集成kaptcha实现验证码功能

1、kaptcha简介

kaptcha 是一个非常实用的验证码生成工具。有了它，你可以生成各种样式的验证码，因为它是可配置的。kaptcha工作的原理是调用 com.google.code.kaptcha.servlet.KaptchaServlet，生成一个图片。同时将生成的验证码字符串放到 HttpSession中。

使用kaptcha可以方便的配置：

验证码的字体
验证码字体的大小
验证码字体的字体颜色
验证码内容的范围(数字，字母，中文汉字！)
验证码图片的大小，边框，边框粗细，边框颜色
验证码的干扰线(可以自己继承com.google.code.kaptcha.NoiseProducer写一个自定义的干扰线)
验证码的样式(鱼眼样式、3D、普通模糊……当然也可以继承com.google.code.kaptcha.GimpyEngine自定义样式)

2、kaptcha配置详解

#  kaptcha.border  是否有边框  默认为true  我们可以自己设置yes，no
#  kaptcha.border.color   边框颜色   默认为Color.BLACK
#  kaptcha.border.thickness  边框粗细度  默认为1
#  kaptcha.producer.impl   验证码生成器  默认为DefaultKaptcha
#  kaptcha.textproducer.impl   验证码文本生成器  默认为DefaultTextCreator
#  kaptcha.textproducer.char.string   验证码文本字符内容范围  默认为abcde2345678gfynmnpwx
#  kaptcha.textproducer.char.length   验证码文本字符长度  默认为5
#  kaptcha.textproducer.font.names    验证码文本字体样式  默认为new Font("Arial", 1, fontSize), new Font("Courier", 1, fontSize)
#  kaptcha.textproducer.font.size   验证码文本字符大小  默认为40
#  kaptcha.textproducer.font.color  验证码文本字符颜色  默认为Color.BLACK
#  kaptcha.textproducer.char.space  验证码文本字符间距  默认为2
#  kaptcha.noise.impl    验证码噪点生成对象  默认为DefaultNoise
#  kaptcha.noise.color   验证码噪点颜色   默认为Color.BLACK
#  kaptcha.obscurificator.impl   验证码样式引擎  默认为WaterRipple
#  kaptcha.word.impl   验证码文本字符渲染   默认为DefaultWordRenderer
#  kaptcha.background.impl   验证码背景生成器   默认为DefaultBackground
#  kaptcha.background.clear.from   验证码背景颜色渐进   默认为Color.LIGHT_GRAY
#  kaptcha.background.clear.to   验证码背景颜色渐进   默认为Color.WHITE
#  kaptcha.image.width   验证码图片宽度  默认为200
#  kaptcha.image.height  验证码图片高度  默认为50

3、spring boot集成kaptcha案例

新建spring boot maven工程
引入依赖的Jar包

<!-- 验证码 -->
<dependency>
     <groupId>com.github.axet</groupId>
     <artifactId>kaptcha</artifactId>
     <version>0.0.9</version>
</dependency>

在spring boot启动类添加如下生成验证码配置

    @Bean
    public DefaultKaptcha captchaProducer() {
        DefaultKaptcha captchaProducer = new DefaultKaptcha();
        Properties properties = new Properties();
        properties.setProperty(Constants.KAPTCHA_BORDER, "yes");
        properties.setProperty(Constants.KAPTCHA_BORDER_COLOR, "red");
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_FONT_COLOR, "blue");
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_FONT_SIZE, "50");
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_FONT_NAMES, "宋体,楷体,微软雅黑");
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_CHAR_LENGTH, "4");
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_CHAR_STRING, "0123456789");
        properties.setProperty(Constants.KAPTCHA_IMAGE_WIDTH, "200");
        properties.setProperty(Constants.KAPTCHA_IMAGE_HEIGHT, "50");
        properties.setProperty(Constants.KAPTCHA_SESSION_CONFIG_KEY, "code");
        Config config = new Config(properties);
        captchaProducer.setConfig(config);
        return captchaProducer;
    }

生成验证码的控制类代码如下：

package com.xieke.test.springbootkaptchademo;
  
import java.awt.image.BufferedImage;  
  
import javax.imageio.ImageIO;  
import javax.servlet.ServletOutputStream;  
import javax.servlet.http.HttpServletRequest;  
import javax.servlet.http.HttpServletResponse;  
import javax.servlet.http.HttpSession;  
  
import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.stereotype.Controller;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.servlet.ModelAndView;  
  
import com.google.code.kaptcha.Constants;  
import com.google.code.kaptcha.Producer;  
 
@Controller  
@RequestMapping("/kaptcha/*")  
public class CaptchaController {  
 
    @Autowired
    private Producer captchaProducer;
 
    @RequestMapping  
    public ModelAndView getKaptchaImage(HttpServletRequest request, HttpServletResponse response) throws Exception {  
        HttpSession session = request.getSession();  
        String code = (String)session.getAttribute(Constants.KAPTCHA_SESSION_KEY);  
        System.out.println("******************验证码是: " + code + "******************");  
          
        response.setDateHeader("Expires", 0);  
          
        // Set standard HTTP/1.1 no-cache headers.  
        response.setHeader("Cache-Control", "no-store, no-cache, must-revalidate");  
          
        // Set IE extended HTTP/1.1 no-cache headers (use addHeader).  
        response.addHeader("Cache-Control", "post-check=0, pre-check=0");  
          
        // Set standard HTTP/1.0 no-cache header.  
        response.setHeader("Pragma", "no-cache");  
          
        // return a jpeg  
        response.setContentType("image/jpeg");  
          
        // create the text for the image  
        String capText = captchaProducer.createText();  
          
        // store the text in the session  
        session.setAttribute(Constants.KAPTCHA_SESSION_KEY, capText);  
          
        // create the image with the text  
        BufferedImage bi = captchaProducer.createImage(capText);  
        ServletOutputStream out = response.getOutputStream();  
          
        // write the data out  
        ImageIO.write(bi, "jpg", out);  
        try {  
            out.flush();  
        } finally {  
            out.close();  
        }  
        return null;  
    }  
  
}

启动spring boot程序，自行测试，参考代码已上传至码云：https://gitee.com/xieke90/spring_boot_demo

扫描二维码关注公众号，回复： 1616131 查看本文章

spring boot集成kaptcha实现验证码功能

spring boot集成kaptcha实现验证码功能

转载请注明出处: http://xieke90.iteye.com/blog/2425071

猜你喜欢