kaptcha验证码+redis缓存

目录

🧂1.导入kaptcha依赖

🌭2.添加配置类

🥓3.添加controller测试接收

🍿4.添加redis依赖 

🥞5.配置redis

🧈6.引入工具类 

🫓7.拼接key 

🌮8.将验证码加入到reidis缓存中

---

1.导入kaptcha依赖

注意版本号

            <!--验证码生成工具-->
            <dependency>
                <groupId>com.github.penggle</groupId>
                <artifactId>kaptcha</artifactId>
                <version>2.3.2</version>
            </dependency>

2.添加配置类

标识为配置类，注意@Configuration

/**
 * 验证码
 */
@Configuration
public class CaptchaConfig {

    @Bean
    @Qualifier("captchaProducer")//避免重名，使用别名
    public DefaultKaptcha defaultKaptcha() {

        DefaultKaptcha kaptcha = new DefaultKaptcha();
        Properties properties = new Properties();
        //默认是否有边框
        properties.setProperty(Constants.KAPTCHA_BORDER, "yes");
        //验证码边框颜色
        properties.setProperty(Constants.KAPTCHA_BORDER_COLOR, "220,220,220");
        //验证码文本字符颜色
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_FONT_COLOR, "38,29,12");
        //验证码图片宽度
		properties.setProperty(Constants.KAPTCHA_IMAGE_WIDTH, "147");
		//验证码图片高度
		properties.setProperty(Constants.KAPTCHA_IMAGE_HEIGHT, "34");
		//验证码文本字符大小
		properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_FONT_SIZE, "25");
		//KAPTCHA_SESSION_KEY
		properties.setProperty(Constants.KAPTCHA_SESSION_KEY, "code");
        //验证码个数
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_CHAR_LENGTH, "4");
        //验证码文本样式
		properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_FONT_NAMES, "Courier");
        //字体间隔
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_CHAR_SPACE, "8");
        //干扰线颜色
		properties.setProperty(Constants.KAPTCHA_NOISE_COLOR, "white");
        //干扰实现类
        properties.setProperty(Constants.KAPTCHA_NOISE_IMPL, "com.google.code.kaptcha.impl.NoNoise");
        //图片样式：鱼眼-FishEyeGimpy，水纹-WaterRipple，阴影-ShadowGimpy
        properties.setProperty(Constants.KAPTCHA_OBSCURIFICATOR_IMPL, "com.google.code.kaptcha.impl.FishEyeGimpy");
        //文字来源
        properties.setProperty(Constants.KAPTCHA_TEXTPRODUCER_CHAR_STRING, "0123456789");
        Config config = new Config(properties);
        kaptcha.setConfig(config);
        return kaptcha;
    }
}

3.添加controller测试接收

• 引入producer在生成图片之后，使用流输出，注意流的关闭~
• Kaptcha自带了 Producer 类调用其 createText（) 和 createImage (arg)即可生成图片存放到 BufferedImage 中。 

@Api(tags = "通知模块")
@RestController
@RequestMapping("/api/user/v1")
@Slf4j
public class NotifyController {


    @Autowired
    private Producer captchaProducer;

    @ApiOperation("获取图形验证码")
    @GetMapping("/captcha")
    public void getCaptcha(HttpServletRequest request, HttpServletResponse response) {
        String captcha = captchaProducer.createText();
        log.info("图形验证码:{}", captcha);

        BufferedImage bufferedImage = captchaProducer.createImage(captcha);
        ServletOutputStream outputStream = null;
        try {
            outputStream=response.getOutputStream();
            ImageIO.write(bufferedImage,"jpg",outputStream);
            outputStream.flush();
            outputStream.close();
        } catch (IOException e) {
            log.error("获取图形验证码异常！！！");
        }
    }
}

4.添加redis依赖 

        <!--redis-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

5.配置redis

注意：安全起见，redis一定要配置密码

spring:
    redis:
      host: 192.168.20.130
      port: 6379

6.引入工具类 

引入自己的工具类，为拼接key准备，获取ip地址、以及MD5加密

/**
 * 工具类
 */
public class CommonUtil {

    /**
     * 获取ip
     *
     * @param request
     * @return
     */
    public static String getIpAddr(HttpServletRequest request) {
        String ipAddress = null;
        try {
            ipAddress = request.getHeader("x-forwarded-for");
            if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("Proxy-Client-IP");
            }
            if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("WL-Proxy-Client-IP");
            }
            if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getRemoteAddr();
                if (ipAddress.equals("127.0.0.1")) {
                    // 根据网卡取本机配置的IP
                    InetAddress inet = null;
                    try {
                        inet = InetAddress.getLocalHost();
                    } catch (UnknownHostException e) {
                        e.printStackTrace();
                    }
                    ipAddress = inet.getHostAddress();
                }
            }
            // 对于通过多个代理的情况，第一个IP为客户端真实IP,多个IP按照','分割
            if (ipAddress != null && ipAddress.length() > 15) {
                // "***.***.***.***".length()
                // = 15
                if (ipAddress.indexOf(",") > 0) {
                    ipAddress = ipAddress.substring(0, ipAddress.indexOf(","));
                }
            }
        } catch (Exception e) {
            ipAddress = "";
        }
        return ipAddress;
    }


    /**
     * MD5加密
     *
     * @param data
     * @return
     */
    public static String MD5(String data) {
        try {
            java.security.MessageDigest md = MessageDigest.getInstance("MD5");
            byte[] array = md.digest(data.getBytes("UTF-8"));
            StringBuilder sb = new StringBuilder();
            for (byte item : array) {
                sb.append(Integer.toHexString((item & 0xFF) | 0x100).substring(1, 3));
            }

            return sb.toString().toUpperCase();
        } catch (Exception exception) {
        }
        return null;
    }
}

7.拼接key 

为储存方便，拼接上自己的key，是浏览器唯一识别

    /**
     * 获取缓存的key
     *
     * @param request
     * @return
     */
    private String getCaptchaKey(HttpServletRequest request) {
        //获取ip
        String ip = CommonUtil.getIpAddr(request);
        //浏览器识别
        String userAgent = request.getHeader("User-Agent");
        String key = "user-service:captcha:" + CommonUtil.MD5(ip + userAgent);
        log.info("key:{},ip:{},userAgent:{}", key, ip, userAgent);
        return key;
    }

8.将验证码加入到reidis缓存中

在加入的同时，设置上过期时间

    @Autowired
    private Producer captchaProducer;

    /**
     * redis
     */
    @Autowired
    private StringRedisTemplate redisTemplate;

    /**
     * 图形验证码有效期10分钟
     */
    private static final long CAPTCHA_CODE_EXPIRED=60*1000*10;
    @ApiOperation("获取图形验证码")
    @GetMapping("/captcha")
    public void getCaptcha(HttpServletRequest request, HttpServletResponse response) {
        String captcha = captchaProducer.createText();
        log.info("图形验证码:{}", captcha);
        //redis存储
        redisTemplate.opsForValue().set(getCaptchaKey(request), captcha,CAPTCHA_CODE_EXPIRED,TimeUnit.MILLISECONDS);
        BufferedImage bufferedImage = captchaProducer.createImage(captcha);
        ServletOutputStream outputStream = null;
        try {
            outputStream = response.getOutputStream();
            ImageIO.write(bufferedImage, "jpg", outputStream);
            outputStream.flush();
            outputStream.close();
        } catch (IOException e) {
            log.error("获取图形验证码异常！！！");
        }
    }

当统一浏览器获取验证码时，缓存中只存在一个key~