Spring MVC @WebFilter Filter 過濾器

@WebFilter

@WebFilter 用於將一個類聲明為過濾器，該注解將會在部署時被容器處理，容器將根據具體的屬性配置將相應的類部署為過濾器。

( value、urlPatterns、servletNames 三者必需至少包含一個，且 value 和 urlPatterns 不能共存，如果同時指定，通常忽略 value 的取值 ).

 

@WebFilter可用於將某個類設置為過濾器.

被@WebFilter注解的類，會在容器啟動時被加載，並進行屬性配置。即項目一啟動容器自動加載 init 方法。

 

示例 1：

package com.xc.common.filter; import java.io.IOException; import javax.servlet.Filter; import javax.servlet.FilterChain; import javax.servlet.FilterConfig; import javax.servlet.ServletException; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.annotation.WebFilter; /** * @ClassName: FilterDemo01 * @Description: filter的三種典型應用： <br/> * 1、可以在filter中根據條件決定是否調用chain.doFilter(request, response)方法， 即是否讓目標資源執行 * 2、在讓目標資源執行之前，可以對request、response作預處理，再讓目標資源執行 * 3、在目標資源執行之后，可以捕獲目標資源的執行結果，從而實現一些特殊的功能 */ @WebFilter(filterName = "FilterDemo01", urlPatterns = { "/*" }) public class FilterDemo01 implements Filter { @Override public void init(FilterConfig filterConfig) throws ServletException { System.out.println("----FilterDemo01過濾器初始化----"); } @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { // 對request和response進行一些預處理 request.setCharacterEncoding("UTF-8"); response.setCharacterEncoding("UTF-8"); response.setContentType("text/html;charset=UTF-8"); System.out.println("FilterDemo01執行前！！！"); chain.doFilter(request, response); // 讓目標資源執行，放行 System.out.println("FilterDemo01執行后！！！"); } @Override public void destroy() { System.out.println("----過濾器銷毀----"); } }

// REF: https://www.cnblogs.com/ooo0/p/10360952.html

 

示例 2：

package com.itea.config;

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

/*
* web 應用程序啟動時，web 服務器將創建Filter 的實例對象，並調用其init方法，完成對象的初始化功能，從而為后續的用戶請求作好攔截的准備工作，filter對象只會創建一次，init方法也只會執行一次。
* */ @WebFilter(filterName = "encodingFilter",urlPatterns = "/*") public class EncodingFilter  implements Filter {
    @Override
    public void init(FilterConfig filterConfig) {}

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        servletRequest.setCharacterEncoding("UTF-8");
        servletResponse.setCharacterEncoding("UTF-8");
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {}
}

 

 

 

過濾器的 urlPatterns 的過濾路徑規則：

1.全路徑匹配： /abc/myServlet1.do

2.部分路徑匹配： /abc/*

3.通配符匹配 ：/*

4.后綴名匹配 ：*.do (注意:前面不加/)

filterName的首字母一定要小寫！！！小寫！！！小寫！！！

Application啟動類添加@ServletComponentScan注解

Filter的創建

　　Filter的創建和銷毀由WEB服務器負責。 web 應用程序啟動時，web 服務器將創建Filter 的實例對象，並調用其init方法，完成對象的初始化功能，從而為后續的用戶請求作好攔截的准備工作，filter對象只會創建一次，init方法也只會執行一次。通過init方法的參數，可獲得代表當前filter配置信息的FilterConfig對象。

Filter的銷毀

　　Web容器調用destroy方法銷毀Filter。destroy方法在Filter的生命周期中僅執行一次。在destroy方法中，可以釋放過濾器使用的資源。

FilterConfig接口

　　用戶在配置filter時，可以使用為filter配置一些初始化參數，當web容器實例化Filter對象，調用其init方法時，會把封裝了filter初始化參數的filterConfig對象傳遞進來。因此開發人員在編寫filter時，通過filterConfig對象的方法，就可獲得：

• 　　String getFilterName()：得到filter的名稱。
• 　　String getInitParameter(String name)： 返回在部署描述中指定名稱的初始化參數的值。如果不存在返回null.
• 　　Enumeration getInitParameterNames()：返回過濾器的所有初始化參數的名字的枚舉集合。
• 　　public ServletContext getServletContext()：返回Servlet上下文對象的引用。

 

 

REF

https://www.cnblogs.com/ooo0/p/10360952.html