SpringBoot--图片验证码kaptcha

Love The Way You Lie 2024-05-24 01:46 172阅读 0赞

本文介绍如何在SpringBoot中整合kaptcha，以及如何配置kaptcha，生成验证码和校验等

文章目录

  • 前言
  • 环境搭建
    • 项目结构
    • 添加依赖
  • 代码实现
    • KaptchaConfig
    • Knife4jConfig
    • domain
    • Service
    • util
    • controller
  • 测试
    • 生成验证码
    • 校验验证码

前言

参考链接：

  • Github链接
  • 链接1

Kaptcha 是一个Google开源，可自由配置的图片验证码生成工具，功能十分强大。使用Kaptcha时可以配置图片的宽高、字符内容、干扰类型等，自定义样式。

环境搭建

完整项目，参考https://github.com/miaoyang/spring-learn.git ，该项目还包括其他一些中间件的使用，比如Redis，MongoDB，Swagger等。

项目结构

在这里插入图片描述
将验证码单独写成了一个微服务，在实际开发中，单体项目可以裁剪部分。

添加依赖

pom文件中引入必要的依赖

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>spring-learn</artifactId>
  7.         <groupId>org.ym</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>learn-checkcode</artifactId>
  14.     <properties>
  15.         <maven.compiler.source>8</maven.compiler.source>
  16.         <maven.compiler.target>8</maven.compiler.target>
  17.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-validation</artifactId>
  27.         </dependency>
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-starter</artifactId>
  32.             <exclusions>
  33.                 <exclusion>
  34.                     <groupId>org.springframework.boot</groupId>
  35.                     <artifactId>spring-boot-starter-logging</artifactId>
  36.                 </exclusion>
  37.             </exclusions>
  38.         </dependency>
  40.         <!-- log4j2 -->
  41.         <dependency>
  42.             <groupId>org.springframework.boot</groupId>
  43.             <artifactId>spring-boot-starter-log4j2</artifactId>
  44.         </dependency>
  46.         <dependency>
  47.             <groupId>org.projectlombok</groupId>
  48.             <artifactId>lombok</artifactId>
  49.         </dependency>
  51.         <!--check code-->
  52.         <dependency>
  53.             <groupId>com.github.penggle</groupId>
  54.             <artifactId>kaptcha</artifactId>
  55.             <version>2.3.2</version>
  56.         </dependency>
  57.         <dependency>
  58.             <groupId>org.ym</groupId>
  59.             <artifactId>learn-common-core</artifactId>
  60.             <version>1.0-SNAPSHOT</version>
  61.             <scope>compile</scope>
  62.         </dependency>
  64.         <dependency>
  65.             <groupId>org.ym</groupId>
  66.             <artifactId>learn-common-swagger</artifactId>
  67.             <version>1.0-SNAPSHOT</version>
  68.         </dependency>
  69.         <dependency>
  70.             <groupId>org.ym</groupId>
  71.             <artifactId>learn-common-redis</artifactId>
  72.             <version>1.0-SNAPSHOT</version>
  73.             <scope>compile</scope>
  74.         </dependency>
  75.     </dependencies>
  77. </project>

application.yml配置

  1. server:
  2.   port: 9205
  3. spring:
  4.   application:
  5.     name: learn-checkcode
  6.   mvc:
  7.     pathmatch:
  8.       matching-strategy: ant_path_matcher
  9.   redis:
  10.     host: localhost # Redis服务器地址
  11.     database: 0 # Redis数据库索引（默认为0）
  12.     port: 6379 # Redis服务器连接端口
  13.     password:  # Redis服务器连接密码（默认为空）
  14.     timeout: 3000ms # 连接超时时间（毫秒）
  16. checkcode:
  17.   length: 4
  18.   prefix-key: check_code_
  19.   expire-time: 300 # 300s

代码实现

KaptchaConfig

