基于OAuth2.0授權(quán)系統(tǒng)的驗(yàn)證碼功能的實(shí)現(xiàn)

更新時(shí)間：2021年05月24日 14:44:36 作者：hanxiaozhang2018

本篇教程給大家分享基于OAuth2.0授權(quán)系統(tǒng)的驗(yàn)證碼功能的實(shí)現(xiàn)，驗(yàn)證碼功能的實(shí)現(xiàn)是采用Zuul網(wǎng)關(guān)的Filter過(guò)濾器進(jìn)行校驗(yàn)驗(yàn)證碼，具體實(shí)現(xiàn)代碼跟隨小編一起看看吧

前言：

前一陣子，我自己一直在寫(xiě)一套后臺(tái)管理系統(tǒng)《hanxiaozhang 后臺(tái)管理系統(tǒng)》，后臺(tái)技術(shù)棧基于SpringCloud組件實(shí)現(xiàn)的，授權(quán)則是使用的OAuth2.0。為了讓系統(tǒng)的功能更加健全，我在系統(tǒng)內(nèi)添加了驗(yàn)證碼功能，具體實(shí)現(xiàn)如下：

正文：

我這套系統(tǒng)授權(quán)基于OAuth2.0實(shí)現(xiàn)，登錄的是http://xxxx/oauth/token獲取access_token。調(diào)用其他接口時(shí)，帶上access_token進(jìn)行權(quán)限認(rèn)證。所以我要想加驗(yàn)證碼，需要把驗(yàn)證碼值放到http://xxxx/oauth/token鏈接上傳到服務(wù)器進(jìn)行驗(yàn)證。又因?yàn)槲沂褂昧薢uul網(wǎng)關(guān)，作為網(wǎng)站的入口。我選擇在使用Zuul網(wǎng)關(guān)的Filter過(guò)濾器進(jìn)行校驗(yàn)驗(yàn)證碼。

驗(yàn)證碼我使用的是EasyCaptcha，git地址如下：https://gitee.com/whvse/EasyCaptcha。為了快速校驗(yàn)驗(yàn)證信息，我把驗(yàn)證碼的值緩存到Redis中，具有代碼實(shí)現(xiàn)如下：

1.集成EasyCaptcha：

<dependencies>
   <dependency>
      <groupId>com.github.whvcse</groupId>
      <artifactId>easy-captcha</artifactId>
      <version>1.6.2</version>
   </dependency>
</dependencies>

2.生成驗(yàn)證碼并保存到Redis中：

/**
     * 驗(yàn)證碼
     *
     * @return
     */
    @GetMapping("/captcha")
    public Result captcha() {
 
        String captchaKey = "captcha_" + UUID.randomUUID();
        // 三個(gè)參數(shù)分別為寬、高、位數(shù)
        SpecCaptcha captcha = new SpecCaptcha(130, 60, 4);
        // 設(shè)置字體 有默認(rèn)字體，可以不用設(shè)置
        captcha.setFont(new Font("Verdana", Font.PLAIN, 32));
        // 設(shè)置類型，純數(shù)字、純字母、字母數(shù)字混合
        captcha.setCharType(Captcha.TYPE_ONLY_NUMBER);
        log.info("key: [{}] ,code: [{}]", captchaKey, captcha.text());
        // 存入Redis ，默認(rèn)兩分鐘
        redisBaseUtil.set(captchaKey, captcha.text(), 2, TimeUnit.MINUTES);
        Map<String, Object> map = new HashMap<>(4);
        map.put("captchaKey", captchaKey);
        map.put("image", captcha.toBase64());
        return Result.success(map);
 
    }

3. 校驗(yàn)驗(yàn)證碼的Filter：

package com.hanxiaozhang.filter;
 
import com.hanxiaozhang.constant.Constant;
import com.hanxiaozhang.redis.util.RedisUtil;
import com.hanxiaozhang.result.ResultCode;
import com.hanxiaozhang.result.Result;
import com.hanxiaozhang.util.JsonUtil;
import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
import org.springframework.stereotype.Component;
 
import javax.servlet.http.HttpServletRequest;
import java.util.Map;
 
/**
 * 〈一句話功能簡(jiǎn)述〉<br>
 * 〈驗(yàn)證碼過(guò)濾器〉
 *
 * @author hanxinghua
 * @create 2021/4/4
 * @since 1.0.0
 */
@Slf4j
@Component
public class CaptchaFilter extends ZuulFilter {
 
    @Autowired
    private RedisUtil redisBaseUtil;
 
    @Override
    public String filterType() {
        return FilterConstants.PRE_TYPE;
    }
 
    @Override
    public int filterOrder() {
        return 0;
    }
 
    @Override
    public boolean shouldFilter() {
        return true;
    }
 
    @Override
    public Object run() {
 
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest serverHttpRequest = currentContext.getRequest();
        String uri = serverHttpRequest.getRequestURI();
        if (uri.contains("/oauth/token")) {
            String method = serverHttpRequest.getMethod();
            // 處理跨域Post發(fā)送兩次請(qǐng)求
            if (Constant.OPTIONS.equals(method)) {
                return null;
            }
            Map<String, String[]> parameterMap = serverHttpRequest.getParameterMap();
            String[] captchaKeys = null, captchaCodes = null;
            if (!parameterMap.isEmpty()
                    && (captchaKeys = parameterMap.get("captcha_key")) != null
                    && (captchaCodes = parameterMap.get("captcha_code")) != null) {
                String captchaKey = captchaKeys[0];
                String captchaCode = captchaCodes[0];
                log.info("Request Captcha Parameters: key: [{}] ,code: [{}]", captchaKey, captchaCode);
                String redisCaptchaCode = redisBaseUtil.get(captchaKey);
                String responseBody = null;
                if (redisCaptchaCode == null) {
                    responseBody = JsonUtil.beanToJson(Result.error(ResultCode.LOGIN_CAPTCHA_EXPIRE));
                } else if (!captchaCode.trim().equalsIgnoreCase(redisCaptchaCode)) {
                    responseBody = JsonUtil.beanToJson(Result.error(ResultCode.LOGIN_CAPTCHA_ERROR));
                }
                if (responseBody != null) {
                    currentContext.setSendZuulResponse(false);
                    currentContext.setResponseStatusCode(200);
                    currentContext.getResponse().setContentType(Constant.APP_JSON_UTF_8);
                    log.info("Response Parameters: \n [{}]", responseBody);
                    currentContext.setResponseBody(responseBody);
                }
            }
        }
        return null;
    }
}

4.使用，這里使用《Idea中HTTP Client請(qǐng)求測(cè)試工具》：

4.1 獲取驗(yàn)證碼：

GET http://localhost/api/system/captcha

4.2 校驗(yàn)驗(yàn)證碼：

POST  http://localhost/api/system/oauth/token?username={{username}}&password={{password}}&grant_type=password&scope={{scope}}&client_id={{client_id}}&client_secret={{client_secret}}&captcha_key=captcha_23cacfe5-2751-44af-a34d-5e795caeb46a&captcha_code=5594

成功返回如下：