快捷導(dǎo)航

SpringBoot項目整合攔截器詳解

更新時間：2023年10月21日 11:06:41 作者：浪浪山的猿

這篇文章主要介紹了SpringBoot項目整合攔截器詳解,java里的攔截器是動態(tài)攔截Action調(diào)用的對象,它提供了一種機制可以使開發(fā)者在一個Action執(zhí)行的前后執(zhí)行一段代碼,攔截器用于在某個方法或者字段被訪問之前進行攔截,然后再之前或者之后加入某些操作,需要的朋友可以參考下

什么是攔截器

java里的攔截器是動態(tài)攔截Action調(diào)用的對象，它提供了一種機制可以使開發(fā)者在一個Action執(zhí)行的前后執(zhí)行一段代碼，也可以在一個Action執(zhí)行前阻止其執(zhí)行，同時也提供了一種可以提取Action中可重用部分代碼的方式。

在AOP中，攔截器用于在某個方法或者字段被訪問之前進行攔截，然后再之前或者之后加入某些操作。

攔截器的應(yīng)用場景

日志記錄：可以記錄請求信息的日志，以便進行信息監(jiān)控、信息統(tǒng)計等。
權(quán)限檢查：如登陸檢測，進入處理器檢測是否登陸，如果沒有直接返回到登陸頁面。
性能監(jiān)控：典型的是慢日志。

攔截器的使用

自定義攔截器的步驟：

自定義攔截器類并實現(xiàn)HandlerInterceptor接口

/**
 * @author gf
 * @date 2023/2/6
 */
@Component
public class Intercepter1 implements HandlerInterceptor {
    @Override
    //在將請求發(fā)送到控制器controller之前執(zhí)行操作，若返回true就進入控制器，若返回false就不進入控制器了
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String token = request.getHeader("token");
        System.out.println("自定義攔截器1-----攔截到的token值為:"+token);
        return null != token;
    }
 
    @Override
    //用于在將響應(yīng)發(fā)送到客戶端之前執(zhí)行操作,就是控制器執(zhí)行完之后返回數(shù)據(jù)時執(zhí)行。
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
        System.out.println("自定義攔截器1-----控制器執(zhí)行完畢，返回數(shù)據(jù)");
    }
 
    @Override
    //在完成請求和響應(yīng)后執(zhí)行操作
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
        System.out.println("自定義攔截器1-----響應(yīng)結(jié)束");
    }
 
}

自定義攔截器類，通過實現(xiàn)HandlerInterceptor接口并重寫他的三個方法，preHandle、postHandle、afterCompletion，實現(xiàn)攔截控制。

preHandle：在將請求發(fā)送到控制器controller之前執(zhí)行操作，若返回true就進入控制器，若返回false就不進入控制器了。
postHandle：用于在將響應(yīng)發(fā)送到客戶端之前執(zhí)行操作,就是控制器執(zhí)行完之后返回數(shù)據(jù)時執(zhí)行。
afterCompletion：在完成請求和響應(yīng)后執(zhí)行操作。

注冊自定義攔截器

攔截器的注冊是通過重寫WebMvcConfigurer接口的addInterceptors方法實現(xiàn)的，老版本的WebMvcConfigurerAdapter使用時發(fā)現(xiàn)已經(jīng)被淘汰了，不推薦使用了。

/**
 * @author gf
 * @date 2023/2/6
 */
@Configuration
public class InterceptConfig implements WebMvcConfigurer {
 
 
    //引入自定義攔截器對象
    @Resource
    private Intercepter1 Intercepter1;
 
 
    //重寫addInterceptors方法注冊攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
 
        //addPathPatterns方法添加攔截路徑匹配規(guī)則("/**"是攔截所有)，excludePathPatterns方法是設(shè)置白名單，放行哪些路
        registry.addInterceptor(Intercepter1).addPathPatterns("/**").excludePathPatterns("/test/*").order(1);
    }
}

測試效果

編寫測試類

    @GetMapping("/test")
    public BaseResponse<String> sayHello(@RequestParam("name") String name){
        if(!name.equals("老王")){
            throw new BaseException(BaseErrorEnum.USER_NOT_EXIST);
        }
        else{
            return RespGenerator.success("調(diào)用成功");
        }
    }

測試先不傳token