CheckCodeProperties配置了验证码的一些基本属性，在application.yml 可以修改。

  1. package com.ym.learn.checkcode.config;
  3. import lombok.Data;
  4. import lombok.Getter;
  5. import org.springframework.boot.context.properties.ConfigurationProperties;
  6. import org.springframework.context.annotation.Configuration;
  8. /**
  9.  * @Author: Yangmiao
  10.  * @Date: 2023/4/21 19:44
  11.  * @Desc:
  12.  */
  13. @Data
  14. @Configuration
  15. @ConfigurationProperties(prefix = "checkcode")
  16. public class CheckCodeProperties {
  18.     /**
  19.      * 验证码长度
  20.      */
  21.     private Integer length;
  22.     /**
  23.      * key前缀
  24.      */
  25.     private String prefixKey;
  26.     /**
  27.      * 缓存过期时间
  28.      */
  29.     private Integer expireTime;
  31. }
  33. package com.ym.learn.checkcode.config;
  35. import com.google.code.kaptcha.impl.DefaultKaptcha;
  36. import com.google.code.kaptcha.util.Config;
  37. import org.springframework.context.annotation.Bean;
  38. import org.springframework.context.annotation.Configuration;
  40. import java.util.Properties;
  42. /**
  43.  * @Author: Yangmiao
  44.  * @Date: 2023/4/21 16:25
  45.  * @Desc: 验证码配置
  46.  */
  47. @Configuration
  48. public class KaptchaConfig {
  50.     @Bean
  51.     public DefaultKaptcha defaultKaptcha() {
  53.         Properties properties = new Properties();
  54.         properties.put("kaptcha.border", "no");
  56.         // 文本宽度和长度
  57.         properties.put("kaptcha.textproducer.char.space", "10");
  58.         properties.put("kaptcha.textproducer.char.length","4");
  59.         // 宽度和高度
  60.         properties.put("kaptcha.image.height","34");
  61.         properties.put("kaptcha.image.width","130");
  62.         // 字体大小和颜色
  63.         properties.put("kaptcha.textproducer.font.size","25");
  64.         properties.put("kaptcha.textproducer.font.color", "black");
  65.         // 背景
  66.         properties.setProperty("kaptcha.background.clear.from", "white");
  67.         properties.setProperty("kaptcha.background.clear.to", "white");
  69.         properties.put("kaptcha.noise.impl","com.google.code.kaptcha.impl.NoNoise");
  71.         Config config = new Config(properties);
  72.         DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
  73.         defaultKaptcha.setConfig(config);
  74.         return defaultKaptcha;
  75.     }
  76. }

Knife4jConfig

接口文档配置，该部分参考SpringBoot整合Knife4j，在本文章中，可有可无，不过为了方便测试接口。

  1. package com.ym.learn.checkcode.config;
  3. import com.ym.learn.swagger.config.BaseKnife4jConfig;
  4. import com.ym.learn.swagger.domain.Knife4jProperties;
  5. import org.springframework.context.annotation.Configuration;
  6. import springfox.documentation.oas.annotations.EnableOpenApi;
  8. /**
  9.  * @Author: Yangmiao
  10.  * @Date: 2023/4/21 22:07
  11.  * @Desc:
  12.  */
  13. @Configuration
  14. @EnableOpenApi
  15. public class Knife4jConfig extends BaseKnife4jConfig {
  17.     @Override
  18.     public Knife4jProperties knife4jProperties() {
  20.         return Knife4jProperties.builder()
  21.                 .apiBasePackage("com.ym.learn.checkcode")
  22.                 .title("验证码服务接口文档")
  23.                 .description("验证码服务接口文档")
  24.                 .contactName("ym")
  25.                 .version("1.0")
  26.                 .enableSecurity(false)
  27.                 .build();
  28.     }
  29. }

domain

  1. package com.ym.learn.checkcode.domain;
  3. import lombok.Builder;
  4. import lombok.Data;
  5. import lombok.ToString;
  7. /**
  8.  * @Author: Yangmiao
  9.  * @Date: 2023/4/21 17:36
  10.  * @Desc: 返回给客户端的Code
  11.  */
  12. @Data
  13. @ToString
  14. @Builder
  15. public class CodeVo {
  17.     /**
  18.      * 用于验证的key
  19.      */
  20.     private String key;
  21.     /**
  22.      * 校验码
  23.      */
  24.     private String aliasing;
  25. }

