Spring-Boot使用嵌入式容器，那怎麼配置自定義Filter呢

来源:https://www.cnblogs.com/54chensongxia/archive/2020/01/10/12177784.html
-Advertisement-
Play Games

、`Filter Servlet XSS`攻擊等。如果我們使用的是傳統的Spring MVC進行開發，那麼只需要在Tomcat的web.xml文件中進行如下配置即可： PS：在容器啟動的時候，上面三個組件啟動的順序是Listener Filter Servlet，這邊安利一個記憶的方法：把啟動順序記 ...


Listener、Filter和Servlet是Java Web開發過程中常用的三個組件，其中Filter組件的使用頻率最高，經常被用來做簡單的許可權處理、請求頭過濾和防止XSS攻擊等。如果我們使用的是傳統的Spring MVC進行開發，那麼只需要在Tomcat的web.xml文件中進行如下配置即可：

<!-- 配置Listener -->
<listener>
    <listener-class>org.springframework.web.util.WebAppRootListener</listener-class>
</listener>
<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener> 

<!--配置Filter，這邊配置了一個Filter，但是匹配了多個url-pattern-->
<!-- 以url-partern方式配置的filter中，如果有多個與當前請求匹配，則按web.xml中filter-mapping出現的順序來運行-->
<filter>  
    <filter-name>filter1</filter-name>  
    <filter-class>com.csx.MyFilter</filter-class>  
