SpringBoot中自定義攔截器詳解 (Token校驗(yàn)與放行)

首先是攔截類AuthInterceptor.java中的具體邏輯,主要是有繼承BaseInterceptor.java 類,而這個(gè)BaseInterceptor.java類繼承了HandlerInterceptorAdapter類,然后攔截類AuthInterceptor.java實(shí)現(xiàn)了其中的preHandle方法

以下是全部代碼

攔截器主要邏輯類——AuthInterceptor.java

package com.magnet.movie.rest.interceptor;

import com.alibaba.dubbo.config.annotation.Reference;
import com.magnet.movie.common.entity.User;
import com.magnet.movie.common.vo.MessageKey;
import com.magnet.movie.data.api.UserService;
import com.magnet.movie.rest.annotation.DisableAuth;
import com.magnet.movie.rest.utils.Constants;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
@Component
public class AuthInterceptor extends BaseInterceptor {

    @Reference
    private UserService userService;
    
    @Override
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {

        if (!(handler instanceof HandlerMethod)) {
            return true;
        }
        //放行邏輯
        HandlerMethod method = (HandlerMethod) handler;
        DisableAuth auth = method.getMethod().getAnnotation(DisableAuth.class);
        if (isDisableAuth(auth)) {
            return super.preHandle(request, response, handler);
        }
        //獲取token
        String accessToken = getAuthToken(request);
        if (StringUtils.isBlank(accessToken)) {
            setResponse(request, response, MessageKey.ACCESS_TOKEN_IS_NULL_CODE,"Error: token is null");
            return false;
        }
        
         // 3.查詢token是否正確
        User account = userService.findAccessTokenIsValid(accessToken);
        if (account == null) {
            setResponse(request, response, MessageKey.ACCESS_TOKEN_IS_INVALID_CODE,"Error: token is invalid");
            return false;
        }

        // 將userId寫入到request請(qǐng)求中
        request.setAttribute(Constants.REQUEST_ATTR_USER_ID, account.getId());
        request.setAttribute("UserToken", accessToken);
        request.setAttribute("UserId", account.getId());

        return true;
    }

    private static boolean isDisableAuth(DisableAuth auth) {
        return auth != null;
    }

    /**
     * 獲取http請(qǐng)求頭部或者參數(shù)中的token值
     * 
     * @param request
     *            http請(qǐng)求傳遞的值
     * @return 返回token
     */
    private String getAuthToken(HttpServletRequest request) {
        String token = request.getHeader("accessToken");

        if (token == null) {
            token = request.getParameter("accessToken");
        }
        return token;
    }
}

父類BaseInterceptor.java 這個(gè)類里面的代碼其實(shí)與我要做的token校驗(yàn)關(guān)系不大

package com.magnet.movie.rest.interceptor;

import java.io.IOException;
import java.io.Writer;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import lombok.extern.slf4j.Slf4j;

import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import com.alibaba.fastjson.JSON;

@Slf4j
public abstract class BaseInterceptor extends HandlerInterceptorAdapter {


    public void setResponse(HttpServletRequest request,
                            HttpServletResponse response, String messageKey,String message) {

        response.setContentType("application/json;charset=UTF-8");
        try (Writer writer = response.getWriter()) {
            Map<String, Object> resultMap = new HashMap<>();
            resultMap.put("code", messageKey);
            resultMap.put("message", message);

            logger(request, resultMap);
            JSON.writeJSONString(writer, resultMap);
            writer.flush();
        } catch (IOException e) {
            log.error("respose 設(shè)置操作異常:" + e);
        }
    }

    public void setResponse(HttpServletRequest request,
            HttpServletResponse response, String messageKey) {
        setResponse(request,response,messageKey,"OK");

    }


    /**
     * 記錄日志
     */
    private void logger(HttpServletRequest request, Map<String, Object> resultMap) {
        StringBuffer msg = new StringBuffer();
        msg.append("異常攔截日志:");
        msg.append("[uri:").append(request.getRequestURI()).append("]");
        Enumeration<String> enumer = request.getParameterNames();
        while (enumer.hasMoreElements()) {
            String name = enumer.nextElement();
            String[] values = request.getParameterValues(name);
            msg.append("[").append(name).append("=");
            if (values != null) {
                int i = 0;
                for (String value : values) {
                    i++;
                    msg.append(value);
                    if (i < values.length) {
                        msg.append("|");
                    }
                }
            }
            msg.append("]");
        }
        msg.append(JSON.toJSONString(resultMap));

        log.warn(msg.toString());
    }
}


