快捷導(dǎo)航

詳解SpringBoot中自定義和配置攔截器的方法

更新時(shí)間：2022年05月14日 08:21:30 作者：北根娃

今天這篇文章來介紹一下攔截器在SpringBoot中的如何自定義及如何配置的，攔截器的具體作用和應(yīng)用場景，感興趣的小伙伴可以了解一下

1.SpringBoot版本

本文基于的Spring Boot的版本是2.6.7 。

2.什么是攔截器

Spring MVC中的攔截器(Interceptor)類似于ServLet中的過濾器(Filter)，它主要用于攔截用戶請(qǐng)求并作出相應(yīng)的處理。例如通過攔截器可以進(jìn)行權(quán)限驗(yàn)證、記錄請(qǐng)求信息的日志、判斷用戶是否登錄等。

3.工作原理

一個(gè)攔截器，只有preHandle方法返回true，postHandle、afterCompletion才有可能被執(zhí)行；如果preHandle方法返回false，則該攔截器的postHandle、afterCompletion必然不會(huì)被執(zhí)行。攔截器不是Filter，卻實(shí)現(xiàn)了Filter的功能，其原理在于：

1.所有的攔截器(Interceptor)和處理器(Handler)都注冊(cè)在HandlerMapping中。

2.Spring MVC中所有的請(qǐng)求都是由DispatcherServlet分發(fā)的。

3.當(dāng)請(qǐng)求進(jìn)入DispatcherServlet.doDispatch()時(shí)候，首先會(huì)得到處理該請(qǐng)求的Handler（即Controller中對(duì)應(yīng)的方法）以及所有攔截該請(qǐng)求的攔截器。攔截器就是在這里被調(diào)用開始工作的。

4.攔截器的工作流程

4.1正常流程

4.2中斷流程

如果在Interceptor1.preHandle中報(bào)錯(cuò)或返回false ,那么接下來的流程就會(huì)被中斷，但注意被執(zhí)行過的攔截器的afterCompletion仍然會(huì)執(zhí)行。

5.應(yīng)用場景

攔截器本質(zhì)上是面向切面編程（AOP），符合橫切關(guān)注點(diǎn)的功能都可以放在攔截器中來實(shí)現(xiàn)，主要的應(yīng)用場景包括：

登錄驗(yàn)證，判斷用戶是否登錄。
權(quán)限驗(yàn)證，判斷用戶是否有權(quán)限訪問資源，如校驗(yàn)token
日志記錄，記錄請(qǐng)求操作日志（用戶ip，訪問時(shí)間等），以便統(tǒng)計(jì)請(qǐng)求訪問量。
處理cookie、本地化、國際化、主題等。
性能監(jiān)控，監(jiān)控請(qǐng)求處理時(shí)長等。

6.如何自定義一個(gè)攔截器

自定義一個(gè)攔截器非常簡單，只需要實(shí)現(xiàn)HandlerInterceptor這個(gè)接口即可，該接口有三個(gè)可以實(shí)現(xiàn)的方法，如下：

preHandle()方法：改方法會(huì)在控制方法前執(zhí)行，器返回值表示是否知道如何寫一個(gè)接口。中斷后續(xù)操作。當(dāng)其返回值為true時(shí)，表示繼續(xù)向下執(zhí)行；當(dāng)其返回值為false時(shí)，會(huì)中斷后續(xù)的所有操作(包括調(diào)用下一個(gè)攔截器和控制器類中的方法執(zhí)行等 )
postHandle()方法：該方法會(huì)在控制器方法調(diào)用之后，且解析視圖之前執(zhí)行?？梢酝ㄟ^此方法對(duì)請(qǐng)求域中的模型和視圖作出進(jìn)一步的修改。
afterCompletion()方法：該方法會(huì)在整個(gè)請(qǐng)求完成，即視圖渲染結(jié)束之后執(zhí)行?？梢酝ㄟ^此方法實(shí)現(xiàn)一些資源清理、記錄日志信息等工作。

7.如何使其在Spring Boot中生效

其實(shí)想要在Spring Boot生效其實(shí)很簡單，只需要定義一個(gè)配置類，實(shí)現(xiàn)WebMvcConfigurer這個(gè)接口，并且實(shí)現(xiàn)其中的addInterceptiors()方法即可，代碼演示如下：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    
    @Autowired
    private  XXX xxx;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //不需要攔截的url
        final  String[] commonExclude={};
        registry.addInterceptor(xxx).excludePathPatterns(commonExclude)
    }
}

