Springboot+JCaptcha验证码，加入redis session共享 验证可行

基于上一章的优化，在redis存储过程中，无法初始化JCaptcha，经测试以下方法可行：

修改验证码生产方法，不再使用JCaptcha。

生成工具类：VerifyCodeUtils.java

package cn.jeeweb.web.common.controller;

import javax.imageio.ImageIO;
import java.awt.*;
import java.awt.geom.AffineTransform;
import java.awt.image.BufferedImage;
import java.io.*;
import java.util.Arrays;
import java.util.Random;
/**
* @author hys 20210509
*/
public class VerifyCodeUtils{

	//使用到Algerian字体，系统里没有的话需要安装字体，字体只显示大写，去掉了1,0,i,o几个容易混淆的字符
	public static final String VERIFY_CODES = "23456789ABCDEFGHJKLMNPQRSTUVWXYZ";
	public static final String PHONE_VERIFY_CODES = "0123456789";
	private static Random random = new Random();


	/**
	 * 使用系统默认字符源生成验证码
	 * @param verifySize	验证码长度
	 * @return
	 */
	public static String generateVerifyCode(int verifySize){
		return generateVerifyCode(verifySize, VERIFY_CODES);
	}
	/**
	 * 使用指定源生成验证码
	 * @param verifySize	验证码长度
	 * @param sources	验证码字符源
	 * @return
	 */
	public static String generateVerifyCode(int verifySize, String sources){
		if(sources == null || sources.length() == 0){
			sources = VERIFY_CODES;
		}
		int codesLen = sources.length();
		Random rand = new Random(System.currentTimeMillis());
		StringBuilder verifyCode = new StringBuilder(verifySize);
		for(int i = 0; i < verifySize; i++){
			verifyCode.append(sources.charAt(rand.nextInt(codesLen-1)));
		}
		return verifyCode.toString();
	}


	/**
	 * 使用数字生成验证码
	 * @param verifySize	验证码长度
	 * @return
	 */
	public static String generateNumVerifyCode(int verifySize){
		return generateVerifyCode(verifySize,PHONE_VERIFY_CODES);
	}
	
	/**
	 * 生成随机验证码文件,并返回验证码值
	 * @param w
	 * @param h
	 * @param outputFile
	 * @param verifySize
	 * @return
	 * @throws IOException
	 */
	public static String outputVerifyImage(int w, int h, File outputFile, int verifySize) throws IOException{
		String verifyCode = generateVerifyCode(verifySize);
		outputImage(w, h, outputFile, verifyCode);
		return verifyCode;
	}
	
	/**
	 * 输出随机验证码图片流,并返回验证码值
	 * @param w
	 * @param h
	 * @param os
	 * @param verifySize
	 * @return
	 * @throws IOException
	 */
	public static String outputVerifyImage(int w, int h, OutputStream os, int verifySize) throws IOException{
		String verifyCode = generateVerifyCode(verifySize);
		outputImage(w, h, os, verifyCode);
		return verifyCode;
	}
	
	/**
	 * 生成指定验证码图像文件
	 * @param w
	 * @param h
	 * @param outputFile
	 * @param code
	 * @throws IOException
	 */
	public static void outputImage(int w, int h, File outputFile, String code) throws IOException{
		if(outputFile == null){
			return;
		}
		File dir = outputFile.getParentFile();
		if(!dir.exists()){
			dir.mkdirs();
		}
		try{
			outputFile.createNewFile();
			FileOutputStream fos = new FileOutputStream(outputFile);
			outputImage(w, h, fos, code);
			fos.close();
		} catch(IOException e){
			throw e;
		}
	}
	
	/**
	 * 输出指定验证码图片流
	 * @param w
	 * @param h
	 * @param os
	 * @param code
	 * @throws IOException
	 */
	public static void outputImage(int w, int h, OutputStream os, String code) throws IOException{
		BufferedImage image = getOutputImage(w,h,code);
		ImageIO.write(image, "jpg", os);
	}

