代码编织梦想

前言

🍊作者简介: 不肯过江东丶,一个来自二线城市的程序员,致力于用“猥琐”办法解决繁琐问题,让复杂的问题变得通俗易懂。
🍊支持作者: 点赞👍、关注💖、留言💌~

不少网站为了防止用户利用机器人自动注册、登录、灌水,都采用了验证码技术。所谓验证码,就是将一串随机产生的数字或符号,生成一幅图片,图片里加上一些干扰象素(防止OCR),由用户肉眼识别其中的验证码信息,输入表单提交网站验证,验证成功后才能使用某项功能。所以每一个系统或者网站都离不开验证码,验证码的功能也是很重要的,那么这次与大家分享一下验证码的实现方式。

Maven依赖

在开发验证码功能的时候,我用到的是kaptcha谷歌验证码工具,下面直接上依赖。

<!--验证码 -->
<dependency>
	<groupId>com.github.penggle</groupId>
	<artifactId>kaptcha</artifactId>
	<version>2.3.2</version>
	<exclusions>
		<exclusion>
			<artifactId>javax.servlet-api</artifactId>
			<groupId>javax.servlet</groupId>
		</exclusion>
	</exclusions>
</dependency>

功能实现

最常见的验证码有两种形式,一种是字符串验证码,另一种是数字加减法验证码(如下图所示),废话不多说,直接上代码。
字符串验证码
数字加减法验证码

application.yml文件以及自定义验证码过滤器

在application.yml文件中增加了一个验证码的开关与验证码类型的相关配置,便于页面对验证码的类型进行切换。

shiro:
    # 验证码开关
    captchaEnabled: true
    # 验证码类型 math 数组计算 char 字符
    captchaType: math

大家可以看到,验证码的配置是增加在了shiro节点下,那么在ShiroConfig中也就需要增加两个相应的参数并把自己的验证码过滤器配置到shiro中。

CaptchaValidateFilter.java

public class CaptchaValidateFilter extends AccessControlFilter
{
    /**
     * 是否开启验证码
     */
    private boolean captchaEnabled = true;

    /**
     * 验证码类型
     */
    private String captchaType = "math";

    public void setCaptchaEnabled(boolean captchaEnabled){
        this.captchaEnabled = captchaEnabled;
    }

    public void setCaptchaType(String captchaType){
        this.captchaType = captchaType;
    }

    @Override
    public boolean onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception{
        request.setAttribute(ShiroConstants.CURRENT_ENABLED, captchaEnabled);
        request.setAttribute(ShiroConstants.CURRENT_TYPE, captchaType);
        return super.onPreHandle(request, response, mappedValue);
    }

    @Override
    protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue)
            throws Exception{
        HttpServletRequest httpServletRequest = (HttpServletRequest) request;
        // 验证码禁用或不是表单提交时,允许访问
        if (captchaEnabled == false || !"post".equals(httpServletRequest.getMethod().toLowerCase())){
            return true;
        }
        return validateResponse(httpServletRequest, httpServletRequest.getParameter(ShiroConstants.CURRENT_VALIDATECODE));
    }

    public boolean validateResponse(HttpServletRequest request, String validateCode){
        Object obj = ShiroUtils.getSession().getAttribute(Constants.KAPTCHA_SESSION_KEY);
        String code = String.valueOf(obj != null ? obj : "");
        if (StringUtils.isEmpty(validateCode) || !validateCode.equalsIgnoreCase(code)){
            return false;
        }
        return true;
    }

    @Override
    protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception{
        request.setAttribute(ShiroConstants.CURRENT_CAPTCHA, ShiroConstants.CAPTCHA_ERROR);
        return true;
    }
}

ShiroConfig.java

// 验证码开关
@Value("${shiro.user.captchaEnabled}")
private boolean captchaEnabled;

// 验证码类型
@Value("${shiro.user.captchaType}")
private String captchaType;

/**
 * 自定义验证码过滤器
 */
@Bean
public CaptchaValidateFilter captchaValidateFilter(){
    CaptchaValidateFilter captchaValidateFilter = new CaptchaValidateFilter();
    captchaValidateFilter.setCaptchaEnabled(captchaEnabled);
    captchaValidateFilter.setCaptchaType(captchaType);
    return captchaValidateFilter;
}

注意:这里不要忘了把自定义的验证码过滤器增加到Shiro过滤器配置中(每个人的配置方式不太相同, 这里就不贴代码了)

登录页面

页面使用的是Thymeleaf,其中captchaType就是上面提到的在application.yml中配置的验证码类型,根据设置的类型去绘制不同的验证码。

<a href="javascript:void(0);" title="点击更换验证码">
	<img th:src="@{captcha/captchaImage(type=${captchaType})}" class="imgcode" width="85%"/>