8.實(shí)際使用

8.1場景模擬

通過攔截器防止用戶暴力請(qǐng)求連接，使用用戶IP來限制訪問次數(shù) 。達(dá)到多少次數(shù)禁止該IP訪問。

8.2思路

記錄用戶IP訪問次數(shù)，第一次訪問時(shí)在redis中創(chuàng)建一個(gè)有效時(shí)長1秒的key，當(dāng)?shù)诙卧L問時(shí)key值+1，當(dāng)值大于等于5時(shí)在redis中創(chuàng)建一個(gè)5分鐘的key，當(dāng)攔截器查詢到reids中有當(dāng)前IP的key值時(shí)返回false限制用戶請(qǐng)求接口。

8.3實(shí)現(xiàn)過程

第一步，創(chuàng)建一個(gè)攔截器，代碼如下：

@Slf4j
public class IpUrlLimitInterceptor implements HandlerInterceptor {

    @Resource
    RedisUtils redisUtils;

    private static  final  String LOCK_IP_URL_KEY="lock_ip_";

    private static  final String IP_URL_REQ_TIME="ip_url_times_";
    //訪問次數(shù)限制
    private static final long LIMIT_TIMES=5;

    //限制時(shí)間 秒為單位
    private static final int IP_LOCK_TIME=300;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("request請(qǐng)求地址uri={},ip={}",request.getRequestURI(), IpUtils.getRequestIP(request));
        if(ipIsLock(IpUtils.getRequestIP(request))){
            log.info("ip訪問被禁止={}",IpUtils.getRequestIP(request));
            throw  new Exception("當(dāng)前操作過于頻繁，請(qǐng)5分鐘后重試");
        }
        if (!addRequestTime(IpUtils.getRequestIP(request),request.getRequestURI())){
            log.info("當(dāng)前{}操作過于頻繁，請(qǐng)5分鐘后重試",IpUtils.getRequestIP(request));
            throw  new Exception("當(dāng)前操作過于頻繁，請(qǐng)5分鐘后重試");
        }
        return true;
    }

    private boolean addRequestTime(String ip, String uri) {
        String key = IP_URL_REQ_TIME+ip+uri;
        if(redisUtils.hasKey(key)){
            long time=redisUtils.incr(key,(long)1);
            if(time >=LIMIT_TIMES){
                redisUtils.set(LOCK_IP_URL_KEY+ip,IP_LOCK_TIME);
                return false;
            }
        }else {
             boolean set = redisUtils.set(key, (long) 1, 1);
        }
        return  true;
    }

    private boolean ipIsLock(String ip) {
        if(redisUtils.hasKey(LOCK_IP_URL_KEY+ip)){
            return true;
        }
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

第二步，定義一個(gè)獲取IP的工具類，代碼如下：

@Slf4j
public class IpUtils {


    public  static  String getRequestIP(HttpServletRequest request){
        String ip = request.getHeader("x-forwarded-for");
        if(ip != null && ip.length() !=0 && "unknown".equalsIgnoreCase(ip)){
            // 多次反向代理后會(huì)有多個(gè)ip值，第一個(gè)ip才是真實(shí)ip
            if( ip.indexOf(",")!=-1 ){
                ip = ip.split(",")[0];
            }
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)){
            ip = request.getHeader("Proxy-Client-IP");
            log.info("Proxy-Client-IP ip: " + ip);
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("HTTP_CLIENT_IP");
            log.info("HTTP_CLIENT_IP ip: " + ip);
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("HTTP_X_FORWARDED_FOR");
            log.info("HTTP_X_FORWARDED_FOR ip: " + ip);
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("X-Real-IP");
            log.info("X-Real-IP ip: " + ip);
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
            log.info("getRemoteAddr ip: " + ip);
        }
        return  ip;
    }
}

第二步，在Spring Boot中配置這個(gè)攔截器，代碼如下：

@Configuration
public class WebConfig implements WebMvcConfigurer {



    @Bean
    IpUrlLimitInterceptor getIpUrlLimitInterceptor(){
        return  new IpUrlLimitInterceptor();
    };
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(getIpUrlLimitInterceptor()).addPathPatterns("/**");
    
    }
}