	/**
	 * 获取图片流
	 * @param w
	 * @param h
	 * @param code
	 * @return
	 * @throws IOException
	 */
	public static BufferedImage getOutputImage(int w, int h, String code) throws IOException{
		int verifySize = code.length();
		BufferedImage image = new BufferedImage(w, h, BufferedImage.TYPE_INT_RGB);
		Random rand = new Random();
		Graphics2D g2 = image.createGraphics();
		g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,RenderingHints.VALUE_ANTIALIAS_ON);
		Color[] colors = new Color[5];
		Color[] colorSpaces = new Color[] { Color.WHITE, Color.CYAN,
			Color.GRAY, Color.LIGHT_GRAY, Color.MAGENTA, Color.ORANGE,
			Color.PINK, Color.YELLOW };
		float[] fractions = new float[colors.length];
		for(int i = 0; i < colors.length; i++){
			colors[i] = colorSpaces[rand.nextInt(colorSpaces.length)];
			fractions[i] = rand.nextFloat();
		}
		Arrays.sort(fractions);

		g2.setColor(Color.GRAY);// 设置边框色
		g2.fillRect(0, 0, w, h);

		Color c = getRandColor(200, 250);
		g2.setColor(c);// 设置背景色
		g2.fillRect(0, 2, w, h-4);

		//绘制干扰线
		Random random = new Random();
		g2.setColor(getRandColor(160, 200));// 设置线条的颜色
		for (int i = 0; i < 20; i++) {
			int x = random.nextInt(w - 1);
			int y = random.nextInt(h - 1);
			int xl = random.nextInt(6) + 1;
			int yl = random.nextInt(12) + 1;
			g2.drawLine(x, y, x + xl + 40, y + yl + 20);
		}

		// 添加噪点
		float yawpRate = 0.05f;// 噪声率
		int area = (int) (yawpRate * w * h);
		for (int i = 0; i < area; i++) {
			int x = random.nextInt(w);
			int y = random.nextInt(h);
			int rgb = getRandomIntColor();
			image.setRGB(x, y, rgb);
		}

		shear(g2, w, h, c);// 使图片扭曲

		g2.setColor(getRandColor(100, 160));
		int fontSize = h-4;
		Font font = new Font("Algerian", Font.ITALIC, fontSize);
		g2.setFont(font);
		char[] chars = code.toCharArray();
		for(int i = 0; i < verifySize; i++){
			AffineTransform affine = new AffineTransform();
			affine.setToRotation(Math.PI / 4 * rand.nextDouble() * (rand.nextBoolean() ? 1 : -1), (w / verifySize) * i + fontSize/2, h/2);
			g2.setTransform(affine);
			g2.drawChars(chars, i, 1, ((w-10) / verifySize) * i + 5, h/2 + fontSize/2 - 10);
		}
		g2.dispose();
		return image;
	}
	private static Color getRandColor(int fc, int bc) {
		if (fc > 255)
			fc = 255;
		if (bc > 255)
			bc = 255;
		int r = fc + random.nextInt(bc - fc);
		int g = fc + random.nextInt(bc - fc);
		int b = fc + random.nextInt(bc - fc);
		return new Color(r, g, b);
	}
	
	private static int getRandomIntColor() {
		int[] rgb = getRandomRgb();
		int color = 0;
		for (int c : rgb) {
			color = color << 8;
			color = color | c;
		}
		return color;
	}
	
	private static int[] getRandomRgb() {
		int[] rgb = new int[3];
		for (int i = 0; i < 3; i++) {
			rgb[i] = random.nextInt(255);
		}
		return rgb;
	}

	private static void shear(Graphics g, int w1, int h1, Color color) {
		shearX(g, w1, h1, color);
		shearY(g, w1, h1, color);
	}
	
	private static void shearX(Graphics g, int w1, int h1, Color color) {

		int period = random.nextInt(2);

		boolean borderGap = true;
		int frames = 1;
		int phase = random.nextInt(2);

		for (int i = 0; i < h1; i++) {
			double d = (double) (period >> 1)
					* Math.sin((double) i / (double) period
							+ (6.2831853071795862D * (double) phase)
							/ (double) frames);
			g.copyArea(0, i, w1, 1, (int) d, 0);
			if (borderGap) {
				g.setColor(color);
				g.drawLine((int) d, i, 0, i);
				g.drawLine((int) d + w1, i, w1, i);
			}
		}

	}

	private static void shearY(Graphics g, int w1, int h1, Color color) {

		int period = random.nextInt(40) + 10; // 50;

		boolean borderGap = true;
		int frames = 20;
		int phase = 7;
		for (int i = 0; i < w1; i++) {
			double d = (double) (period >> 1)
					* Math.sin((double) i / (double) period
							+ (6.2831853071795862D * (double) phase)
							/ (double) frames);
			g.copyArea(i, 0, 1, h1, 0, (int) d);
			if (borderGap) {
				g.setColor(color);
				g.drawLine(i, (int) d, i, 0);
				g.drawLine(i, (int) d + h1, i, h1);
			}

		}

	}
	public static void main(String[] args) throws IOException{
		File dir = new File("F:/verifies");
		int w = 200, h = 80;
		for(int i = 0; i < 50; i++){
			String verifyCode = generateVerifyCode(4);
			File file = new File(dir, verifyCode + ".jpg");
			outputImage(w, h, file, verifyCode);
		}
	}
}

