首页 > 编程学习 > spring-security入门10---图形验证码(三)----重构【验证码拦截的接口可配置】

文章目录

  • 1. 重构内容和逻辑介绍
  • 2. 代码开发
    • 2.1 图形验证码相关参数类中加入一个字段用来接收urls
    • 2.2 在Filter中拿到配置的需拦截的所有url和请求的uri,如满足则拦截
    • 2.3 在配置类中传入securityProperties,并调用afterPropertiesSet方法进行urls的初始化
    • 2.4 yml配置文件中指定拦截的url
  • 3. 测试

项目源码地址 https://github.com/nieandsun/security

1. 重构内容和逻辑介绍

本篇文章是在上篇文章的基础上对图形验证码功能继续进行代码重构,重构内容为:

  • 验证码拦截的接口可配置

需要做的具体工作

  • 在图形验证码相关参数类中加入一个urls,用来接收在yml中配置的进行图形验证码拦截的所有URL
  • 在图形验证码校验Filter里取到所有要拦截的url
  • 将请求的uri与取到的urls进行比对,如果请求的uri是配置的urls中的一个,则进行图形验证码的校验

注意 为了进行区分我管配置的路径叫urls或url,管请求中获取的uri称作uri,其实前面的url叫法应该不对,希望大家不要计较。

2. 代码开发

2.1 图形验证码相关参数类中加入一个字段用来接收urls

package com.nrsc.security.core.properties;
import lombok.Data;
/**
 * Created By: Sun Chuan
 * Created Date: 2019/7/6 16:50
 */
@Data
public class ImageCodeProperties {
    /**验证码的宽度*/
    private int width = 67;
    /**验证码的高度*/
    private int height = 23;
    /**验证码的位数*/
    private int length = 4;
    /**验证码过期时间*/
    private int expireIn = 60;

    /**需要进行图形验证码校验的所有URL,需以逗号分隔开*/
    private String urls;
}

2.2 在Filter中拿到配置的需拦截的所有url和请求的uri,如满足则拦截

package com.nrsc.security.core.validate.code;


import com.nrsc.security.core.properties.SecurityProperties;
import lombok.Data;
import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.security.web.authentication.AuthenticationFailureHandler;
import org.springframework.social.connect.web.HttpSessionSessionStrategy;
import org.springframework.social.connect.web.SessionStrategy;
import org.springframework.util.AntPathMatcher;
import org.springframework.web.bind.ServletRequestBindingException;
import org.springframework.web.bind.ServletRequestUtils;
import org.springframework.web.context.request.ServletWebRequest;
import org.springframework.web.filter.OncePerRequestFilter;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;

/**
 * Created By: Sun Chuan
 * Created Date: 2019/7/4 22:05
 * Description:继承InitializingBean并实现其afterPropertiesSet的作用是,
 * 在当前bean的其他参数都组装完成后,调用afterPropertiesSet初始化下面的urls变量
 */
@Data
public class ValidateCodeFilter extends OncePerRequestFilter implements InitializingBean {
    private AuthenticationFailureHandler authenticationFailureHandler;
    private SessionStrategy sessionStrategy = new HttpSessionSessionStrategy();
    //----------------------------下篇文章将研究一下InitializingBean接口----------------------------------
    /**
     * 用来存配置文件中指定的需要进行图形验证码校验的所有URL
     *
     * 这里将所有的url弄成了本类的一个属性,其实还有其他方式,比如说我们只把SecurityProperties设置到本类中
     * 然后每次请求过来时,都做一次字符串切割和uri匹配
     * 但是相比之下这种方式是更好的
     */
    //----------------------------下篇文章将研究一下InitializingBean接口----------------------------------
    private Set<String> urls = new HashSet<>();

    /**拿到配置类*/
    private SecurityProperties securityProperties;

    /**spring提供的匹配uri的工具类,可匹配正则*/
    private AntPathMatcher pathMatcher = new AntPathMatcher();

