前面也提到过同样的话题，今天来完善一下Springboot整合Hutool自定义注解实现数据脱敏_springboot集成hutool-CSDN博客
昨天一面面了一家医疗系统，总体感觉还是不错的，以前觉得不起眼的hutool就有被问到，险些没答上来，今天我们就来总结一下hutool，言归正传，咱们进入正题了！
前言
在数字化日益普及的今天，互联网安全已经成为人们不可忽视的重要问题。特别是在用户注册、登录、重置密码等关键操作中，如何确保用户的身份真实性和操作安全性，就显得尤为重要。验证码作为一种简单而有效的身份验证手段，被广泛应用于各种在线服务中。
SpringBoot作为一款优秀的Java框架，其简单易用、功能强大的特性，深受开发者喜爱。在SpringBoot项目中集成验证码功能，可以进一步提升系统的安全性和用户体验。而hutool-captcha作为hutool工具包中的一个模块，提供了多种类型的验证码生成和验证功能，使得在SpringBoot中实现验证码功能变得简单快捷。
下面将详细介绍如何在SpringBoot项目中集成hutool-captcha验证码模块，包括验证码的生成、配置、展示以及验证等各个环节。
官网链接：概述 | Hutool
1、添加依赖
首先，我们需要在项目的pom.xml文件中添加hutool-captcha的依赖。hutool-captcha是hutool工具包中的一个模块，因此我们需要引入hutool-all的依赖，其中包含了hutool的所有模块。
https://mvnrepository.com/artifact/cn.hutool/hutool-all<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.7.12</version>
</dependency>2、生成验证码
接下来，我们需要在后端创建一个控制器类，用于生成验证码。这个控制器类将使用hutool-captcha提供的API来生成随机的验证码字符串和对应的图片，并将验证码图片发送给前端展示，同时将验证码字符串存储在session中，以便后续的验证
一般实际使用情况是存在redis当中，这里演示就使用session存储
import cn.hutool.captcha.CaptchaUtil;
import cn.hutool.captcha.LineCaptcha;
import cn.hutool.captcha.ShearCaptcha;
import VerifyCodeVO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.imageio.ImageIO;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Base64;
import java.util.UUID;
import java.util.concurrent.TimeUnit;
/**
* @author author
*/
@RestController
@Api(tags = "验证码工具类")
public class CommonController {
@Resource
RedisTemplate<String, String> redisTemplate;
/**
* 方法一 ShearCaptcha
* 图片格式
* session存储
* 接口需添加白名单放行
*
* @param request HttpServletRequest
*/
@GetMapping("/verify")
@ApiOperation("生成验证码")
public void verify(HttpServletRequest request, HttpServletResponse response) throws IOException {
response.setContentType("image/jpeg");
response.setHeader("Pragma", "no-cache");
response.setHeader("Cache-Control", "no-cache");
response.setDateHeader("Expires", 0);
//定义图形验证码的长、宽、验证码字符数、干扰线宽度
ShearCaptcha shearCaptcha = CaptchaUtil.createShearCaptcha(150, 40, 5, 4);
//图形验证码写出，可以写出到文件，也可以写出到流
shearCaptcha.write(response.getOutputStream());
//获取验证码中的文字内容
request.getSession().setAttribute("verifyCode", shearCaptcha.getCode());
}
/**
* 方法二 LineCaptcha
* 图片格式
* session存储
* 接口需添加白名单放行
*
* @param request HttpServletRequest
*/
@GetMapping("/verifyTwo")
@ApiOperation("生成验证码")
public void verifyTwo(HttpServletRequest request, HttpServletResponse response) throws IOException {
response.setContentType("image/jpeg");
response.setHeader("Pragma", "no-cache");
response.setHeader("Cache-Control", "no-cache");
response.setDateHeader("Expires", 0);
//定义图形验证码的长、宽、验证码字符数、干扰线宽度
LineCaptcha lineCaptcha = CaptchaUtil.createLineCaptcha(150, 40, 5, 4);
//图形验证码写出，可以写出到文件，也可以写出到流
ImageIO.write(lineCaptcha.getImage(), "JPEG", response.getOutputStream());
//获取验证码中的文字内容
request.getSession().setAttribute("verifyCode", lineCaptcha.getCode());
}
/**
* 方法三 ShearCaptcha
* 图片的base64编码字符串
* session存储
* 接口需添加白名单放行
*
* @param request HttpServletRequest
* @return String
*/
@GetMapping("/getVerify")
@ApiOperation("生成验证码")
public String getVerify(HttpServletRequest request) {
//定义图形验证码的长、宽、验证码字符数、干扰线宽度
ShearCaptcha shearCaptcha = CaptchaUtil.createShearCaptcha(150, 40, 5, 4);
//获取验证码中的文字内容
request.getSession().setAttribute("verifyCode", shearCaptcha.getCode());
String base64String = "";
try {
base64String = "data:image/png;base64," + shearCaptcha.getImageBase64();
} catch (Exception e) {
e.printStackTrace();
}
return base64String;
}
/**
* 方法四 LineCaptcha
* 图片的base64编码字符串
* session存储
* 接口需添加白名单放行
*
* @param request HttpServletRequest
* @return String
*/
@GetMapping("/getVerifyTwo")
@ApiOperation("生成验证码")
public String getVerifyTwo(HttpServletRequest request) {
//定义图形验证码的长、宽、验证码字符数、干扰线宽度
LineCaptcha lineCaptcha = CaptchaUtil.createLineCaptcha(150, 40, 5, 4);
//获取验证码中的文字内容
request.getSession().setAttribute("verifyCode", lineCaptcha.getCode());
String base64String = "";
try {
//返回 base64
ByteArrayOutputStream bos = new ByteArrayOutputStream();
ImageIO.write(lineCaptcha.getImage(), "JPEG", bos);
byte[] bytes = bos.toByteArray();
Base64.Encoder encoder = Base64.getEncoder();
base64String = "data:image/png;base64," + encoder.encodeToString(bytes);
} catch (Exception e) {
e.printStackTrace();
}
return base64String;
}
/**
* 方法五 ShearCaptcha
* 图片的base64编码字符串
* redis存储
* 接口需添加白名单放行
*
* @return String
*/
@GetMapping("/getVerifyThree")
@ApiOperation("生成验证码")
public VerifyCodeVO getVerifyThree() {
String captchaKey = UUID.randomUUID().toString();
//定义图形验证码的长、宽、验证码字符数、干扰线宽度
ShearCaptcha shearCaptcha = CaptchaUtil.createShearCaptcha(150, 40, 5, 0);
// 存入redis并设置过期时间为30分钟
redisTemplate.opsForValue().set("captcha:" + captchaKey, shearCaptcha.getCode(), 30L, TimeUnit.MINUTES);
//captcha:d6e561a6-7929-4469-8154-008710932f61
String base64String = "";
try {
base64String = "data:image/png;base64," + shearCaptcha.getImageBase64();
} catch (Exception e) {
e.printStackTrace();
}
VerifyCodeVO verifyCodeVO = new VerifyCodeVO();
verifyCodeVO.setCaptchaKey(captchaKey);
verifyCodeVO.setCaptchaImg(base64String);
return verifyCodeVO;
}
/**
* 方法六 LineCaptcha
* 图片的base64编码字符串
* redis存储
* 接口需添加白名单放行
*
* @return String
*/
@GetMapping("/getVerifyFour")
@ApiOperation("生成验证码")
public VerifyCodeVO getVerifyFour() {
String captchaKey = UUID.randomUUID().toString();
//定义图形验证码的长、宽、验证码字符数、干扰线宽度
LineCaptcha lineCaptcha = CaptchaUtil.createLineCaptcha(150, 40, 5, 4);
// 存入redis并设置过期时间为30分钟
redisTemplate.opsForValue().set("captcha:" + captchaKey, lineCaptcha.getCode(), 30L, TimeUnit.MINUTES);
//captcha:d6e561a6-7929-4469-8154-008710932f61
String base64String = "";
try {
//返回 base64
ByteArrayOutputStream bos = new ByteArrayOutputStream();
ImageIO.write(lineCaptcha.getImage(), "JPEG", bos);
byte[] bytes = bos.toByteArray();
Base64.Encoder encoder = Base64.getEncoder();
base64String = "data:image/png;base64," + encoder.encodeToString(bytes);
} catch (Exception e) {
e.printStackTrace();
}
VerifyCodeVO verifyCodeVO = new VerifyCodeVO();
verifyCodeVO.setCaptchaKey(captchaKey);
verifyCodeVO.setCaptchaImg(base64String);
return verifyCodeVO;
}
}3、前端展示验证码
前端调用展示：在img标签中src属性调用 /verify 接口，将传过来的图片验证码显示即可。若想换一张显示（刷新验证码）：在img标签中增加一个onclick属性点击事件即可。
<img src="/verify" id="verifyCode" onclick="refresh()" alt="验证码" />
<script>
/* 刷新验证码 */
function refresh() {
document.getElementById("verifyCode").src = "verify?time=" + new Date().getTime();
}
</script>4、验证验证码
最后，当用户提交表单时，后端需要对用户输入的验证码进行验证。这可以通过从session中获取之前存储的验证码字符串，并与用户输入的验证码进行比较来实现。
/**
* session存储
*
* @param captchaCode 验证码
* @param request HttpServletRequest
* @return boolean
*/
@GetMapping("/checkCaptcha")
@ApiOperation("验证码校验")
public boolean getCheckCaptcha(@RequestParam("captchaCode") String captchaCode, HttpServletRequest request) {
try {
// toLowerCase() 不区分大小写进行验证码校验
String sessionCode = String.valueOf(request.getSession().getAttribute("verifyCode")).toLowerCase();
System.out.println("session里的验证码：" + sessionCode);
String receivedCode = captchaCode.toLowerCase();
System.out.println("用户的验证码：" + receivedCode);
return !"".equals(sessionCode) && !"".equals(receivedCode) && sessionCode.equals(receivedCode);
} catch (Exception e) {
return false;
}
}
/**
* redis存储
*
* @param captchaCode 验证码
* @param request HttpServletRequest
* @return boolean
*/
@GetMapping("/checkCaptchaTwo")
@ApiOperation("验证码校验")
@ApiImplicitParam(value = "Captcha-Key", name = "Captcha-Key", paramType = "header", dataType = "String", required = true)
public boolean getCheckCaptchaTwo(@RequestParam("captchaCode") String captchaCode, HttpServletRequest request) {
try {
// toLowerCase() 不区分大小写进行验证码校验
String redisCode = String.valueOf(redisTemplate.opsForValue().get("captcha:" + request.getHeader("Captcha-Key"))).toLowerCase();
System.out.println("redisCode里的验证码：" + redisCode);
String receivedCode = captchaCode.toLowerCase();
System.out.println("用户的验证码：" + receivedCode);
return !"".equals(redisCode) && !"".equals(receivedCode) && redisCode.equals(receivedCode);
} catch (Exception e) {
return false;
}
}Redis存储，返回工具类：
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
@Data
public class VerifyCodeVO implements Serializable {
@ApiModelProperty(value = "header头参数：Captcha-Key")
private String captchaKey;
@ApiModelProperty(value = "验证码图片")
private String captchaImg;
}5. 总结与展望
通过集成hutool-captcha模块，我们成功地在SpringBoot项目中实现了验证码的生成、配置、展示以及验证功能。这一功能不仅增强了系统的安全性，还提升了用户体验。用户在注册、登录等关键操作中，可以通过输入验证码来验证身份，从而有效防止了恶意攻击和非法操作。
随着技术的不断发展，验证码的形式和验证方式也在不断演进。未来，我们可以进一步探索和研究更先进、更智能的验证码技术，如滑动验证码、点选验证码等，以应对更加复杂和高级的攻击手段。同时，我们也可以通过优化验证码的生成算法和验证逻辑，进一步提高系统的性能和安全性。
总之，hutool-captcha为SpringBoot项目提供了便捷、高效的验证码解决方案。通过合理使用这一工具，我们可以构建出更加安全、可靠的在线服务，为用户提供更好的体验。
4400
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