</a>

点击图片更换验证码的功能也是必不可少的。

$(function() {
	$('.imgcode').click(function() {
		var url = 项目地址 + "captcha/captchaImage?type=" + captchaType + "&s=" + Math.random();
		$(".imgcode").attr("src", url);
	});
});
控制器与相关配置

代码中写了一些注释,这里就不作阐述了,直接上代码。

CaptchaController.java

@Controller
@RequestMapping("/captcha")
public class CaptchaController extends BaseController{

    @Resource(name = "captchaProducer")
    private Producer captchaProducer;

    @Resource(name = "captchaProducerMath")
    private Producer captchaProducerMath;

    /**
     * 验证码生成
     */
    @GetMapping(value = "/captchaImage")
    public ModelAndView getKaptchaImage(HttpServletRequest request, HttpServletResponse response){
    
        ServletOutputStream out = null;
        try{
        
            HttpSession session = request.getSession();
            response.setDateHeader("Expires", 0);
            response.setHeader("Cache-Control", "no-store, no-cache, must-revalidate");
            response.addHeader("Cache-Control", "post-check=0, pre-check=0");
            response.setHeader("Pragma", "no-cache");
            response.setContentType("image/jpeg");

            String type = request.getParameter("type");
            String capStr = null;
            String code = null;
            BufferedImage bi = null;
            if ("math".equals(type)){
                String capText = captchaProducerMath.createText();
                capStr = capText.substring(0, capText.lastIndexOf("@"));
                code = capText.substring(capText.lastIndexOf("@") + 1);
                bi = captchaProducerMath.createImage(capStr);
            }else if ("char".equals(type)){
                capStr = code = captchaProducer.createText();
                bi = captchaProducer.createImage(capStr);
            }
            session.setAttribute(Constants.KAPTCHA_SESSION_KEY, code);
            out = response.getOutputStream();
            ImageIO.write(bi, "jpg", out);
            out.flush();

        }
        catch (Exception e) {
            e.printStackTrace();
        }finally{
            try {
                if (out != null){
                    out.close();
                }
            }
            catch (IOException e){
                e.printStackTrace();
            }
        }
        return null;
    }
}

CaptchaConfig.java

@Configuration
public class CaptchaConfig{

    @Bean(name = "captchaProducer")
    public DefaultKaptcha getKaptchaBean(){
        DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
        Properties properties = new Properties();
        // 是否有边框 默认为true
        properties.setProperty(KAPTCHA_BORDER, "yes");
        // 验证码文本字符颜色 默认为Color.BLACK
        properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_COLOR, "blue");
        // 验证码图片宽度 默认为200
        properties.setProperty(KAPTCHA_IMAGE_WIDTH, "160");
        // 验证码图片高度 默认为50
        properties.setProperty(KAPTCHA_IMAGE_HEIGHT, "60");
        // 验证码文本字符大小 默认为40
        properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_SIZE, "38");
        // KAPTCHA_SESSION_KEY
        properties.setProperty(KAPTCHA_SESSION_CONFIG_KEY, "kaptchaCode");
        // 验证码文本字符长度 默认为5
        properties.setProperty(KAPTCHA_TEXTPRODUCER_CHAR_LENGTH, "4");
        // 验证码文本字体样式 默认为new Font("Arial", 1, fontSize), new Font("Courier", 1, fontSize)
        properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_NAMES, "Arial,Courier");
        // 图片样式 水纹com.google.code.kaptcha.impl.WaterRipple 鱼眼com.google.code.kaptcha.impl.FishEyeGimpy 阴影com.google.code.kaptcha.impl.ShadowGimpy
        properties.setProperty(KAPTCHA_OBSCURIFICATOR_IMPL, "com.google.code.kaptcha.impl.WaterRipple");
        Config config = new Config(properties);
        defaultKaptcha.setConfig(config);
        return defaultKaptcha;
    }

    @Bean(name = "captchaProducerMath")
    public DefaultKaptcha getKaptchaBeanMath(){
        DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
        Properties properties = new Properties();
        // 是否有边框 默认为true
        properties.setProperty(KAPTCHA_BORDER, "yes");
        // 边框颜色 默认为Color.BLACK
        properties.setProperty(KAPTCHA_BORDER_COLOR, "105,179,90");
        // 验证码文本字符颜色 默认为Color.BLACK
        properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_COLOR, "blue");
        // 验证码图片宽度 默认为200
        properties.setProperty(KAPTCHA_IMAGE_WIDTH, "160");
        // 验证码图片高度 默认为50
        properties.setProperty(KAPTCHA_IMAGE_HEIGHT, "60");
        // 验证码文本字符大小 默认为40
        properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_SIZE, "35");
        // KAPTCHA_SESSION_KEY
        properties.setProperty(KAPTCHA_SESSION_CONFIG_KEY, "kaptchaCodeMath");
        // 调用自己的数字加减法验证码文本生成器
        properties.setProperty(KAPTCHA_TEXTPRODUCER_IMPL, "xxx.xxx.xxx.KaptchaTextCreator");
        // 验证码文本字符间距 默认为2
        properties.setProperty(KAPTCHA_TEXTPRODUCER_CHAR_SPACE, "3");
        // 验证码文本字符长度 默认为5
        properties.setProperty(KAPTCHA_TEXTPRODUCER_CHAR_LENGTH, "6");
        // 验证码文本字体样式 默认为new Font("Arial", 1, fontSize), new Font("Courier", 1, fontSize)
        properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_NAMES, "Arial,Courier");
        // 验证码噪点颜色 默认为Color.BLACK
        properties.setProperty(KAPTCHA_NOISE_COLOR, "white");
        // 干扰实现类
        properties.setProperty(KAPTCHA_NOISE_IMPL, "com.google.code.kaptcha.impl.NoNoise");
        // 图片样式 水纹com.google.code.kaptcha.impl.WaterRipple 鱼眼com.google.code.kaptcha.impl.FishEyeGimpy 阴影com.google.code.kaptcha.impl.ShadowGimpy
        properties.setProperty(KAPTCHA_OBSCURIFICATOR_IMPL, "com.google.code.kaptcha.impl.WaterRipple");
        Config config = new Config(properties);
        defaultKaptcha.setConfig(config);
        return defaultKaptcha;
    }
}