生成后入redis缓存库BaseController.java

package cn.jeeweb.web.common.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import redis.clients.jedis.Jedis;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
/**
* hys 2021-05-09
* 图片验证码生成
* @param codeNum
* @return
*/
@Controller
public class BaseController {

/**
* 创建和保存图片验证码到缓存
*
* @param codeNum
* @return
*/
public String get4SaveImageVerifyCode(int codeNum) {
String verifyCode = VerifyCodeUtils.generateVerifyCode(codeNum).toLowerCase();
String key = getSession().getId();
putApiImageVerifyCode(key, verifyCode);
return verifyCode;
}

/**
* 获取Sessions
*/
protected HttpSession getSession() {
return getRequest().getSession();
}

/**
* 获取Request
*/
protected HttpServletRequest getRequest() {
ServletRequestAttributes attrs = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
return attrs.getRequest();
}

/**
* 保存Api的验证码
*
* @param token
* @param verifyCode
*/
public void putApiImageVerifyCode(String token, String verifyCode) {
String key = RedisContent.API_USER_IMAGE_CODE_KEY + token;
//写入缓存

//    Jedis jedis = null;
//    try {
//        jedis = redisPoolFactory.getResource();
//        jedis.select(2);
//        if (jedis.exists(key)) {
//           jedis.del(key);
//        }
//        long expire = RedisContent.THREE_MINS;
//       // jedis.set(key,verifyCode,"NX","EX",expire);
//        jedis.set(key,verifyCode,"NX","EX",expire);
//
//
//    }catch (Exception e) {
//
//        returnBrokenResource(jedis);
//    }finally {
//        returnResource(jedis);
//    }
    Jedis jedis = new Jedis("127.0.0.1", 6379);
    jedis.set(key, verifyCode);
    //设置key生存时间，当key过期时，它会被自动删除，时间是秒
    jedis.expire(key, 180);
    //用完关闭
    jedis.close();

}

}

此处redis地址一旦使用连接池就无法入库，有空再研究，试验过的大咖欢迎留言评论告知一下。

修改原有验证码生成方法：JCaptchaValidateController.java

package cn.jeeweb.web.common.controller;

import cn.jeeweb.common.http.Response;
import cn.jeeweb.common.utils.MessageUtils;
import cn.jeeweb.common.utils.jcaptcha.GMailEngine;
import cn.jeeweb.common.utils.jcaptcha.JCaptcha;
import cn.jeeweb.common.utils.jcaptcha.RedisCaptchaStore;
import cn.jeeweb.common.utils.jcaptcha.RedisManageableCaptchaService;
import com.octo.captcha.service.multitype.GenericManageableCaptchaService;
import org.mapstruct.Qualifier;
import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import redis.clients.jedis.JedisPool;

import javax.imageio.ImageIO;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.awt.image.BufferedImage;
import java.io.IOException;
import java.io.Serializable;
import java.util.Random;

/**
 * jcaptcha 验证码验证
 *
 * @author hys 
 *
 */
@RestController
public class JCaptchaValidateController extends BaseCtl {


	 
	@GetMapping(value = "/jcaptcha.jpg")
	public void jqueryValidationEngineValidate(HttpServletRequest request,
											   HttpServletResponse response)
			throws ServletException, IOException {
		response.setContentType("image/jpeg");
		//禁止图像缓存
		response.setHeader("Pragma", "no-cache");
		response.setHeader("Cache-Control", "no-cache");
		response.setDateHeader("Expires", 0);
		String verifyCode = get4SaveImageVerifyCode(4);
		VerifyCodeUtils.outputImage(120, 40, response.getOutputStream(), verifyCode);

	}


}

RedisContent.java redis相关配置参数，key生成规则及过期时间等。

package cn.jeeweb.web.common.controller;

/**
 * redis锁对应的key
 * @author 郝友帅 2021-05-09 
 */
