SpringBoot實現(xiàn)過濾器和攔截器的方法

更新時間：2022年11月02日 08:24:46 作者：twilight0402

大家應該都曉得實現(xiàn)過濾器需要實現(xiàn)?javax.servlet.Filter?接口，而攔截器會在處理指定請求之前和之后進行相關操作，配置攔截器需要兩步，本文通過實例代碼給大家介紹SpringBoot?過濾器和攔截器的相關知識，感興趣的朋友一起看看吧

過濾器

實現(xiàn)過濾器需要實現(xiàn) javax.servlet.Filter 接口。重寫三個方法。其中 init() 方法在服務啟動時執(zhí)行，destroy() 在服務停止之前執(zhí)行。

可用兩種方式注冊過濾器：

使用 FilterRegistrationBean 來注入。可使用 setOrder(0) 設置過濾器的優(yōu)先級，越小優(yōu)先級越高。
使用 @WebFilter(filterName = "myFilter2" ,urlPatterns = "/*") 配合 @ServletComponentScan() 實現(xiàn)注入。（@Order 注解無效）

編寫過濾器

package com.example.recorddemo.filters;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

public class MyFilter1 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化過濾器：" + filterConfig.getFilterName());
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("在請求之前做處理");

        if (servletRequest instanceof HttpServletRequest) {
            System.out.println("  URL:" + ((HttpServletRequest)servletRequest).getRequestURL());
        }

        // 調(diào)用filter鏈中的下一個filter
        filterChain.doFilter(servletRequest, servletResponse);
        
        System.out.println("在請求之后做處理");
    }

    @Override
    public void destroy() {
        System.out.println("銷毀：MyFilter1");
    }
}

注冊過濾器

基于 `FilterRegistrationBean`

在配置類中注冊一個 FilterRegistrationBean 類型的Bean。

如果沒有設置 UrlPatterns ，那么會自動關聯(lián)到 /* 上。
如果沒有設置過濾器的名字，那么會自動推理出一個過濾器名稱（bean的名字）
When no URL pattern or servlets are specified the filter will be associated to '/*'. The filter name will be deduced if not specified.
fileter默認是enable的，將其設置為false表示關閉當前過濾器。
可通過 setOrder(0) 方法設置過濾器的優(yōu)先級，如果優(yōu)先級相同，則先定義的優(yōu)先級更高。

@Configuration
public class FilterConfiguration {
    @Bean
    public FilterRegistrationBean myFilter1(){
        MyFilter1 filter = new MyFilter1();
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(filter);
//        filterRegistrationBean.addUrlPatterns("/*");
//        filterRegistrationBean.setEnabled(true);
        return filterRegistrationBean;
    }
}

基于 `@WebFilter`

使用 @WebFilter 修飾filter。
在任意configuration類中添加 @ServletComponentScan("com.example.recorddemo.filters")，包名可以不填。

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@WebFilter(filterName = "myFilter2" ,urlPatterns = "/*")
public class MyFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // 調(diào)用filter鏈中的下一個filter
        filterChain.doFilter(servletRequest, servletResponse);

    }

    @Override
    public void destroy() {}
}

攔截器

攔截器會在處理指定請求之前和之后進行相關操作，配置攔截器需要兩步

編寫攔截器類（實現(xiàn) HandlerInterceptor 接口）
添加已實現(xiàn)的攔截器（實現(xiàn) WebMvcConfigurer 接口，并重寫 addInterceptors() 方法）
添加addPathPatterns()規(guī)定攔截哪些請求。（/*表示只攔截/下的所有目錄，但是不包括子目錄, /**表示攔截/下的所有目錄，及其子目錄）

攔截器類：

package com.example.recorddemo.interceptor;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

/**
 * @author wangchao
 */
@Component
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // handle可拿到執(zhí)行方法的反射對象。
        System.out.println("preHandle: MyInterceptor");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 對于RESTful 接口用處不大
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 可捕捉異常，但是springboot已經(jīng)有了全局異常捕捉
    }
}

配置攔截器：

