SpringMVC 生成验证码

女爷i 2022-06-08 08:10 275阅读 0赞

*   *  添加依赖
     *  配置文件中添加验证码生成器Bean
     *  页面添加验证码图片和输入框
     *  页面添加刷新验证码
     *  后台添加生成验证码
     *  登录时校验验证码
     *  Base64加密

> 使用 Google kaptcha 为 SpringMVC Maven 项目生成验证码

## 1 添加依赖 ##

<dependency>
                <groupId>com.github.penggle</groupId>
                <artifactId>kaptcha</artifactId>
                <version>2.3.2</version>
            </dependency>

## 2 配置文件中添加验证码生成器Bean ##

<bean id="captchaProducer" class="com.google.code.kaptcha.impl.DefaultKaptcha">
            <property name="config">
                <bean class="com.google.code.kaptcha.util.Config">
                    <constructor-arg>
                        <props>
                            <prop key="kaptcha.border">no</prop>
                            <prop key="kaptcha.image.width">120</prop>
                            <prop key="kaptcha.session.key">code</prop>
                            <prop key="kaptcha.textproducer.font.color">blue</prop>
                            <prop key="kaptcha.textproducer.font.size">40</prop>
                            <prop key="kaptcha.textproducer.char.length">4</prop>
                        </props>
                    </constructor-arg>
                </bean>
            </property>
        </bean>

*  配置项

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>作用</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>kaptcha.border</td> 
   <td>是否有边框</td> 
   <td>默认为true 我们可以自己设置yes，no</td> 
  </tr> 
  <tr> 
   <td>kaptcha.border.color</td> 
   <td>边框颜色</td> 
   <td>默认为Color.BLACK</td> 
  </tr> 
  <tr> 
   <td>kaptcha.border.thickness</td> 
   <td>边框粗细度</td> 
   <td>默认为1</td> 
  </tr> 
  <tr> 
   <td>kaptcha.producer.impl</td> 
   <td>验证码生成器</td> 
   <td>默认为DefaultKaptcha</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.impl</td> 
   <td>验证码文本生成器</td> 
   <td>默认为DefaultTextCreator</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.char.string</td> 
   <td>验证码文本字符内容范围</td> 
   <td>默认为abcde2345678gfynmnpwx</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.char.length</td> 
   <td>验证码文本字符长度</td> 
   <td>默认为5</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.font.names</td> 
   <td>验证码文本字体样式</td> 
   <td>默认为new Font(“Arial”, 1, fontSize), new Font(“Courier”, 1, fontSize)</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.font.size</td> 
   <td>验证码文本字符大小</td> 
   <td>默认为40</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.font.color</td> 
   <td>验证码文本字符颜色</td> 
   <td>默认为Color.BLACK</td> 
  </tr> 
  <tr> 
   <td>kaptcha.textproducer.char.space</td> 
   <td>验证码文本字符间距</td> 
   <td>默认为2</td> 
  </tr> 
  <tr> 
   <td>kaptcha.noise.impl</td> 
   <td>验证码噪点生成对象</td> 
   <td>默认为DefaultNoise</td> 
  </tr> 
  <tr> 
   <td>kaptcha.noise.color</td> 
   <td>验证码噪点颜色</td> 
   <td>默认为Color.BLACK</td> 
  </tr> 
  <tr> 
   <td>kaptcha.obscurificator.impl</td> 
   <td>验证码样式引擎</td> 
   <td>默认为WaterRipple</td> 
  </tr> 
  <tr> 
   <td>kaptcha.word.impl</td> 
   <td>验证码文本字符渲染</td> 
   <td>默认为DefaultWordRenderer</td> 
  </tr> 
  <tr> 
   <td>kaptcha.background.impl</td> 
   <td>验证码背景生成器</td> 
   <td>默认为DefaultBackground</td> 
  </tr> 
  <tr> 
   <td>kaptcha.background.clear.from</td> 
   <td>验证码背景颜色渐进</td> 
   <td>默认为Color.LIGHT_GRAY</td> 
  </tr> 
  <tr> 
   <td>kaptcha.background.clear.to</td> 
   <td>验证码背景颜色渐进</td> 
   <td>默认为Color.WHITE</td> 
  </tr> 
  <tr> 
   <td>kaptcha.image.width</td> 
   <td>验证码图片宽度</td> 
   <td>默认为200</td> 
  </tr> 
  <tr> 
   <td>kaptcha.image.height</td> 
   <td>验证码图片高度</td> 
   <td>默认为50</td> 
  </tr> 
 </tbody> 
</table>

## 3 页面添加验证码图片和输入框 ##

## 4 页面添加刷新验证码 ##

// 加载验证码
        function loadValidateCode() { 
            var time = new Date().getTime();
            $("#validateCodeImage").attr('src', './loadValidateCode')
        }

## 5 后台添加生成验证码 ##

*  导入包

import com.google.code.kaptcha.Producer;

*  生成方法

@Autowired
        private Producer captchaProducer;
    
        private final String VALIDATE_CODE = "VALIDATE_CODE";
    
        private final String EXPIRE_TIME = "EXPIRE_TIME";
    
        @RequestMapping(value = "/loadValidateCode", method = RequestMethod.GET)
        public void loadValidateCode(HttpServletRequest request, HttpServletResponse response) {
            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/png");
    
                // 验证码一分钟内有效
                long expireTime = System.currentTimeMillis() + 60000;
    
                // 将验证码放到session中
                String validateCode = captchaProducer.createText();
                session.setAttribute(VALIDATE_CODE, Utils.encodeBase64(validateCode));//将加密后的验证码放到session中，确保安全
                session.setAttribute(EXPIRE_TIME, expireTime);
    
                // 输出验证码图片
                BufferedImage bufferedImage = captchaProducer.createImage(validateCode);
                ServletOutputStream out = response.getOutputStream();
                ImageIO.write(bufferedImage, "png", out);
                out.flush();
                out.close();
    
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

## 6 登录时校验验证码 ##

@RequestMapping(value = "/login", method = RequestMethod.POST)
        public @ResponseBody String login(String username, String password, String validateCode) {
    
            // 校验验证码是否有效
            String currentValidateCode = String.valueOf(request.getSession().getAttribute(VALIDATE_CODE));
            if (System.currentTimeMillis() > Long.parseLong(String.valueOf(request.getSession().getAttribute(EXPIRE_TIME)))) {
                return JSON.toJSONString("验证码已过期，请重试");
            }
    
            // 校验验证码
            String currentValidateCode = String.valueOf(request.getSession().getAttribute(VALIDATE_CODE));
            if (StringUtils.isEmpty(validateCode) || validateCode.length() != 4 ||
                    !Utils.encodeBase64(validateCode).equals(currentValidateCode)) {
                return JSON.toJSONString("验证码错误");
            }
     }

## 7 Base64加密 ##

public static String encodeBase64(String str) {
            sun.misc.BASE64Encoder base64Encode = new BASE64Encoder();
            return base64Encode.encode(str.getBytes());
        }