Service

  1. package com.ym.learn.checkcode.service;
  3. import com.ym.learn.checkcode.domain.CodeVo;
  5. /**
  6.  * @Author: Yangmiao
  7.  * @Date: 2023/4/21 17:32
  8.  * @Desc:
  9.  */
  10. public interface CheckCodeService {
  13.     /**
  14.      * 校验验证码
  15.      * @param key
  16.      * @param code
  17.      * @return
  18.      */
  19.     boolean verifyCode(String key, String code);
  21.     /**
  22.      * 生成验证码
  23.      * @param length
  24.      * @return
  25.      */
  26.     CodeVo generateCode(Integer length, String prefixKey,Integer expireTime);
  27. }
  29. package com.ym.learn.checkcode.service.impl;
  31. import cn.hutool.core.io.IoUtil;
  32. import cn.hutool.core.util.StrUtil;
  33. import com.google.code.kaptcha.impl.DefaultKaptcha;
  34. import com.sun.xml.internal.messaging.saaj.util.ByteOutputStream;
  35. import com.ym.learn.checkcode.domain.CodeVo;
  36. import com.ym.learn.checkcode.service.CheckCodeService;
  37. import com.ym.learn.checkcode.util.CodeUtil;
  38. import com.ym.learn.core.utils.SignUtil;
  39. import com.ym.learn.redis.service.RedisService;
  40. import lombok.extern.slf4j.Slf4j;
  41. import org.springframework.beans.factory.annotation.Autowired;
  42. import org.springframework.stereotype.Service;
  43. import org.springframework.util.StringUtils;
  45. import javax.imageio.ImageIO;
  46. import java.awt.image.BufferedImage;
  47. import java.io.IOException;
  49. /**
  50.  * @Author: Yangmiao
  51.  * @Date: 2023/4/21 17:33
  52.  * @Desc:
  53.  */
  54. @Service
  55. @Slf4j
  56. public class CheckCodeServiceImpl implements CheckCodeService {
  58.     @Autowired
  59.     private DefaultKaptcha defaultKaptcha;
  61.     @Autowired
  62.     private RedisService redisService;
  64.     @Override
  65.     public boolean verifyCode(String key, String code) {
  67.         if (StrUtil.isEmpty(key) || StrUtil.isEmpty(code)){
  69.             return false;
  70.         }
  71.         String localCode = (String)redisService.get(key);
  72.         if (StrUtil.isEmpty(localCode)){
  74.             return false;
  75.         }
  76.         if (!code.equalsIgnoreCase(localCode)){
  78.             return false;
  79.         }
  80.         // 删除缓存
  81.         redisService.del(key);
  82.         return true;
  83.     }
  85.     @Override
  86.     public CodeVo generateCode(Integer length, String prefixKey, Integer expireTime) {
  88.         String code = CodeUtil.generateCode(length);
  89.         String key = CodeUtil.generateKey(prefixKey);
  90.         // 缓存redis
  91.         redisService.set(key,code,expireTime);
  92.         // 获取base64编码后的img
  93.         String codeImg = generateCodeImg(code);
  94.         return CodeVo.builder()
  95.                 .key(key)
  96.                 .aliasing(codeImg)
  97.                 .build();
  98.     }
  100.     /**
  101.      * 生成codeImage
  102.      * @param code
  103.      * @return
  104.      */
  105.     private String generateCodeImg(String code){
  107.         BufferedImage bufferedImage = defaultKaptcha.createImage(code);
  108.         ByteOutputStream byteOutputStream = null;
  109.         String codeImg = "";
  110.         try {
  112.             byteOutputStream = new ByteOutputStream();
  113.             ImageIO.write(bufferedImage,"png",byteOutputStream);
  114.             codeImg = "data:image/png;base64,"+SignUtil.encodeBase64(byteOutputStream.getBytes());
  115.         } catch (IOException e) {
  117.             e.printStackTrace();
  118.         }finally {
  120.             if (byteOutputStream != null) {
  122.                 byteOutputStream.close();
  123.             }
  124.         }
  125.         return codeImg;
  126.     }
  127. }

