JAVA中的验证码-SpringBoot 中集成 KaptCha 实现生成验证码和校验验证码

• 今天终于有时间研究一下生成验证码和校验验证码的操作了。
• 以前的时候学习过验证码的生成，但是最近几年没有接触验证码的代码，猛一下感觉很生疏，今天有时间可以搞一下验证码了，尽管做之前很排斥，因为这种问题枯燥无味，但最终也还是逃不过真香定理。
• 话不多说了，上步骤。

第一步 引入依赖

			<dependency>  <!-- 做图片验证码 -->
			<groupId>com.github.penggle</groupId>
			<artifactId>kaptcha</artifactId>
			<version>2.3.2</version>
		    </dependency>

第二步 配置Kaptcha

import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import com.google.code.kaptcha.impl.DefaultKaptcha;
import com.google.code.kaptcha.util.Config;

/*
 * 【Author】 爱吃早餐的程序员
 * 【Time】2020年11月20日 下午4:17:27
 * 【Function】
 */
@Component
public class KaptChaConfig {
	
	 	@Bean
	    public DefaultKaptcha getDefaultKaptcha() {
	        com.google.code.kaptcha.impl.DefaultKaptcha defaultKaptcha = new com.google.code.kaptcha.impl.DefaultKaptcha();
	        Properties properties = new Properties();
	        // 图片边框
	        properties.setProperty("kaptcha.border", "no");
	        // 边框颜色
	        properties.setProperty("kaptcha.border.color", "black");
	        //边框厚度
	        properties.setProperty("kaptcha.border.thickness", "1");
	        // 图片宽
	        properties.setProperty("kaptcha.image.width", "200");
	        // 图片高
	        properties.setProperty("kaptcha.image.height", "50");
	        //图片实现类
	        properties.setProperty("kaptcha.producer.impl", "com.google.code.kaptcha.impl.DefaultKaptcha");
	        //文本实现类
	        properties.setProperty("kaptcha.textproducer.impl", "com.google.code.kaptcha.text.impl.DefaultTextCreator");
	        //文本集合，验证码值从此集合中获取
	        properties.setProperty("kaptcha.textproducer.char.string", "01234567890");
	        //验证码长度
	        properties.setProperty("kaptcha.textproducer.char.length", "4");
	        //字体
	        properties.setProperty("kaptcha.textproducer.font.names", "宋体");
	        //字体颜色
	        properties.setProperty("kaptcha.textproducer.font.color", "black");
	        //文字间隔
	        properties.setProperty("kaptcha.textproducer.char.space", "5");
	        //干扰实现类
	        properties.setProperty("kaptcha.noise.impl", "com.google.code.kaptcha.impl.DefaultNoise");
	        //干扰颜色
	        properties.setProperty("kaptcha.noise.color", "blue");
	        //干扰图片样式
	        properties.setProperty("kaptcha.obscurificator.impl", "com.google.code.kaptcha.impl.WaterRipple");
	        //背景实现类
	        properties.setProperty("kaptcha.background.impl", "com.google.code.kaptcha.impl.DefaultBackground");
	        //背景颜色渐变，结束颜色
	        properties.setProperty("kaptcha.background.clear.to", "white");
	        //文字渲染器
	        properties.setProperty("kaptcha.word.impl", "com.google.code.kaptcha.text.impl.DefaultWordRenderer");
	        Config config = new Config(properties);
	        defaultKaptcha.setConfig(config);
	        return defaultKaptcha;
	    }
} 

第三步 写生成验证码的方法 这一步很重要

import java.awt.image.BufferedImage;
import java.io.File;
import javax.imageio.ImageIO;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.io.FileUtils;
import org.springframework.util.FastByteArrayOutputStream;

import com.google.code.kaptcha.impl.DefaultKaptcha;
/*
 * 【Author】 爱吃早餐的程序员
 * 【Time】2020年11月20日 下午4:15:23
 * 【Function】
 */
public class YanzhengmaUtil {
	
	/**
     * 生成验证码图片
     * @param request 设置session
     * @param response 转成图片
     * @param captchaProducer 生成图片方法类
     * @param validateSessionKey session名称
     * @throws Exception
     */
    public static void validateCode(HttpServletRequest request, HttpServletResponse response, DefaultKaptcha captchaProducer, String validateSessionKey) throws Exception{
     
        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");

        // create the text for the image
        String capText = captchaProducer.createText();

        // store the text in the session
        request.getSession().setAttribute(validateSessionKey, capText);

        // create the image with the text
        BufferedImage bi = captchaProducer.createImage(capText);

       //  OutputStream out = response.getOutputStream();
        FastByteArrayOutputStream os = new FastByteArrayOutputStream();

        // write the data out
        ImageIO.write(bi, "jpg", os);
        
       FileUtils.writeByteArrayToFile(new File("C:\\Users\\Administrator\\Desktop\\1.jpg"), os.toByteArray());
        try {
        	os.flush();
        } finally {
        	os.close();
        }
    }
}

需要注意的是 最后返回文件流的时候，在流的类型选择上 可以任意挑选 这里我选的我熟悉的 FastByteArrayOutputStream ，也可以是 OutputStream 等。 最后生成的图片放在了桌上。

第四步 写个Controller , 执行方法

     @Autowired
	 private DefaultKaptcha captchaProducer;
	
	 public static final String LOGIN_VALIDATE_CODE = "regist_validate_code";
	 	 
	 /**
	  * 注册验证码
	  * @param request
	  * @param response
	  * @throws Exception
	  */
	 @RequestMapping(value = {"/registValidateCode"}  ,method = RequestMethod.POST)
	    public void registValidateCode(HttpServletRequest request, HttpServletResponse response) throws Exception{
		 	YanzhengmaUtil.validateCode(request,response,captchaProducer,LOGIN_VALIDATE_CODE);
	  }
	 
	 @RequestMapping(value = "/checkRegistValidateCode",method = RequestMethod.POST)
	 @ResponseBody
	 public HashMap checkRegistValidateCode(HttpServletRequest request, @RequestParam("validateCode")String validateCode) {
	        String registValidateCode = request.getSession().getAttribute(LOGIN_VALIDATE_CODE).toString();
	       
	        HashMap<String,Object> map = new HashMap<String,Object>();
	        if(registValidateCode == null){
	            map.put("status",null);
	        }else if(registValidateCode.equals(validateCode)){
	            map.put("status",true);
	        }else if(!registValidateCode.equals(validateCode)){
	            map.put("status",false);
	        }
	        map.put("code",200);
	        return map;
	 }

这里执行的逻辑： 先执行 registValidateCode 方法 ，这里实际把生成的验证码字符 保存到了session里，然后 执行registValidateCode 方法去校验之，逻辑相当简单。

第五步 开始校验

执行 registValidateCode 方法 生成了文件

执行registValidateCode 方法

OK ，至此完成了验证码的生成和校验。