springboot结合kaptcha生成图形验证码

springboot结合kaptcha生成图形验证码

最近做了一个验证码需求，验证码由后端返回内容和图片base64，验证需要结合token
这里用到了Kaptcha框架

kaptcha 是一个扩展自 simplecaptcha 的验证码库，默认情况下，Kaptcha非常易于设置和使用，并且默认输出会产生一个很难验证的验证码。默认情况下，它生成的验证码看起来与上面的非常相似。如果您想更改输出的外观，则有几个配置选项，并且该框架是模块化的，因此您可以编写自己的变形代码。

Maven引用

   <!--图形验证码-->
        <dependency>
            <groupId>com.github.penggle</groupId>
            <artifactId>kaptcha</artifactId>
            <version>2.3.3</version>
        </dependency>

自动注入

    @Resource
    private CaptchaHandler captchaHandler;

    @Resource(name = "captchaProducerMath")
    private Producer captchaProducerMath;

配置

CaptchaConfig.java

@Configuration
public class CaptchaConfig {

    @Bean(name = "captchaProducerMath")
    public DefaultKaptcha getKaptchaBeanMath() {
        DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
        Properties properties = new Properties();
        // 是否有边框 默认为true 我们可以自己设置yes，no
        properties.setProperty("kaptcha.border", "yes");
        // 边框颜色 默认为Color.BLACK
        properties.setProperty("kaptcha.border.color", "105,179,90");
        // 验证码文本字符颜色 默认为Color.BLACK
        properties.setProperty("kaptcha.textproducer.font.color", "red");
        // 验证码图片宽度 默认为200
        properties.setProperty("kaptcha.image.width", "160");
        // 验证码图片高度 默认为50
        properties.setProperty("kaptcha.image.height", "60");
        // 验证码文本字符大小 默认为40
        properties.setProperty("kaptcha.textproducer.font.size", "35");
        // KAPTCHA_SESSION_KEY
        properties.setProperty("kaptcha.session.key", "kaptchaCodeMath");
        // 验证码文本生成器
        properties.setProperty("kaptcha.textproducer.impl", "KaptchaTextCreator");
        // 验证码文本字符间距 默认为2
        properties.setProperty("kaptcha.textproducer.char.space", "5");
        // 验证码文本字符长度 默认为5
        properties.setProperty("kaptcha.textproducer.char.length", "4");
        // 验证码文本字体样式 默认为new Font("Arial", 1, fontSize), new Font("Courier", 1,
        // fontSize)
        properties.setProperty("kaptcha.textproducer.font.names", "Arial,Courier");
        // 验证码噪点颜色 默认为Color.BLACK
        properties.setProperty("kaptcha.noise.color", "white");
        // 干扰实现类
        properties.setProperty("kaptcha.noise.impl", "com.google.code.kaptcha.impl.NoNoise");
        // 图片样式 水纹com.google.code.kaptcha.impl.WaterRipple
        // 鱼眼com.google.code.kaptcha.impl.FishEyeGimpy
        // 阴影com.google.code.kaptcha.impl.ShadowGimpy
        properties.setProperty("kaptcha.obscurificator.impl", "com.google.code.kaptcha.impl.WaterRipple");
        Config config = new Config(properties);
        defaultKaptcha.setConfig(config);
        return defaultKaptcha;
    }
}

生成与验证方法

CaptchaHandler.java

@Component
@Slf4j
public class CaptchaHandler {

    private final Producer producer;

    private final MyRedisTemplate myRedisTemplate;

    public CaptchaHandler(Producer producer, MyRedisTemplate myRedisTemplate) {
        this.producer = producer;
        this.myRedisTemplate = myRedisTemplate;
    }

    /**
     * 生成验证码
     *
     * @return
     */
    public CodeVO generate() {
        String capText = producer.createText();

        BufferedImage image = producer.createImage(capText);
        //保存验证码
        String randomStr = UUID.randomUUID().toString().replaceAll("-", "");
        log.info("CaptchaHandler_generate_randomStr:{},code={}", randomStr,  capText);
        //缓存存储
        myRedisTemplate.set(RedisConstants.PARTNER_REGISTER_KEY + randomStr, capText, 60*60*24);

        // 转换流信息写出
        FastByteArrayOutputStream os = new FastByteArrayOutputStream();
        try {
            ImageIO.write(image, "jpg", os);
        } catch (IOException e) {
            log.error("CaptchaHandler_generate_e:{}", e);
            throw new BaseException();
        }

        return CodeVO.builder().code(capText).token(randomStr).img(Base64Utils.encodeToString(os.toByteArray())).build();
    }

    /**
     * 验证验证码
     *
     * @param codeDTO
     * @return
     */
    public Boolean validate(CodeDTO codeDTO) {
        String randomStr = codeDTO.getToken();
        String codeSrt = (String) myRedisTemplate.get(RedisConstants.PARTNER_REGISTER_KEY + randomStr);
        if (StringUtils.isEmpty(codeSrt)) {
            log.error("CaptchaHandler_validate_codeSrt:{} expired", codeSrt);
            throw new BaseException(PreserveErrorType.P100602);
        }
        if (!Objects.equals(codeSrt.toLowerCase(), codeDTO.getCode().toLowerCase())) {
            log.error("CaptchaHandler_validate_codeSrt:{} not match", codeSrt);
            throw new BaseException();
        }
        // 成功 删除缓存中code
        myRedisTemplate.del(RedisConstants.PARTNER_REGISTER_KEY + randomStr);

        return true;
    }
}

验证码文本生成器

KaptchaTextCreator.java

public class KaptchaTextCreator extends DefaultTextCreator {

    private static final String[] CNUMBERS = ("a,b,c,d,e,f,g,h,i,j," +
            "k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,A,B,C,D,E,F,G,H,I,J,K," +
            "L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z").split(",");


    @Override
    public String getText() {
        StringBuilder code = new StringBuilder();
        for (int i = 0; i < 4; i++) {
            Random random = new Random();
            int a = random.nextInt(52);
            code.append(CNUMBERS[a]);
        }
        return code.toString();
    }
}

这里我用的验证方式是随机生成UUID作为token，返回时返回Token、验证码文本内容，验证码图片base64，redis存放自定义key前缀+token作为键值，验证码文本内容作为内容，用户验证验证码时，前端需回传Token和验证码内容才能进行校验。

绘制的验证码如图