KaptchaTextCreator.java(数字加减法验证码文本生成器)

public class KaptchaTextCreator extends DefaultTextCreator{

    private static final String[] CNUMBERS = "0,1,2,3,4,5,6,7,8,9,10".split(",");

    @Override
    public String getText(){
    
        Integer result = 0;
        Random random = new SecureRandom();
        int x = random.nextInt(10);
        int y = random.nextInt(10);
        StringBuilder suChinese = new StringBuilder();
        int randomoperands = (int) Math.round(Math.random() * 2);
        if (randomoperands == 0){
            result = x * y;
            suChinese.append(CNUMBERS[x]);
            suChinese.append("*");
            suChinese.append(CNUMBERS[y]);
        }else if (randomoperands == 1){
            if (!(x == 0) && y % x == 0){
                result = y / x;
                suChinese.append(CNUMBERS[y]);
                suChinese.append("/");
                suChinese.append(CNUMBERS[x]);
            }else{
                result = x + y;
                suChinese.append(CNUMBERS[x]);
                suChinese.append("+");
                suChinese.append(CNUMBERS[y]);
            }
        }else if (randomoperands == 2){
            if (x >= y){
                result = x - y;
                suChinese.append(CNUMBERS[x]);
                suChinese.append("-");
                suChinese.append(CNUMBERS[y]);
            }else{
                result = y - x;
                suChinese.append(CNUMBERS[y]);
                suChinese.append("-");
                suChinese.append(CNUMBERS[x]);
            }
        }else{
            result = x + y;
            suChinese.append(CNUMBERS[x]);
            suChinese.append("+");
            suChinese.append(CNUMBERS[y]);
        }
        suChinese.append("=?@" + result);
        return suChinese.toString();
    }
}

小结

以上是我在开发验证码功能时整理的一些重要代码,借此机会拿出来与大家分享,如果文章中有错误,欢迎大家留言指正;若您有更好、更简便的方式,欢迎您在留言区留下您的意见建议。

后续我也会继续整理在本项目中遇到的比较有代表性的问题,同时也会拿出来跟大家分享。

你在被打击时,记起你的珍贵,抵抗恶意;
你在迷茫时,坚信你的珍贵,抛开蜚语;
爱你所爱 行你所行 听从你心 无问东西

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/qq_39134664/article/details/126903161

spring boot中文文档(官方文档翻译 基于1.5.2.release)-爱代码爱编程

作者:Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Du

spring boot 1.5.2.release中文版_世界,你好的博客-爱代码爱编程

Spring Boot 1.5.2.RELEASE中文版 Part I. Spring Boot 文档 本节简要介绍了Spring Boot文档,是整个文档的参考指南。 您可以完整阅读本参考指南,或者如果您不感兴趣的话可

Spring Boot登录选项快速指南-爱代码爱编程

“我喜欢编写身份验证和授权代码。” 〜从来没有Java开发人员。 厌倦了一次又一次地建立相同的登录屏幕? 尝试使用Okta API进行托管身份验证,授权和多因素身份验证。 在本文中,您将研究使用Spring Boot 2.1实现登录功能的各种选项。 您将从最简单的基本身份验证开始,除了内部后端工具之外,您可能永远不想使用它,然后转到简单的基

