springboot整合kaptcha驗(yàn)證碼

轉(zhuǎn)載自:http://www.reibang.com/p/1f2f7c47e812

前言:

關(guān)于kaptcha簡(jiǎn)介以及spring整合kaptcha以及在Linux上驗(yàn)證碼顯示亂碼問題油讯,我在另一篇文章中已詳細(xì)講解,請(qǐng)參考:spring整合kaptcha驗(yàn)證碼延欠。
本文將介紹springboot整合kaptcha的兩種方式陌兑。點(diǎn) 下載源碼。

本文將介紹springboot整合kaptcha的兩種方式由捎。點(diǎn) 下載源碼兔综。

開發(fā)工具及技術(shù):

1、idea 2017
2狞玛、springboot 2.0.2
3软驰、kaptcha

正式開始:

方式一:通過kaptcha.xml配置

1、用idea新建一個(gè)spring Initializr
2心肪、添加kaptcha的依賴:

<!-- kaptcha驗(yàn)證碼 -->
        <dependency>
        <groupId>com.github.penggle</groupId>
            <artifactId>kaptcha</artifactId>
            <version>2.3.2</version>
        </dependency>

3锭亏、在resources下面新建kaptcha.xml,內(nèi)容如下:
kaptcha.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    <!-- 生成kaptcha的bean-->
    <bean id="captchaProducer" class="com.google.code.kaptcha.impl.DefaultKaptcha">
        <property name="config">
            <bean class="com.google.code.kaptcha.util.Config">
                <constructor-arg type="java.util.Properties">
                    <!--設(shè)置kaptcha屬性 -->
                    <props>
                        <prop key = "kaptcha.border ">yes</prop>
                        <prop key="kaptcha.border.color">105,179,90</prop>
                        <prop key="kaptcha.textproducer.font.color">blue</prop>
                        <prop key="kaptcha.image.width">100</prop>
                        <prop key="kaptcha.image.height">50</prop>
                        <prop key="kaptcha.textproducer.font.size">27</prop>
                        <prop key="kaptcha.session.key">code</prop>
                        <prop key="kaptcha.textproducer.char.length">4</prop>
                        <prop key="kaptcha.textproducer.font.names">宋體,楷體,微軟雅黑</prop>
                        <prop key="kaptcha.textproducer.char.string">0123456789ABCEFGHIJKLMNOPQRSTUVWXYZ</prop>
                        <prop key="kaptcha.obscurificator.impl">com.google.code.kaptcha.impl.WaterRipple</prop>
                        <prop key="kaptcha.noise.color">black</prop>
                        <prop key="kaptcha.noise.impl">com.google.code.kaptcha.impl.DefaultNoise</prop>
                        <prop key="kaptcha.background.clear.from">185,56,213</prop>
                        <prop key="kaptcha.background.clear.to">white</prop>
                        <prop key="kaptcha.textproducer.char.space">3</prop>
                    </props>
                </constructor-arg>
            </bean>
        </property>
    </bean>
</beans>

注:kaptcha.xml中的內(nèi)容其實(shí)就是和spring 整合kaptcha時(shí)spring-kaptcha.xml中內(nèi)容一樣硬鞍,就是將kaptcha交給spring容器管理慧瘤,設(shè)置一些屬性,然后要用的時(shí)候直接注入即可固该。

4锅减、加載kaptcha.xml:
在springboot啟動(dòng)類上加上@ImportResource(locations = {"classpath:kaptcha/kaptcha.xml"}),加了這個(gè)注解伐坏,springboot就會(huì)去加載kaptcha.xml文件上煤。注意kaptcha.xml的路徑不要寫錯(cuò),classpath在此處是resources目錄著淆。

5劫狠、編寫controller用于生成驗(yàn)證碼:
CodeController.java

@Controller
public class CodeController {
    @Autowired
    private Producer captchaProducer = null;
    @RequestMapping("/kaptcha")
    public void getKaptchaImage(HttpServletRequest request, HttpServletResponse response) throws Exception {
        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");
        //生成驗(yàn)證碼
        String capText = captchaProducer.createText();
        session.setAttribute(Constants.KAPTCHA_SESSION_KEY, capText);
        //向客戶端寫出
        BufferedImage bi = captchaProducer.createImage(capText);
        ServletOutputStream out = response.getOutputStream();
        ImageIO.write(bi, "jpg", out);
        try {
            out.flush();
        } finally {
            out.close();
        }
    }
}

注:在這個(gè)controller徑注入剛剛kaptcha.xml中配置的那個(gè)bean,然后就可以使用它生成驗(yàn)證碼永部,以及向客戶端輸出驗(yàn)證碼;記住這個(gè)類的路由媳荒,前端頁(yè)面驗(yàn)證碼的src需要指向這個(gè)路由。

6屈溉、新建驗(yàn)證碼比對(duì)工具類:
CodeUtil.java