public class RedisContent {

public static final String API_USER_IMAGE_CODE_KEY = "HYJK:RENDA:CODE:IMAGE_";//图片验证码
/**
* Redis的失效时间
*/
public static final int ONE_MINS=60;
public static final int THREE_MINS=180;
public static final int FIVE_MINS=300;
public static final int TEN_MINS=600;
public static final int HALF_HOUR=1800;
public static final int MINS_5=60*5;
public static final int MINS_55=60*55;
public static final int ONE_HOUR=3600;
public static final int TWO_HOUR=7200;
public static final int HALF_DAY=3600*12;
public static final int ONE_DAY=3600*24;
public static final int SEVEN_DAY=3600*24*7;
public static final int DAY_365=3600*24*365;
public static final int DAY_30=3600*24*30;
public static final int DAY_90=3600*24*90;
public static final int TEN_YEAR=3600*24*365*10;

}

登录时候验证时候，回调方法JCaptchaValidateFilter.java的isAccessAllowed方法。

JCaptcha.validateResponse(httpServletRequest, httpServletRequest.getParameter(jcaptchaParam).toLowerCase());

JCaptcha.java

package cn.jeeweb.common.utils.jcaptcha;

import cn.jeeweb.web.common.controller.BaseCtl;
import cn.jeeweb.web.common.controller.RedisContent;
import com.octo.captcha.service.CaptchaServiceException;
import com.octo.captcha.service.captchastore.FastHashMapCaptchaStore;
import org.springframework.beans.factory.annotation.Autowired;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;

import javax.servlet.http.HttpServletRequest;

import redis.clients.jedis.JedisPoolConfig;

import java.util.Locale;

public class JCaptcha {
    
    public static EsManageableImageCaptchaService captchaService
            = new EsManageableImageCaptchaService(new FastHashMapCaptchaStore(), new GMailEngine(), 180, 100000, 75000);


    public static boolean validateResponse(HttpServletRequest request, String userCaptchaResponse) {
        if (request.getSession(false) == null) return false;

        boolean validated = true;
        try {
            String id = request.getSession().getId();
//            validated = captchaService.validateResponseForID(id, userCaptchaResponse.toUpperCase()).booleanValue();
            validated = getVerifyCode(id, userCaptchaResponse.toLowerCase(Locale.ROOT));
        } catch (CaptchaServiceException e) {
            e.printStackTrace();
        }
        return validated;
    }
    public static boolean getVerifyCode(String token, String verifyCode) {
        String key = RedisContent.API_USER_IMAGE_CODE_KEY + token;
//写入缓存

//        String sessionCode="";
//        Jedis jedis = null;
//        try {
//            jedis = redisPoolFactory.getResource();
//            jedis.select(2);
//            if (jedis.exists(key)) {
//                sessionCode=jedis.get(key).toLowerCase();
//            }
//
//
//
//        }catch (Exception e) {
//
//            returnBrokenResource(jedis);
//
//        }finally {
//            returnResource(jedis);
//        }

        JedisPoolConfig config = new JedisPoolConfig();
        config.setMaxTotal(30);
        //2.获取连接池对象
        JedisPool pool = new JedisPool(config,"127.0.0.1",6379);
        //3.获取连接对象
        Jedis jedis = pool.getResource();
        //4.操作数据库

        String sessionCode = jedis.get(key);
        //释放资源
        jedis.close();
        pool.close();
        if(sessionCode.equals(verifyCode)){
            return true;
        }
        return false;





    }
    @SuppressWarnings("deprecation")
    private static void returnResource(Jedis jedis) {
        if (jedis != null && redisPoolFactory != null) {
            redisPoolFactory.returnResource(jedis);
        }
    }
    @SuppressWarnings("deprecation")
    private static void returnBrokenResource(Jedis jedis) {
        if (jedis != null && redisPoolFactory != null) {
            redisPoolFactory.returnBrokenResource(jedis);
        }
    }
    public static boolean hasCaptcha(HttpServletRequest request, String userCaptchaResponse) {
        if (request.getSession(false) == null) return false;
        boolean validated = false;
        try {
            String id = request.getSession().getId();
            validated = captchaService.hasCapcha(id, userCaptchaResponse.toUpperCase());
        } catch (CaptchaServiceException e) {
            e.printStackTrace();
        }
        return validated;
    }

}

运行，测试，效果完美！！留个记录，欢迎批评指正！！