anji验证码AJ-Captcha避坑指南，springBoot集成后redisTemplate注入空指针及/captcha/get接口响应400无信息

SpringBoot集成AJ-Captcha使用流程

开源项目地址https://gitee.com/anji-plus/captcha

• pom引入

第一个坑

建议使用1.3.0版本，部分博文中的链接拉到的代码是1.2.8的，据该项目gitee中master分支Issues信息描述1.2.8会有一些问题，尽管我没有遇到，但还是跟master分支同步

		<!-- anji滑块验证码 -->
        <dependency>
            <groupId>com.anji-plus</groupId>
            <artifactId>spring-boot-starter-captcha</artifactId>
            <version>1.3.0</version>
        </dependency>

• yml配置

aj:
  captcha:
    jigsaw: classpath:images/jigsaw
    #滑动验证，底图路径，不配置将使用默认图片
    ##支持全路径
    # 支持项目路径,以classpath:开头,取resource目录下路径,例：classpath:images/pic-click
    pic-click: classpath:images/pic-click
    # 对于分布式部署的应用，我们建议应用自己实现CaptchaCacheService，比如用Redis或者memcache，
    # 参考CaptchaCacheServiceRedisImpl.java
    # 如果应用是单点的，也没有使用redis，那默认使用内存。
    # 内存缓存只适合单节点部署的应用，否则验证码生产与验证在节点之间信息不同步，导致失败。
    # ！！！ 注意啦，如果应用有使用spring-boot-starter-data-redis，
    # 请打开CaptchaCacheServiceRedisImpl.java注释。
    # redis ----->  SPI： 在resources目录新建META-INF.services文件夹(两层)，参考当前服务resources。
    # 缓存local/redis...
    cache-type: redis
    # local缓存的阈值,达到这个值，清除缓存
    cache-number: 1000
    # local定时清除过期缓存(单位秒),设置为0代表不执行
    timing-clear: 180
    # 验证码类型default两种都实例化。
    type: default
    # 汉字统一使用Unicode,保证程序通过@value读取到是中文，可通过这个在线转换;yml格式不需要转换
    # https://tool.chinaz.com/tools/unicode.aspx 中文转Unicode
    # 右下角水印文字(我的水印)
    water-mark: water-mark
    # 右下角水印字体(不配置时，默认使用文泉驿正黑)
    # 由于宋体等涉及到版权，我们jar中内置了开源字体【文泉驿正黑】
    # 方式一：直接配置OS层的现有的字体名称，比如：宋体
    # 方式二：自定义特定字体，请将字体放到工程resources下fonts文件夹，支持ttf\ttc\otf字体
    # aj.captcha.water-font=WenQuanZhengHei.ttf
    # water-font: SourceHanSansCN-Normal.otf
    # 点选文字验证码的文字字体(文泉驿正黑)
    # aj.captcha.font-type=WenQuanZhengHei.ttf
    # font-type: SourceHanSansCN-Normal.otf
    # 校验滑动拼图允许误差偏移量(默认5像素)
    slip-offset: 5
    # aes加密坐标开启或者禁用(true|false)
    aes-status: true
    # 滑动干扰项(0/1/2)
    interference-options: 1
    history-data-clear-enable: true
    # 接口请求次数一分钟限制是否开启 true|false
    req-frequency-limit-enable: true
    # 验证失败5次，get接口锁定
    req-get-lock-limit: 5
    # 验证失败后，锁定时间间隔,s
    req-get-lock-seconds: 60
    # get接口一分钟内请求数限制
    req-get-minute-limit: 30
    # check接口一分钟内请求数限制
    req-check-minute-limit: 60
    # verify接口一分钟内请求数限制
    req-verify-minute-limit: 60

第二个坑

• CaptchaCacheService方法实现
  这里拉到的代码中已经有现成的实现类，并且在resources/META-INF/services目录下会有一个指向实现类的文件com.anji.captcha.service.CaptchaCacheService，内容是你的实现类的全路径类名
  目录结构一定要完全相同，否则扫不到实现类
  
  此处粘出实现类

package com.markyo.service;

import com.anji.captcha.service.CaptchaCacheService;
import com.markyo.utils.SpringContextUtils;
import org.springframework.data.redis.core.StringRedisTemplate;

import java.util.concurrent.TimeUnit;

/**
 * 对于分布式部署的应用，我们建议应用自己实现CaptchaCacheService，比如用Redis，参考service/spring-boot代码示例。
 * 如果应用是单点的，也没有使用redis，那默认使用内存。
 * 内存缓存只适合单节点部署的应用，否则验证码生产与验证在节点之间信息不同步，导致失败。
 * 

 * ☆☆☆ SPI： 在resources目录新建META-INF.services文件夹(两层)，参考当前服务resources。
 * 

 * 使用redis缓存
 *
 * @author [email protected]
 * @date 2020-05-12
 */
public class CaptchaCacheServiceRedisImpl implements CaptchaCacheService {
    private StringRedisTemplate stringRedisTemplate;

    @Override
    public String type() {
        return "redis";
    }


    @Override
    public void set(String key, String value, long expiresInSeconds) {
        stringRedisTemplate.opsForValue().set(key, value, expiresInSeconds, TimeUnit.SECONDS);
    }

    @Override
    public boolean exists(String key) {
        return stringRedisTemplate.hasKey(key);
    }

    @Override
    public void delete(String key) {
        stringRedisTemplate.delete(key);
    }

    @Override
    public String get(String key) {
        return stringRedisTemplate.opsForValue().get(key);
    }

    @Override
    public Long increment(String key, long val) {
        return stringRedisTemplate.opsForValue().increment(key, val);
    }
}

• 资源导入
• 将官方demo中的images包整体引入到resources包下
  

第三个坑

第三个需要注意的点就在实现类中，项目使用SPI的方式并不会走spring的自动注入，导致这一行代码会报空指针private StringRedisTemplate stringRedisTemplate;在这里我改用了上下文对象获取stringRedisTemplate private static final StringRedisTemplate stringRedisTemplate = SpringContextUtils.getBean("stringRedisTemplate", StringRedisTemplate.class);避免了空指针的出现

400报错

最后讲一下在实际应用中我在做完一系列导入操作后集成到我的SpringBoot项目后出现的响应400问题但没有错误信息，下图中FrequencyLimitHandler的实现类debug到这一行的时候，cacheService对象为空，导致报错，在关闭配置文件中的req-frequency-limit-enable或者cache-type为local的情况下不会进到这个类，也就没有这个问题，直接返回，但是当项目发布到线上使用redis的时候就会出现这个问题，在后来的排查过程中发现也是跟上面的空指针同样的问题，在实现类中更换StringRedisTemplate的创建方式即可解决

整理

• 使用方式
  1.https://gitee.com/anji-plus/captcha拉取项目本地运行，也可以参考百度排名第一位的文章https://blog.csdn.net/weixin_38187317/article/details/114522203
  2.引入到SpringBoot项目中分为4步pom依赖引入、yml文件配置、实现类创建及映射、资源包导入

• 问题排查
  1.启动后接口400无信息问题
  2.实现类的映射文件包路径是否有误
  3.实现类中StringRedisTemplate的创建方式问题