public class CodeUtil {
    /**
     * 將獲取到的前端參數(shù)轉(zhuǎn)為string類型
     * @param request
     * @param key
     * @return
     */
    public static String getString(HttpServletRequest request, String key) {
        try {
            String result = request.getParameter(key);
            if(result != null) {
                result = result.trim();
            }
            if("".equals(result)) {
                result = null;
            }
            return result;
        }catch(Exception e) {
            return null;
        }
    }
    /**
     * 驗(yàn)證碼校驗(yàn)
     * @param request
     * @return
     */
    public static boolean checkVerifyCode(HttpServletRequest request) {
        //獲取生成的驗(yàn)證碼
        String verifyCodeExpected = (String) request.getSession().getAttribute(com.google.code.kaptcha.Constants.KAPTCHA_SESSION_KEY);
        //獲取用戶輸入的驗(yàn)證碼
        String verifyCodeActual = CodeUtil.getString(request, "verifyCodeActual");
        if(verifyCodeActual == null ||!verifyCodeActual.equals(verifyCodeExpected)) {
            return false;
        }
        return true;
    }
}

注:這個(gè)類用來(lái)比對(duì)生成的驗(yàn)證碼與用戶輸入的驗(yàn)證碼亡呵。生成的驗(yàn)證碼會(huì)自動(dòng)加到session中,用戶輸入的通過getParameter獲得组橄。注意getParameterkey值要與頁(yè)面中驗(yàn)證碼的name值一致荞膘。

7、使用驗(yàn)證碼:
①Controller
HelloWorld.java

@RestController
public class HelloWorld {
    @RequestMapping("/hello")
    public String hello(HttpServletRequest request) {
        if (!CodeUtil.checkVerifyCode(request)) {
            return "驗(yàn)證碼有誤玉工!";
        } else {
            return "hello,world";
        }
    }
}

②頁(yè)面
hello.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script type="text/javascript">
        function refresh() {
            document.getElementById('captcha_img').src="/kaptcha?"+Math.random();
        }
    </script>
</head>
<body>
<form action="/hello" method="post">
    驗(yàn)證碼:  <input type="text" placeholder="請(qǐng)輸入驗(yàn)證碼" name="verifyCodeActual">
    <div class="item-input">
        <img id="captcha_img" alt="點(diǎn)擊更換" title="點(diǎn)擊更換"
             onclick="refresh()" src="/kaptcha" />
    </div>
    <input type="submit" value="提交" />
</form>

</body>
</html>

注意:驗(yàn)證碼本質(zhì)是一張圖片羽资,所以用<img >標(biāo)簽,然后通過src = "/kaptcha"指向生成驗(yàn)證碼的那個(gè)controller的路由即可;通過onclick = “refresh()”調(diào)用js代碼實(shí)現(xiàn)點(diǎn)擊切換功能;<input name = "verifyCodeActual ">中要注意name的值遵班,在CodeUtil中通過request的getParameter()方法獲取用戶輸入的驗(yàn)證碼時(shí)傳入的key值就應(yīng)該和這里的name值一致屠升。

8潮改、測(cè)試:
輸入正確的驗(yàn)證碼

image

驗(yàn)證通過

image

輸入錯(cuò)誤的驗(yàn)證碼

image

驗(yàn)證未通過

image

方式二:通過配置類來(lái)配置kaptcha

1、配置kaptcha
相比于方式一腹暖,一增二減汇在。
減:
把kaptcha.xml刪掉
把啟動(dòng)類上的@ImportResource(locations = {"classpath:kaptcha/kaptcha.xml"})注解刪掉

增:
新建KaptchaConfig配置類,內(nèi)容如下:
KaptchaConfig.java

@Configuration
public class KaptchaConfig {
    @Bean
    public DefaultKaptcha getDefaultKaptcha(){
        DefaultKaptcha captchaProducer = new DefaultKaptcha();
        Properties properties = new Properties();
        properties.setProperty("kaptcha.border", "yes");
        properties.setProperty("kaptcha.border.color", "105,179,90");
        properties.setProperty("kaptcha.textproducer.font.color", "blue");
        properties.setProperty("kaptcha.image.width", "110");
        properties.setProperty("kaptcha.image.height", "40");
        properties.setProperty("kaptcha.textproducer.font.size", "30");
        properties.setProperty("kaptcha.session.key", "code");
        properties.setProperty("kaptcha.textproducer.char.length", "4");
        properties.setProperty("kaptcha.textproducer.font.names", "宋體,楷體,微軟雅黑");
        Config config = new Config(properties);
        captchaProducer.setConfig(config);
        return captchaProducer;

    }
}

注:這個(gè)類用來(lái)配置Kaptcha脏答,就相當(dāng)于方式一的kaptcha.xml糕殉,把kaptcha加入IOC容器,然后return 回一個(gè)設(shè)置好屬性的實(shí)例殖告,最后注入到CodeController中阿蝶,在CodeController中就可以使用它生成驗(yàn)證碼。要特別注意return captchaProducer;private Producer captchaProducer = null;captchaProducer名字要一樣丛肮,不然就加載不到這個(gè)bean赡磅。