    @Override
    public void afterPropertiesSet() throws ServletException {
        super.afterPropertiesSet();
        //取出配置文件中的url,并用“,”进行分割
        String[] configUrls = StringUtils.splitByWholeSeparatorPreserveAllTokens(securityProperties.getCode().getImage().getUrls(), ",");
        //将配置文件中配置的所有url加到urls属性中
        if (ArrayUtils.isNotEmpty(configUrls)) {
            for (String configUrl : configUrls) {
                urls.add(configUrl);
            }
        }
        //登陆肯定要进行图形验证码的校验,所以这里直接把登陆的uri放到urls里
        urls.add("/nrsc/signIn");
    }


    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        boolean action = false;
        //只要请求的uri是配置的urls中的一个,则说明该请求需要进行图形验证码校验
        //因为uri中可能会包含参数,所以不能简单的用StringUtils.equalsIgnoreCase方法进行比较
        //spring提供的工具类AntPathMatcher可以对uri进行正则匹配,所以这里使用了该工具类
        for (String url : urls) {
            if (pathMatcher.match(url, request.getRequestURI())) {
                action = true;
                break;
            }
        }
        if (action) {
            try {
                //对输入的图形验证码进行校验
                validate(new ServletWebRequest(request));
            } catch (ValidateCodeException e) {
                //认证失败调用之前写的认证失败的逻辑
                authenticationFailureHandler.onAuthenticationFailure(request, response, e);
                return;
            }

        }
        //走到这里说明已经校验成功,对请求放行
        filterChain.doFilter(request, response);
    }

    /**
     * 对输入的图形验证码的校验逻辑
     *
     * @param request
     * @throws ServletRequestBindingException
     */
    private void validate(ServletWebRequest request) throws ServletRequestBindingException {
        //1.从session中取出ImageCode对象
        ImageCode codeInSession = (ImageCode) sessionStrategy.getAttribute(request,
                ValidateCodeController.SESSION_KEY);
        //2.获取请求中传过来的图形验证码字符串
        String codeInRequest = ServletRequestUtils.getStringParameter(request.getRequest(), "imageCode");

        //3.判断传过来的图形验证码字符串和session中存的是否相同
        if (StringUtils.isBlank(codeInRequest)) {
            throw new ValidateCodeException("验证码的值不能为空");
        }

        if (codeInSession == null) {
            throw new ValidateCodeException("验证码不存在");
        }

        if (codeInSession.isExpried()) {
            sessionStrategy.removeAttribute(request, ValidateCodeController.SESSION_KEY);
            throw new ValidateCodeException("验证码已过期");
        }

        if (!StringUtils.equals(codeInSession.getCode(), codeInRequest)) {
            throw new ValidateCodeException("验证码不匹配");
        }
        //4.走到这里说明校验已经通过,校验通过后该验证码就没啥用了,所以可以删除session中的ImageCode对象了
        sessionStrategy.removeAttribute(request, ValidateCodeController.SESSION_KEY);
    }
}

2.3 在配置类中传入securityProperties,并调用afterPropertiesSet方法进行urls的初始化

  • 下面配置类中的具体代码可下载源码进行查看https://github.com/nieandsun/security
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        ValidateCodeFilter validateCodeFilter = new ValidateCodeFilter();
        validateCodeFilter.setAuthenticationFailureHandler(NRSCAuthenticationFailureHandler);
        validateCodeFilter.setSecurityProperties(securityProperties);
        //调用afterPropertiesSet,初始化urls
        validateCodeFilter.afterPropertiesSet();

        //将图形验证码的校验逻辑放在用户名和密码校验逻辑之前
        http.addFilterBefore(validateCodeFilter, UsernamePasswordAuthenticationFilter.class)

2.4 yml配置文件中指定拦截的url

nrsc:
  security:
    code:
      image:
        length: 6 #图形验证码的位数为6,将覆盖默认配置中的4
        width: 100 #图形验证码的宽度为100,将覆盖默认配置中的67,但由于请求中设置的宽度为200,所以真正的宽度将为200
        urls: /hello,/me*

3. 测试

  • 输入正确密码+验证码可登陆成功—》即session中已经存在用户信息

在这里插入图片描述

  • 但此时请求localhost:8080/hello或者localhost:8080/me1、me2、me3,返回的结构都是下面的样子,验证码拦截的接口可配置 功能已经开发成功

在这里插入图片描述

  • 还可以进行其他测试,如配置中只有/me*,则登陆成功后访问localhost:8080/hello可以访问到,但是访问localhost:8080/me1、me2、me3还是会出现上图的样子,这更一步表明了 验证码拦截的接口可配置 功能已经开发成功
Copyright © 2010-2022 ngui.cc 版权所有 |关于我们| 联系方式| 豫B2-20100000