SpringBoot使用Kaptcha设置图形验证码
AI 摘要鱼粮不足,AI 今天先歇着 · 正文在下面
教程
1、kaptcha参数说明
| Constant | 描述 | 默认值 |
|---|---|---|
| kaptcha.border | 图片边框,合法值:yes , no | yes |
| kaptcha.border.color | 边框颜色,合法值: r,g,b (and optional alpha) 或者 | white,black,blue. |
| kaptcha.border.thickness | 边框厚度,合法值:>0 | 1 |
| 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 |
2、引入依赖
以下是谷歌验证码的必要的maven依赖
xml
<!-- kaptcha -->
<dependency>
<groupId>com.github.penggle</groupId>
<artifactId>kaptcha</artifactId>
<version>2.3.2</version>
</dependency>
3、编写配置类
以下是示例配置,可以将这些参数抽取在配置文件中
java
import com.google.code.kaptcha.impl.DefaultKaptcha;
import com.google.code.kaptcha.util.Config;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import java.util.Properties;
/**
* 验证码生成配置
*
* @author Salmon
* @since 2023-04-10
*/
@Component
public class KaptchaConfig {
@Bean
public DefaultKaptcha getDefaultKaptcha() {
DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
Properties properties = new Properties();
// 图片边框
properties.setProperty("kaptcha.border", "no");
// 图片边框
properties.setProperty("kaptcha.border.color", "blue");
// 字体颜色
properties.setProperty("kaptcha.textproducer.font.color", "black");
// 图片宽
properties.setProperty("kaptcha.image.width", "160");
// 图片高
properties.setProperty("kaptcha.image.height", "50");
// 字体大小
properties.setProperty("kaptcha.textproducer.font.size", "40");
// session key
properties.setProperty("kaptcha.session.key", "code");
// 干扰颜色
properties.setProperty("kaptcha.noise.color", "white");
// 图片样式:阴影
properties.setProperty("kaptcha.obscurificator.impl", "com.google.code.kaptcha.impl.ShadowGimpy");
// 验证码长度
properties.setProperty("kaptcha.textproducer.char.length", "4");
// 字体
properties.setProperty("kaptcha.textproducer.font.names", "宋体,楷体,微软雅黑");
Config config = new Config(properties);
defaultKaptcha.setConfig(config);
return defaultKaptcha;
}
}
4、KaptchaController示例
以下是接口示例
java
import cn.hutool.json.JSONUtil;
import com.google.code.kaptcha.Constants;
import com.google.code.kaptcha.impl.DefaultKaptcha;
import com.salmon.config.redis.service.IRedisUtilService;
import com.salmon.constant.AdminConstants;
import com.salmon.util.ImageUtils;
import com.salmon.util.Utils;
import com.salmon.vo.resp.ResultVo;
import io.swagger.annotations.Api;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletResponse;
import java.awt.image.BufferedImage;
import java.io.PrintWriter;
/**
* 生成图形验证码
*
* @author Salmon
* @since 2023-04-10
*/
@RestController
@RequestMapping("/system/kaptcha")
@Api(tags = "生成图形验证码接口API")
@Slf4j
@AllArgsConstructor
public class KaptchaController {
private DefaultKaptcha defaultKaptcha;
private IRedisUtilService redisUtilService;
@GetMapping(value = "/code")
public void code(HttpServletResponse response) throws Exception {
String baseImage;
//生产验证码字符串并保存到jwt令牌中
String createText = defaultKaptcha.createText();
//给定一个唯一标识,防止验证码重复使用
String token = Utils.getUUID();
try {
//
redisUtilService.setForTimeMinutes(Constants.KAPTCHA_SESSION_KEY + ":" + token, createText, 5);
//使用生产的验证码字符串返回一个BufferedImage对象并转为byte写入到byte数组中
BufferedImage challenge = defaultKaptcha.createImage(createText);
baseImage = ImageUtils.bufferedImageToBase64(challenge, "jpg");
} catch (IllegalArgumentException e) {
response.sendError(HttpServletResponse.SC_NOT_FOUND);
return;
}
response.setContentType("application/json;charset=UTF-8");
response.setHeader(AdminConstants.ADMIN_KAPTCHA_TOKEN_HEADER, token);
PrintWriter writer = response.getWriter();
writer.println(JSONUtil.toJsonStr(ResultVo.success(baseImage)));
writer.flush();
writer.close();
}
}
5、请求结果

评论
0 条—
还没有评论,来说第一句