util

用于生成Key和Code

  1. package com.ym.learn.checkcode.util;
  3. import java.util.Random;
  4. import java.util.UUID;
  6. /**
  7.  * @Author: Yangmiao
  8.  * @Date: 2023/4/21 17:05
  9.  * @Desc: 验证码工具类
  10.  */
  11. public class CodeUtil {
  13.     /**
  14.      * Code字符的取值范围
  15.      */
  16.     public static final String CODE_NUM = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
  18.     /**
  19.      * 生成UUID，包括前缀
  20.      * @param prefix
  21.      * @return
  22.      */
  23.     public static String generateKey(String prefix){
  25.         String uuid = UUID.randomUUID().toString().replaceAll("-", "");
  26.         return prefix+uuid;
  27.     }
  29.     /**
  30.      * 生成指定长度的code
  31.      * @param len 不指定时，默认为4
  32.      * @return
  33.      */
  34.     public static String generateCode(Integer len){
  36.         if (len <= 0){
  38.             len = 4;
  39.         }
  40.         StringBuilder sb = new StringBuilder();
  41.         for (int i = 0; i < len; i++) {
  43.             Random random = new Random();
  44.             int nextInt = random.nextInt(CODE_NUM.length());
  45.             sb.append(CODE_NUM.charAt(nextInt));
  46.         }
  47.         return sb.toString();
  48.     }
  50. }

controller

  1. package com.ym.learn.checkcode.controller;
  3. import com.ym.learn.checkcode.config.CheckCodeProperties;
  4. import com.ym.learn.checkcode.domain.CodeVo;
  5. import com.ym.learn.checkcode.service.CheckCodeService;
  6. import com.ym.learn.core.api.R;
  7. import io.swagger.annotations.Api;
  8. import io.swagger.annotations.ApiOperation;
  9. import io.swagger.annotations.ApiParam;
  10. import org.springframework.beans.factory.annotation.Autowired;
  11. import org.springframework.web.bind.annotation.*;
  13. /**
  14.  * @Author: Yangmiao
  15.  * @Date: 2023/4/21 17:29
  16.  * @Desc: 验证码接口
  17.  */
  18. @Api(tags = "验证码接口")
  19. @RestController
  20. @RequestMapping("/checkcode")
  21. public class CheckCodeController {
  24.     @Autowired
  25.     private CheckCodeService checkCodeService;
  27.     @Autowired
  28.     private CheckCodeProperties codeProperties;
  30.     @ApiOperation(value = "获取验证码")
  31.     @GetMapping("/getCheckCode")
  32.     public R getCheckCode(){
  34.         CodeVo codeVo = checkCodeService.generateCode(codeProperties.getLength(), codeProperties.getPrefixKey(), codeProperties.getExpireTime());
  35.         return R.ok(codeVo);
  36.     }
  38.     @ApiOperation(value = "校验验证码")
  39.     @PostMapping("/verifyCheckCode")
  40.     public R verifyCheckCode(@ApiParam(name = "key")@RequestParam("key")String key,
  41.                              @ApiParam(name = "code")@RequestParam("code")String code){
  43.         boolean ret = checkCodeService.verifyCode(key, code);
  44.         return R.ok(ret);
  45.     }
  47. }

测试

使用Knfie4j测试接口
在这里插入图片描述

生成验证码

在这里插入图片描述
将aliasing 对应的value复制到浏览器地址，解析出图片如下：
在这里插入图片描述

校验验证码

客户端需要传入key 和验证码数字，服务端从缓存中取出key对应的value值，和客户端传入的验证码进行匹配。
注意：

  • 缓存的时间

在这里插入图片描述

发表评论

表情：
评论列表 （有 0 条评论，172人围观）

还没有评论，来说两句吧...

相关阅读

    相关 Kaptcha生成图片验证码

    Kaptcha简介 kaptcha 是一个很有用的验证码生成工具。由于它是可配置的，有了它，你能够生成各种样式的验证码。 Kaptcha 是一个可高度配置的实用验证码

    傷城~傷城~/ 0 赞/ 506 阅读