</filter>  
<filter-mapping>
    <filter-name>filter1</filter-name>  
    <url-pattern>/url/a/*</url-pattern>  
</filter-mapping>  
<filter-mapping>  
    <filter-name>filter1</filter-name>  
    <url-pattern>/url/b/*</url-pattern>  
</filter-mapping>

<!--配置Servlet-->
<servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:springmvc.spring.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <!-- 這邊不建議寫成/* -->
    <url-pattern>/</url-pattern>
</servlet-mapping>

PS：在容器啟動的時候，上面三個組件啟動的順序是Listener --> Filter --> Servlet，這邊安利一個記憶的方法：把啟動順序記憶成“理（Listener）發（Filter）師（Servlet）”即可。

在web.xml中配置這三個組件比較簡單，但是使用Spring-Boot開發時使用的是嵌入式容器，並沒有web.xml文件讓我們進行配置。那麼在Spring-Boot中到底要怎麼配置Listener、Filter和Servlet等組件呢？

本篇博客以Filter為列，介紹下在Spring-Boot中怎麼配置Listener、Filter和Servlet等組件。

方式一：將Filter聲明為bean

這邊我們先來自定義一個Filter，這個Filter的作用是統計一個介面的調用時間。

public class TimeConsumingCalculationFilter implements Filter {

        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            HttpServletRequest httpRequest=(HttpServletRequest)request;
            long startTime = System.nanoTime();
            logger.info(">>>>>>> Begin ["+httpRequest.getRequestURI()+"]...");
            try{
                chain.doFilter(request, response);
            }finally {
                long endTime = System.nanoTime();
                logger.info(">>>>>>> End ["+httpRequest.getRequestURI()+"]["+(endTime-startTime)/1000/1000.0+"ms].");
            }
        }

    }

在Spring-Boot中配置上面的Filter，我們只需要在@Configuration文件中做如下配置即可：

@Configuration
public class WebConfig {

    private static Logger logger = LoggerFactory.getLogger(WebConfig.class);

    @Bean
    public Filter filter1(){
        return new TimeConsumingCalculationFilter();
    }
}

上面的Filter預設會攔截所有請求。假如我們想要配置多個攔截器的話，只要再加一個Bean方法就可以了。

@Configuration
public class WebConfig {

    private static Logger logger = LoggerFactory.getLogger(WebConfig.class);

    @Bean
    public Filter filter1(){
        return new TimeConsumingCalculationFilter();
    }
    
    @Bean
    public Filter filter2() {
        return new TimeConsumingCalculationFilter2();
    }
}

上面的配置代碼配置了兩個Filter，兩個Filter預設都會攔截所有請求，攔截的順序是：filter1-->filter2。這邊的邏輯是先配置的Filter先攔截，後配置的Filter後攔截。當然，如果我們想明確指定攔截順序的話可以藉助@Order註解。但是需要註意的是這個註解一定要加在定義的類上面。

@Order(Ordered.LOWEST_PRECEDENCE - 2)
public class TimeConsumingCalculationFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
       //your logic
    }

}
@Order(Ordered.LOWEST_PRECEDENCE - 1)
public class TimeConsumingCalculationFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
       //your logic
    }

}

PS: @Order中的value值越大，執行的優先順序越小。值越小，優先順序越大。當我們自定義執行順序的時候，建議使用@Order(Ordered.LOWEST_PRECEDENCE - 1)這種形式配置，Ordered.LOWEST_PRECEDENCE減去的值越大，優先順序越高，這樣看起來比較直觀。

另外，Spring還提供了一個OrderedFilter介面，這個介面是Filter和Ordered的組合介面，原理和上面的是一樣的。大家可以看情況使用。

上面的這種配置方式優點是配置起來非常簡單，但是缺點也比較明顯，就是配置不夠靈活，預設會攔截所有請求。

方式二：@WebFilter方式

@WebFilter註解是Servlet中提供的註解，Spring也支持這個註解。@WebFilter能進行細粒度的進行配置，比上面的方式更加靈活。

@Configuration
public class WebConfig {
    //可以自定義url-pattern
    @WebFilter(urlPatterns="/*")
    @Order(Ordered.LOWEST_PRECEDENCE - 2)
    //這邊如果不加`@Configuration`,需要通過`@ServletComponentScan`掃描`Listener`、`Filter`和`Servlet`這三個組件
    @Configuration
    public class TimeConsumingCalculationFilter implements Filter {

        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            //your logic
        }
    }   
    
    @WebFilter(urlPatterns="/*")
    @Order(Ordered.LOWEST_PRECEDENCE - 2)
    //這邊如果不加`@Configuration`,需要通過`@ServletComponentScan`掃描`Listener`、`Filter`和`Servlet`這三個組件
    @Configuration
    public class TimeConsumingCalculationFilter2 implements Filter {

        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            //your logic
        }
    }   
    
}

通過 @WebFilter 註解的方式配置Filter簡單，而且能夠自定義url-pattern和攔截順序。

方式三：使用FilterRegistrationBean配置

@Configuration
public class WebConfig {

    private static Logger logger = LoggerFactory.getLogger(WebConfig.class);

    @Bean
        public FilterRegistrationBean<Filter> filter1() {
            FilterRegistrationBean<Filter> registrationBean = new FilterRegistrationBean<>();
            registrationBean.setName("filter1");
            registrationBean.setOrder(Ordered.LOWEST_PRECEDENCE - 2);
            registrationBean.setFilter(new TimeConsumingCalculationFilter());
            registrationBean.addUrlPatterns("/foo/*");
            return registrationBean;
        }
    
    
        @Bean
        public FilterRegistrationBean<Filter> filter2() {
            FilterRegistrationBean<Filter> registrationBean = new FilterRegistrationBean<>();
            registrationBean.setName("filter2");
            registrationBean.setOrder(Ordered.LOWEST_PRECEDENCE - 3);
            registrationBean.setFilter(new TimeConsumingCalculationFilter1());
            registrationBean.addUrlPatterns("/*");
            registrationBean.addInitParameter("key1","value1");
            registrationBean.addInitParameter("key2","value2");
            //通過Servlet name匹配Filter，不建議使用
            registrationBean.addServletNames("name1");
            return registrationBean;
        }

}

註意點：

  • FilterRegistrationBean 與 Filter 之間是一對一關係。
  • 如果存在多個 FilterRegistrationBean 需要調用其 setName(String name) 為其聲明唯一名稱，否則只有第一個註冊成功的有效。
  • 如果需要保證調用順序可通過調用其 setOrder(int order) 方法進行設置。

方式四：使用DelegatingFilterProxyRegistrationBean方式

@Configuration
public class WebConfig {
    
    @Bean("myFilter")
    //配置了DelegatingFilterProxyRegistrationBean後,這種方式配置的Filter不會生效了，只會攔截/foo/*的請求
    public Filter myFilter(){
        return new TimeConsumingCalculationFilter();
    }

    @Bean
    public DelegatingFilterProxyRegistrationBean delegatingFilterProxyRegistrationBean(){
        DelegatingFilterProxyRegistrationBean filterProxy = new DelegatingFilterProxyRegistrationBean("myFilter");
        filterProxy.addUrlPatterns("/foo/*");
        filterProxy.addInitParameter("targetFilterLifecycle","true");
        filterProxy.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico");
        filterProxy.setDispatcherTypes(DispatcherType.REQUEST);
        return filterProxy;
    }

}

FilterRegistrationBean和DelegatingFilterProxyRegistrationBean區別：

  • FilterRegistrationBean通過onStartup方法直接註冊filter。
  • DelegatingFilterProxyRegistrationBean是將DelegatingFilterProxy註冊到Servlet3.0+的容器中，同時實現了ApplicationContextAware介面，實例ApplicationContext通過通過傳入自定義filter的名稱查找對應的bean，並生成相應bean的代理對象。

觸類旁通

  • 添加自定義Servlet 也可採用方法一@WebServlet 或者ServletRegistrationBean
  • 添加自定義Listener也可以採用方法一 @WebListener或者ServletListenerRegistrationBean ,註意監聽事件是泛型

其他相關類

  • ServletComponentRegisteringPostProcessor
  • ServletComponentHandler
  • WebListenerHandler
  • WebFilterHandler
  • WebServletHandler

參考

  • https://blog.csdn.net/loveForever_xiang/article/details/101270633
  • https://www.liangzl.com/get-article-detail-121998.html
  • https://mp.weixin.qq.com/s/t8WdKEkYJuRApeEEOvXR_A
  • https://blog.csdn.net/andy_zhang2007/article/details/90399870

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 什麼？你還沒女朋友？教你如何藉助Python俘獲女孩子芳心！
    天氣降溫，感情卻升溫了？ 上午剛到公司，就收到小Q發來的靈魂拷問： “Q仔！要不然下午請個假！我帶你去精神科看看！？”我實在忍不了，脫口而出。 話音未落，前排的運營小花回頭看向小Q，莞爾一笑，百媚橫生。 這個悶騷小伙子什麼時候勾搭上運營一枝花了？我正要追問，小Q看穿了我的意圖，故作正經：“咳咳！工作 ...
  • Django之AJAX簡介
    [TOC] AJAX簡介 AJAX（Asynchronous Javascript And XML）翻譯成中文就是“非同步的Javascript和XML”。即使用Javascript語言與伺服器進行非同步交互，傳輸的數據為XML（當然，傳輸的數據不只是XML）。 AJAX 不是新的編程語言，而是一種使用 ...
  • MyBatis中#{}和${}的區別詳解
    區別 1.#將傳入的數據都當成一個字元串，會對自動傳入的數據加一個雙引號。如：order by #user_id#，如果傳入的值是111,那麼解析成sql時的值為order by "111", 如果傳入的值是id，則解析成的sql為order by "id". 2.將傳入的數據直接顯示生成在sql中 ...
  • 關於Integer 和Double包裝類創建對象時的底層解析
    public void method1() { Integer i = new Integer(1); Integer j = new Integer(1); System.out.println(i == j); Integer m = 1; Integer n = 1; System.out.p ...
  • java網路考試系統的設計與實現 jsp 源碼
    開發環境: Windows操作系統開發工具：MyEclipse/Eclipse + JDK+ Tomcat + MySQL 資料庫項目簡介：網路考試系統主要用於實現高校線上考試，基本功能包括：自動組捲、試卷發佈、試卷批閱、試卷成績統計等。本系統結構如下：（1）學生端： 登錄模塊：登錄功能； 網路考試 ...
  • Java String類相關知識梳理（含字元串常量池（String Pool）知識）
    目錄 1. String類是什麼 1.1 定義 1.2 類結構 1.3 所在的包 2. String類的底層數據結構 3. 關於 intern() 方法（重點） 3.1 作用 3.2 字元串常量池（String Pool） 4. String類所用的連接符 5. String類的主要作用（簡） 正文 ...
  • java實現圖片文件與Base64的互轉
    通過form表單上傳圖片時，有時候web容器對文件大小的限制會影響我們上傳。這時，前端頁面可以考慮將圖片轉換成base64串來實現上傳。 圖片與Base64的互轉，其實就是利用了文件流與Base64的互轉。 文件轉換成Base64字元串：讀取文件流，放到byte數組裡，對byte數組進行Base64 ...
  • Python合成GIF圖片 -- imageio
    ``` import imageio # 需要合在一起的圖片 image_list = [r'C:\Users\Hlzy\Desktop\\' + str(x) + ".jpg" for x in range(1, 12)] # gif的圖片名 gif_name = r'C:\Users\Hlzy\... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類