SpringBoot使用Kaptcha實現驗證碼的生成與驗證功能

2023-09-06 14:02:24

當我們在專案中登入使用驗證碼的時候，不妨試試Kaptcha生成驗證碼，非常簡單

1、首先，我們在pom.xml檔案中引入kaptcha的maven依賴

<!-- kaptcha驗證碼 -->
<dependency>
	<groupId>com.github.penggle</groupId>
	<artifactId>kaptcha</artifactId>
	<version>2.3.2</version>
</dependency>

2、然後，我們編寫kaptcha的設定類：KaptchaConfig.java

package com.lzzy.meet.common.kaptcha;
 
import com.google.code.kaptcha.impl.DefaultKaptcha;
import com.google.code.kaptcha.util.Config;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import java.util.Properties;
 
/**
 * @ClassName KaptchaConfig
 * kaptcha設定類
 * @Author 
 * @Date 2019-09-05 13:50:50
 * @Version 1.0
 **/
@Slf4j
@Component
public class KaptchaConfig {
 
    @Bean
    public DefaultKaptcha getKaptcheCode() {
        DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
        Properties properties = new Properties();
        properties.setProperty("kaptcha.border", "no");
        properties.setProperty("kaptcha.textproducer.font.color", "black");
        properties.setProperty("kaptcha.image.width", "100");
        properties.setProperty("kaptcha.image.height", "36");
        properties.setProperty("kaptcha.textproducer.font.size", "30");
        properties.setProperty("kaptcha.obscurificator.impl", "com.google.code.kaptcha.impl.ShadowGimpy");
        properties.setProperty("kaptcha.session.key", "code");
        properties.setProperty("kaptcha.noise.impl", "com.google.code.kaptcha.impl.NoNoise");
        properties.setProperty("kaptcha.background.clear.from", "232,240,254");
        properties.setProperty("kaptcha.background.clear.to", "232,240,254");
        properties.setProperty("kaptcha.textproducer.char.length", "4");
        properties.setProperty("kaptcha.textproducer.font.names", "彩雲,宋體,楷體,微軟雅黑");
        Config config = new Config(properties);
        defaultKaptcha.setConfig(config);
        return defaultKaptcha;
    }
}

3、接下來，我們編寫kaptcha的控制層：KaptchaController.java

package com.lzzy.meet.common.kaptcha;
 
import com.google.code.kaptcha.Constants;
import com.google.code.kaptcha.Producer;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.imageio.ImageIO;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.awt.image.BufferedImage;
 
/**
 * @ClassName KaptchaController
 * kaptcha呼叫
 * @Author 
 * @Date 2019-09-05 13:59:59
 * @Version 1.0
 **/
@Slf4j
@Controller
@RequestMapping("kaptcha")
public class KaptchaController {
 
    @Autowired
    private Producer producer;
 
    @GetMapping("kaptcha-image")
    public void getKaptchaImage(HttpServletRequest request, HttpServletResponse response) throws Exception {
        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 capText = producer.createText();
        log.info("******************當前驗證碼為：{}******************", capText);
        // 將驗證碼存於session中
        request.getSession().setAttribute(Constants.KAPTCHA_SESSION_KEY, capText);
        BufferedImage bi = producer.createImage(capText);
        ServletOutputStream out = response.getOutputStream();
        // 向頁面輸出驗證碼
        ImageIO.write(bi, "jpg", out);
        try {
        	// 清空快取區
            out.flush();
        } finally {
        	// 關閉輸出流
            out.close();
        }
    }
}

4、然後，我們就可以在前端呼叫katpcha的介面生成驗證碼了：

<img th:src="@{/kaptcha/kaptcha-image}" class="ver_btn" onclick="this.src=this.src+'?c='+Math.random();"/>

由於我這裡使用的是 thymeleaf 模板引擎，所以路徑名稱會有點奇怪，生成的驗證碼樣式如圖所示：

5、最後，我們將使用者在使用者端登陸時輸入的驗證碼傳送到伺服器端進行驗證：

/**
	 * 驗證驗證碼
	 * @param
	 * @return 正確:true/錯誤:false
	 */
	public static boolean validate(String registerCode) {
		// 獲取Session中驗證碼
		Object captcha = ServletUtils.getAttribute(Constants.KAPTCHA_SESSION_KEY);
		// 判斷驗證碼是否為空
		if (StringUtils.isEmpty(registerCode)) {
			return false;
		}
		// 校驗驗證碼的正確與否
		boolean result = registerCode.equalsIgnoreCase(captcha.toString());
		if (result) {
			// 正確了後，將驗證碼從session中刪掉
			ServletUtils.getRequest().getSession().removeAttribute(Constants.KAPTCHA_SESSION_KEY);
		}
		// 返回驗證結果
		return result;
	}

這樣我們就成功的使用kaptcha完成了驗證碼的生成與驗證功能

到此這篇關於SpringBoot使用Kaptcha實現驗證碼的文章就介紹到這了,更多相關SpringBoot Kaptcha 驗證碼內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

SpringBoot使用Kaptcha實現驗證碼的生成與驗證功能

熱門文章