2、測(cè)試:
輸入正確的驗(yàn)證碼:

image

驗(yàn)證通過

image

輸入錯(cuò)誤的驗(yàn)證碼

image

驗(yàn)證未通過

image

為了說明兩次的驗(yàn)證碼是基于兩種方式生成的宝与,方式一和方式二的驗(yàn)證碼我設(shè)置了不同的屬性焚廊,從圖片中可以看出兩次驗(yàn)證碼的顏色、干擾線习劫、背景等都有不同咆瘟。

總結(jié):

1、過程梳理:
不論是哪種方式诽里,都是把kaptcha加入spring容器袒餐,即要有一個(gè)kaptcha的bean;新建一個(gè)controller,把kaptcha的bean注入到controller中用于生成驗(yàn)證碼;然后需要有一個(gè)比對(duì)驗(yàn)證碼的工具類谤狡,在測(cè)試的controller中調(diào)用工具類進(jìn)行驗(yàn)證碼比對(duì);最后在前端頁(yè)面只需要用一個(gè)<img src = "/生成驗(yàn)證碼的controller的路由">即可獲取驗(yàn)證碼灸眼,通過給這個(gè)img標(biāo)簽加點(diǎn)擊事件就可實(shí)現(xiàn)“點(diǎn)擊切換驗(yàn)證碼”。

2墓懂、與spring整合kaptcha對(duì)比
spring整合kaptcha也介紹了兩種方式焰宣,在web.xml中配置最簡(jiǎn)潔,不需要寫生成驗(yàn)證碼的controller捕仔,在頁(yè)面中直接用src指向web.xml中kaptcha的servlet 的<url-pattern >的值即可匕积。
springboot整合kaptcha的兩種方式都類似于spring整合kaptcha的第二種方式,都是先配置bean榜跌,然后用controller生成驗(yàn)證碼闪唆,前端用src指向這個(gè)controller,不同之處在于:假如生成驗(yàn)證碼的controller路由為/xxx钓葫,那么spring 整合kaptcha時(shí)src = “xxx.jpg”悄蕾,springboot整合kaptcha時(shí)src = "/xxx"

作者:貪挽懶月
鏈接:http://www.reibang.com/p/1f2f7c47e812
來(lái)源:簡(jiǎn)書
簡(jiǎn)書著作權(quán)歸作者所有瓤逼,任何形式的轉(zhuǎn)載都請(qǐng)聯(lián)系作者獲得授權(quán)并注明出處笼吟。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末库物,一起剝皮案震驚了整個(gè)濱河市霸旗,隨后出現(xiàn)的幾起案子贷帮,更是在濱河造成了極大的恐慌,老刑警劉巖诱告,帶你破解...
    沈念sama閱讀 217,734評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件撵枢,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡精居,警方通過查閱死者的電腦和手機(jī)锄禽,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,931評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)靴姿,“玉大人沃但,你說我怎么就攤上這事》鹣牛” “怎么了宵晚?”我有些...
    開封第一講書人閱讀 164,133評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)维雇。 經(jīng)常有香客問我淤刃,道長(zhǎng),這世上最難降的妖魔是什么吱型? 我笑而不...
    開封第一講書人閱讀 58,532評(píng)論 1 293
  • 正文 為了忘掉前任逸贾,我火速辦了婚禮,結(jié)果婚禮上津滞,老公的妹妹穿的比我還像新娘铝侵。我一直安慰自己,他們只是感情好触徐,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,585評(píng)論 6 392
  • 文/花漫 我一把揭開白布咪鲜。 她就那樣靜靜地躺著,像睡著了一般锌介。 火紅的嫁衣襯著肌膚如雪嗜诀。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,462評(píng)論 1 302
  • 那天孔祸,我揣著相機(jī)與錄音隆敢,去河邊找鬼。 笑死崔慧,一個(gè)胖子當(dāng)著我的面吹牛拂蝎,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播惶室,決...
    沈念sama閱讀 40,262評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼温自,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼玄货!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起悼泌,我...
    開封第一講書人閱讀 39,153評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤松捉,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后馆里,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體隘世,經(jīng)...
    沈念sama閱讀 45,587評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,792評(píng)論 3 336
  • 正文 我和宋清朗相戀三年鸠踪,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了丙者。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,919評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡营密,死狀恐怖械媒,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情评汰,我是刑警寧澤纷捞,帶...
    沈念sama閱讀 35,635評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站键俱,受9級(jí)特大地震影響兰绣,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜编振,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,237評(píng)論 3 329
  • 文/蒙蒙 一缀辩、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧踪央,春花似錦臀玄、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,855評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至液斜,卻和暖如春累贤,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背少漆。 一陣腳步聲響...
    開封第一講書人閱讀 32,983評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工臼膏, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人示损。 一個(gè)月前我還...
    沈念sama閱讀 48,048評(píng)論 3 370
  • 正文 我出身青樓渗磅,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子始鱼,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,864評(píng)論 2 354