Spring Boot全媒体资源库开发——验证码-爱代码爱编程

前言 不少网站为了防止用户利用机器人自动注册、登录、灌水,都采用了验证码技术。所谓验证码,就是将一串随机产生的数字或符号,生成一幅图片,图片里加上一些干扰象素(防止OCR),由用户肉眼识别其中的验证码信息,输入表单提交网站验证,验证成功后才能使用某项功能。所以每一个系统或者网站都离不开验证码,验证码的功能也是很重要的,那么这次与大家分享一下验证码的实现方

spring_Spring Boot登录选项快速指南-爱代码爱编程

spring “我喜欢编写身份验证和授权代码。” 〜从来没有Java开发人员。 厌倦了一次又一次地建立相同的登录屏幕? 尝试使用Okta API进行托管身份验证,授权和多因素身份验证。 在本文中,您将研究使用Spring Boot 2.1实现登录功能的各种选项。 您将从最简单的基本身份验证开始,除了内部后端工具外,您可能永远不想使用

从零开始在腾某云部署Vue、Express、Spring boot项目-爱代码爱编程

写在前 通过本文可以完成选购到部署的整个过程,步骤多,但是简单,按照本文的步骤,只需要复制即可具体一些我在过程中不白的内容,还有一些坑我都会有所提及本人系统Win10 64位选器 学生,买的腾讯云学生机,主要为了部署练习用的博客项目以及后台管理项目具体选择可用以下参考 轻量应用服务器Lighthouse适用于:搭建企业官网/个人博客/论坛社区

Spring Boot 2 入门笔记(尚硅谷)-爱代码爱编程

目录 一、基础入门 1、Spring与Spring boot 1)Spring 生态圈 2)Spring boot 3)Spring boot2 4)SpringBoot优点: 5)缺点 2、时代背景 1)微服务 2)分布式 3)云原生 3、如何学习SpringBoot 1)官方文档 二、SpringBoot2 入门 1、

大聪明教你学java | spring boot全媒体资源库开发——ffmpeg的使用经验与心得_不肯过江东丶的博客-爱代码爱编程

前言 🍊作者简介: 不肯过江东丶,一个来自二线城市的程序员,致力于用“猥琐”办法解决繁琐问题,让复杂的问题变得通俗易懂。🍊支持作者: 点赞👍、关注💖、留言💌~ 前几个月一直在开发一套全媒体资源库管理系统,其中涉及到图片、视频、报纸等相关资料的管理,在开发过程中遇到了很多沟沟坎坎,借此机会记录一下在开发和解决问题的过程中获得的一些心得与体会。

spring boot 3.0.0-m1 reference documentation(spring boot中文参考文档)-附录a-c_dzq584462393的博客-爱代码爱编程

附录 附录A:常用的应用程序属性 多种属性可以指定到application.properties文件,application.yml文件内,或者作为命令行开关。这个附录提供常用的Spring Boot属性列表以及对使用他们底层类的引用。 Spring Boot提供多种高级格式化的转化机制,请务必查看属性转换部分。 属性贡献可以来自于

(附源码)spring boot小说网站系统 毕业设计 041446_dzbishe的博客-爱代码爱编程

Springboot小说网站系统的设计与实现 摘 要 大数据时代下,数据呈爆炸式地增长。为了迎合信息化时代的潮流和信息化安全的要求,利用互联网服务于其他行业,促进生产,已经是成为一种势不可挡的趋势。在网络小说的要求下,开发一款整体式结构的小说网站,将复杂的系统进行拆分,能够实现对需求的变化快速响应、系统稳定性的保障,能保证平台可持续、规模化发

尚硅谷springboot 2核心技术学习笔记_尚硅谷springboot2笔记-爱代码爱编程

开发前先查看系统Java和maven的版本 参考资料 1、尚硅谷/SpringBoot2核心技术与响应式编程 2、springboot官网 3、版本升级变化 maven环境配置 <mirrors>

spring boot 总结_if (thisapplication.canuseglobaldelete() == false)-爱代码爱编程

title: Spring Boot 总结 date: 2022-06-14 02:56:36 tags: Spring categories:Spring cover: https://cover.png featu

spring boot 3.0.0-爱代码爱编程

9. 数据 Spring Boot与多个数据技术集成,包括SQL和NoSQL。 9.1. SQL数据库 Spring Framework提供扩展支持用于与SQL数据工作,从使用JdbcTemplate直接JDBC访问到

【spring boot官方文档原文理解翻译-爱代码爱编程

【Spring Boot官方文档原文理解翻译-持续更新中】 文章目录 【Spring Boot官方文档原文理解翻译-持续更新中】Chapter 4. Getting Started4.1. Introduci