Kaptcha 图像验证码

简介：

kaptcha是一个可高度配置的使用验证码生成工具，可自由配置的选项如：

    验证码字体

    验证码字体的大小

    验证码字体的字体颜色

    验证码内容的范围（数字、字母、中文汉字！）

    验证码图片的大小、边框、边框粗细、边框颜色

    验证码干扰线

    验证码的样式（鱼眼样式、3D、普通模糊）

Kaptcha详细配置表

Constant	描述	默认值
kaptcha.border	图片边框，合法值：yes , no	yes
kaptcha.border.color	边框颜色，合法值： r,g,b (and optional alpha) 或者 white,black,blue.	black
kaptcha.image.width	图片宽	200
kaptcha.image.height	图片高	50
kaptcha.producer.impl	图片实现类	com.google.code.kaptcha.impl.DefaultKaptcha
kaptcha.textproducer.impl	文本实现类	com.google.code.kaptcha.text.impl.DefaultTextCreator
kaptcha.textproducer.char.string	文本集合，验证码值从此集合中获取	abcde2345678gfynmnpwx
kaptcha.textproducer.char.length	验证码长度	5
kaptcha.textproducer.font.names	字体	Arial, Courier
kaptcha.textproducer.font.size	字体大小	40px.
kaptcha.textproducer.font.color	字体颜色，合法值： r,g,b 或者 white,black,blue.	black
kaptcha.textproducer.char.space	文字间隔	2
kaptcha.noise.impl	干扰实现类	com.google.code.kaptcha.impl.DefaultNoise
kaptcha.noise.color	干扰 颜色，合法值： r,g,b 或者 white,black,blue.	black
kaptcha.obscurificator.impl	图片样式： 水纹 com.google.code.kaptcha.impl.WaterRipple 鱼眼 com.google.code.kaptcha.impl.FishEyeGimpy 阴影 com.google.code.kaptcha.impl.ShadowGimpy	com.google.code.kaptcha.impl.WaterRipple
kaptcha.background.impl	背景实现类	com.google.code.kaptcha.impl.DefaultBackground
kaptcha.background.clear.from	背景颜色渐变，开始颜色	light grey
kaptcha.background.clear.to	背景颜色渐变， 结束颜色	white
kaptcha.word.impl	文字渲染器	com.google.code.kaptcha.text.impl.DefaultWordRenderer
kaptcha.session.key	session key	KAPTCHA_SESSION_KEY
kaptcha.session.date	session date	KAPTCHA_SESSION_DATE

用法：

在pom.xml添加依赖

<dependency>
    <groupId>com.google.code.kaptcha</groupId>
    <artifactId>kaptcha</artifactId>
    <version>2.3</version>
</dependency>

或者

<dependency>
    <groupId>com.github.penggle</groupId>
    <artifactId>kaptcha</artifactId>
    <version>2.3.2</version>
</dependency>

对图形验证码的展示进行各种配置

@Component
public class KaptchaConfig {
    @Bean
    public DefaultKaptcha getDDefaultKaptcha() {
        DefaultKaptcha dk = new DefaultKaptcha();
        Properties properties = new Properties();
        // 图片边框
        properties.setProperty("kaptcha.border", "yes");
        // 边框颜色
        properties.setProperty("kaptcha.border.color", "105,179,90");
        // 字体颜色
        properties.setProperty("kaptcha.textproducer.font.color", "red");
        // 图片宽
        properties.setProperty("kaptcha.image.width", "110");
        // 图片高
        properties.setProperty("kaptcha.image.height", "40");
        // 字体大小
        properties.setProperty("kaptcha.textproducer.font.size", "30");
        // 验证码长度
        properties.setProperty("kaptcha.textproducer.char.length", "4");
        // 字体
        properties.setProperty("kaptcha.textproducer.font.names", "宋体,楷体,微软雅黑");
        //文本集合,将一些比较混淆的字母数字去掉
        properties.setProperty("kaptcha.textproducer.char.string","23456789abcdefghjkmnpqrstuvwxyzABCDEFGHJKMNOPQRSTUVWXYZ")
        Config config = new Config(properties);
        dk.setConfig(config);
​
        return dk;
    }
}

KaptchaController.java

思路：通过kaptcha生成图片验证码，以及对应的验证码数据，将这两者返回给前端，当前端返回数据时，将对应的key和验证码数据返回进行验证即可。因为是多台服务器，如果将验证码数据存在这台机器的session中，当请求另一台服务器时就会请求不到，因此将验证码数据存到redis中

@Autowired
private DefaultKapcha defaulrKaptcha;
​
@GetMapping("/getVerify")
@ResponseBody
public ResponseBean getVerifyCode(HttpServletRequest request,HttpServletResponse ponse response) throws Exception{
    byte[] captcha=null;
    ByteArrayOutputStream out = new ByteArrayOutputStream();
    Map<String,Object> map=new HashMap<>();
    try{
    //得到文本信息
        String createText = defaultKaptcha.createText().toLowerCase();
        //随机产生一个key保存到redis里面
        String key=UUID.randomUUID().toString();
        RedisUtils.set(key,createText());
        map.put("key",key);
        
        //根据文本生成图片验证码
        BufferedImage bi = defaultKaptcha.createImage(createText);
        ImageIO.write(bi,"jpg",out);
        //将图片转为字节，编码传给前端
        catcha = out.toByteArray()；
        BASE64Encoder encoder=new BASE64Encoder();
        String jgp_base64=encoder.encoderBuffer(captcha);
        map.put("image",jpg_base64);
    }catch(Exception e){
        e.printStackTrace();
    }
    return RespinseBean.success(map);
}

当写代码时，出现了一个问题

异常：Eoor resolving template "***",template might not exist or might not be accessible by any of the configured Template Resolvers 解决方法

解决方法：在报出这个异常的方法上添加注解@ResponseBody

@ResponseBody作用：

这种将方法的返回值，以特定的格式写入到Response的body区域，进而将数据返回给客户端。

当方法上面没有写ResponseBody，底层会将方法的返回值封装为ModelAndView对象。

如果返回值时字符串，那么直接将字符串写到客户端，如果是一个对象，会将对象转换为json串，然后写到客户端。

原理：控制层方法的返回值是如何转换为json格式的字符串的？其实是通过HTTPMessageConverter中的方法实现的，他本是一个接口，在其实现类完成转换，如果是bean对象，会调用对象的get***（）方法获取属性值并且以键值对的形式进行封装，进而转换为json传，如果是map集合，采用get(key)方式获取value值，然后进行封装

 

@ResponseBody这个注解，就表明该方法的返回值直接写入到http ResponseBody中，这就是说，如果返回的值接送，就必须添加@ResponseBody这个注解，一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，加上@ResponseBody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中，比如异步获取json数据，加上@ResponseBody后，会直接返回json数据

 

@Controller层加注解 @Controller和@RestController都可以在前端调通接口，但二者区别在于，当用前者的时候在方法上必须添加注解@ResponseBody，如果不添加@ResponseBody，就会报上面错误，因为当时候@COntroller注解时，spring默认方法返回的是view对象，而加上#ResponseBody，则方法返回的就是具体对象。@RestController的作用就相当于@COntroller+@ResponseBody结合体。