回到攔截器邏輯類中會(huì)發(fā)現(xiàn)我重寫了preHandle方法


重寫方法

這個(gè)方法的作用:
原文鏈接 : https://blog.csdn.net/azhegps/article/details/99342891

適配器HandlerInterceptorAdapter的作用

這樣我們所有的請(qǐng)求都會(huì)經(jīng)過(guò)攔截器的邏輯戳粒,如果請(qǐng)求不符合邏輯就會(huì)被攔截到悔叽,并不會(huì)執(zhí)行到方法內(nèi)部爽篷。

有的接口需要token校驗(yàn)宵蕉,有的并不需要酝静,所以還要一個(gè)放行的邏輯。
可以直接用自定義注解來(lái)實(shí)現(xiàn)

自定義注解@DisableAuth 代碼

package com.magnet.movie.rest.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 非鑒權(quán)注解羡玛,Controller使用此注解,過(guò)濾器將不攔截
 * @author hudahua
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
@Inherited
public @interface DisableAuth {

}


上面四個(gè)注解就是java的四大元注解宗苍,具體的用法如下(出自百度):
原文鏈接 : https://blog.csdn.net/qq_26125865/article/details/82881481

元注解作用

在需要放行的方法上加上自定義注解@DisableAuth


用法

攔截類AuthInterceptor.java中的放行邏輯
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末稼稿,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子讳窟,更是在濱河造成了極大的恐慌让歼,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,884評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件丽啡,死亡現(xiàn)場(chǎng)離奇詭異谋右,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)补箍,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,755評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門改执,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人坑雅,你說(shuō)我怎么就攤上這事辈挂。” “怎么了裹粤?”我有些...
    開(kāi)封第一講書人閱讀 158,369評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵终蒂,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我遥诉,道長(zhǎng)拇泣,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 56,799評(píng)論 1 285
  • 正文 為了忘掉前任矮锈,我火速辦了婚禮霉翔,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘愕难。我一直安慰自己早龟,他們只是感情好惫霸,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,910評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著葱弟,像睡著了一般壹店。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上芝加,一...
    開(kāi)封第一講書人閱讀 50,096評(píng)論 1 291
  • 那天硅卢,我揣著相機(jī)與錄音,去河邊找鬼藏杖。 笑死将塑,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的蝌麸。 我是一名探鬼主播点寥,決...
    沈念sama閱讀 39,159評(píng)論 3 411
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼来吩!你這毒婦竟也來(lái)了敢辩?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書人閱讀 37,917評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤弟疆,失蹤者是張志新(化名)和其女友劉穎戚长,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體怠苔,經(jīng)...
    沈念sama閱讀 44,360評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡同廉,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,673評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了柑司。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片迫肖。...
    茶點(diǎn)故事閱讀 38,814評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖帜羊,靈堂內(nèi)的尸體忽然破棺而出咒程,到底是詐尸還是另有隱情,我是刑警寧澤讼育,帶...
    沈念sama閱讀 34,509評(píng)論 4 334
  • 正文 年R本政府宣布帐姻,位于F島的核電站,受9級(jí)特大地震影響奶段,放射性物質(zhì)發(fā)生泄漏饥瓷。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,156評(píng)論 3 317
  • 文/蒙蒙 一痹籍、第九天 我趴在偏房一處隱蔽的房頂上張望呢铆。 院中可真熱鬧,春花似錦蹲缠、人聲如沸棺克。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 30,882評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)娜谊。三九已至确买,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間纱皆,已是汗流浹背湾趾。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 32,123評(píng)論 1 267
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留派草,地道東北人搀缠。 一個(gè)月前我還...
    沈念sama閱讀 46,641評(píng)論 2 362
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像近迁,于是被迫代替她去往敵國(guó)和親艺普。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,728評(píng)論 2 351

推薦閱讀更多精彩內(nèi)容