package com.example.recorddemo.configuration;

import com.example.recorddemo.interceptor.MyInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

/**
 * @author wangchao
 */
@Configuration
public class InterceptorConfiguration implements WebMvcConfigurer {
    @Resource
    MyInterceptor myInterceptor;

    /**
     * 添加攔截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).addPathPatterns("/**");
    }
}

registry.addInterceptor() 方法會返回當前的 interceptor，因此可直接執(zhí)行 addPathPatterns() 方法

public InterceptorRegistration addInterceptor(HandlerInterceptor interceptor) {
        InterceptorRegistration registration = new InterceptorRegistration(interceptor);
        this.registrations.add(registration);
        return registration;
    }

攔截器的執(zhí)行順序類似于棧，按照如下順序執(zhí)行：

preHandle-1, preHandle-2, postHandle-2, postHandle-1, afterCompletion-2, afterCompletion-1

到此這篇關于SpringBoot實現(xiàn)過濾器和攔截器的方法的文章就介紹到這了,更多相關SpringBoot 過濾器和攔截器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

java編寫創(chuàng)建數(shù)據(jù)庫和表的程序
這篇文章主要為大家詳細介紹了java編寫創(chuàng)建數(shù)據(jù)庫和表的程序，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2017-10-10
淺析Spring Security登錄驗證流程源碼
這篇文章主要介紹了Spring Security登錄驗證流程源碼解析,本文結(jié)合源碼講解登錄驗證流程，非常不錯，具有一定的參考借鑒價值，需要的朋友可以參考下
2019-11-11
Spring Boot 啟動加載數(shù)據(jù) CommandLineRunner的使用
本篇文章主要介紹了Spring Boot 啟動加載數(shù)據(jù) CommandLineRunner的使用，具有一定的參考價值，感興趣的小伙伴們可以參考一下。
2017-04-04
基于SpringBoot服務端表單數(shù)據(jù)校驗的實現(xiàn)方式
這篇文章主要介紹了基于SpringBoot服務端表單數(shù)據(jù)校驗的實現(xiàn)方式，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2020-10-10
深入解析Java編程中的boolean對象的運用
這篇文章主要介紹了Java編程中的boolean對象的運用,是Java入門學習中的基礎知識,需要的朋友可以參考下
2015-10-10
解決java.lang.NoClassDefFoundError錯誤的問題
在Java開發(fā)過程中,NoClassDefFoundError是一個常見的運行時錯誤,是由于JVM在運行時找不到已編譯的類文件導致的,本文就來介紹一下如何解決,具有一定的參考價值,感興趣的可以了解一下
2024-09-09
JAVA使用爬蟲抓取網(wǎng)站網(wǎng)頁內(nèi)容的方法
這篇文章主要介紹了JAVA使用爬蟲抓取網(wǎng)站網(wǎng)頁內(nèi)容的方法,實例分析了java爬蟲的兩種實現(xiàn)技巧,具有一定參考借鑒價值,需要的朋友可以參考下
2015-07-07
Java使用自定義注解+反射實現(xiàn)字典轉(zhuǎn)換代碼實例
這篇文章主要介紹了Java使用自定義注解+反射實現(xiàn)字典轉(zhuǎn)換代碼實例,注解是一種能被添加到java代碼中的元數(shù)據(jù),類、方法、變量、參數(shù)和包都可以用注解來修飾,注解對于它所修飾的代碼并沒有直接的影響,需要的朋友可以參考下
2023-09-09
JAVA基礎之控制臺輸入輸出的實例代碼
下面小編就為大家?guī)硪黄狫AVA基礎之控制臺輸入輸出的實例代碼。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2016-07-07
關于Java中阻塞隊列BlockingQueue的詳解
這篇文章主要介紹了關于Java中阻塞隊列BlockingQueue的詳解,BlockingQueue是為了解決多線程中數(shù)據(jù)高效安全傳輸而提出的,從阻塞這個詞可以看出，在某些情況下對阻塞隊列的訪問可能會造成阻塞,需要的朋友可以參考下
2023-05-05