JAVA過濾器是處于客戶端與服務器資源文件之間的一道過濾網，在訪問資源文件之前，通過一系列的過濾器可以對請求進行修改、判斷等，把不符合規則的請求在中途攔截或修改；也可以對響應進行過濾，攔截或修改響應。
一、初識Filter
簡介
Filter也稱之為過濾器，它是Servlet技術中最激動人心的技術之一，WEB開發人員通過Filter技術，對web服務器管理的所有web資源：例如Jsp,Servlet, 靜態圖片文件或靜態html文件等進行攔截，從而實現一些特殊的功能。例如實現URL級別的權限訪問控制、過濾敏感詞匯、壓縮響應信息等一些高級功能。
Servlet API中提供了一個Filter接口，開發web應用時，如果編寫的Java類實現了這個接口，則把這個Java類稱之為過濾器Filter。通過Filter技術，開發人員可以實現用戶在訪問某個目標資源之前，對訪問的請求和響應進行攔截，Filter接口源代碼：
public abstract interface Filter {
public abstract void init(FilterConfig paramFilterConfig) throws ServletException;
public abstract void doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChAInparamFilterChain) throws IOException, ServletException;
public abstract void destroy();
}
在web.xml文件中對Filter進行配置，這個配置和Servlet很像。
<filter>
<description>過濾器名稱</description>
<filter-name>自定義的名字</filter-name>
<filter-class>全類名</filter-class>
<init-param>
<description>配置過濾器的初始化參數</description>
<param-name>name</param-name>
<param-value>gacl</param-value>
</init-param>
<init-param>
<description>配置FilterTest過濾器的初始化參數</description>
<param-name>like</param-name>
<param-value>java</param-value>
</init-param>
</filter>
Filter的工作原理
Filter接口中有一個doFilter方法，當我們編寫好Filter，并配置對哪個web資源進行攔截后，WEB服務器每次在調用web資源的service方法之前，都會先調用一下filter的doFilter方法，因此，在該方法內編寫代碼可達到如下目的：
1. 調用目標資源之前，讓一段代碼執行。
2. 是否調用目標資源（即是否讓用戶訪問web資源）。
3.調用目標資源之后，讓一段代碼執行。
web服務器在調用doFilter方法時，會傳遞一filterChain對象進來，filterChain對象是filter接口中最重要的一個對象，它也提供了一個doFilter方法，開發人員可以根據需求決定是否調用此方法，調用該方法，則web服務器就會調用web資源的service方法，即web資源就會被訪問，否則web資源不會被訪問。
注意:
- Servlet對象默認情況下，在服務器啟動的時候是不會創建對象的
- Filter對象在默認情況下，在服務器啟動的時候會新建對象
- Servlet是單例的，Filter也是單例的。（單實例）
Filter的執行
1、目標Servlet是否執行取決于兩個條件：
在過濾器中是否編寫了：chain.doFilter(request, response);這條代碼作用：執行下一個過濾器，如果下一個不是過濾器，則執行目標程序Servlet。
用戶發送的請求路徑是否和Servlet的請求路徑一致。
2、Filter與Servlet的優先級
Filter比Servlet優先級高，/a.do對應一個Filter，也對應一個Servlet，一定是先執行Filter再執行Servlet。
3、關于Filter的配置路徑
- /a.do、/b.do、/dept/save。這些配置方式都是精確匹配。
- /*匹配所有路徑。
- *.do后綴匹配，不要以“/”開始。
- /dept/* 前綴匹配。
4、在web.xml文件中進行配置時，Filter的執行順序是依靠filter-mApping標簽的配置位置，越靠上優先級越高。
5、在注解中配置時，Filter的執行順序是：
比較Filter的類名。例如FilterA和FilterB先執行FilterA。Filter1和Filter2先執行Filter1。
6、過濾器的調用順序，遵循棧數據結構。
7、Filter過濾器的設計模式：責任鏈設計模式
- 過濾器最大優點：在程序編譯階段不會確定調用順序，因為Filter的調用順序是配置到web.xml文件中的，只需要修改web.xml配置文件中的filter-mapping的順序就可以調整Filter的執行順序，顯然Filter的執行順序是在程序運行階段動態組合的。那么這種設計模式被稱為責任鏈設計模式。
- 責任鏈設計模式的核心思想：在程序運行階段，動態的組合程序的調用順序。
二、Filter開發流程
開發步驟
Filter開發分為2步：
編寫Java類實現Filter接口，并實現其doFilter方法。
在web.xml 文件中使用<filter>和<filter-mapping>元素對編寫的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;
/**
* @description 過濾器Filter的工作原理
*/
public class FilterTest implements Filter {
public void destroy() {
System.out.println("----Filter銷毀----");
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
// 對request、response進行一些預處理
request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");
response.setContentType("text/html;charset=UTF-8");
System.out.println("----調用service之前執行一段代碼----");
filterChain.doFilter(request, response);
// 執行目標資源，放行
System.out.println("----調用service之后執行一段代碼----");
}
public void init(FilterConfig arg0) throws ServletException {
System.out.println("----Filter初始化----");
}
}
Filter鏈
在一個web應用中，可以開發編寫多個Filter，這些Filter組合起來稱之為一個Filter鏈。web服務器根據Filter在web.xml文件中的注冊順序，決定先調用哪個Filter，當第一個Filter的doFilter方法被調用時，web服務器會創建一個代表Filter鏈的FilterChain對象傳遞給該方法。在doFilter方法中，開發人員如果調用了FilterChain對象的doFilter方法，則web服務器會檢查FilterChain對象中是否還有filter，如果有，則調用第2個filter，如果沒有，則調用目標資源。
Spring框架下，過濾器的配置
如果項目中使用了Spring框架，那么，很多過濾器都不用自己來寫了，Spring為我們寫好了一些常用的過濾器。下面我們就以字符編碼的過濾器CharacterEncodingFilter為例，來看一下Spring框架下，如果配置過濾器。
<filter>
<filter-name>encodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
接下來，我們看一下CharacterEncodingFilter這個過濾器的關鍵代碼
package org.springframework.web.filter;
import java.io.IOException;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.util.ClassUtils;
public class CharacterEncodingFilter extends OncePerRequestFilter {
private static final boolean responseSetCharacterEncodingAvailable = ClassUtils.hasMethod(class$javax$servlet$http$HttpServletResponse, "setCharacterEncoding", new Class[]{String.class});
// 需要設置的編碼方式，為了支持可配置，Spring把編碼方式設置成了一個變量
private String encoding;
// 是否強制使用統一編碼，也是為了支持可配置
private boolean forceEncoding;
// 構造器，在這里，Spring把forceEncoding的值默認設置成了false
public CharacterEncodingFilter() {
this.forceEncoding = false;
}
// encoding/forceEncoding的setter方法
public void setEncoding(String encoding) {
this.encoding = encoding;
}
public void setForceEncoding(boolean forceEncoding) {
this.forceEncoding = forceEncoding;
}
// Spring通過GenericFilterBean抽象類，對Filter接口進行了整合，
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
if ((this.encoding != null) && (((this.forceEncoding) || (request.getCharacterEncoding() == null)))) {
request.setCharacterEncoding(this.encoding);
if ((this.forceEncoding) && (responseSetCharacterEncodingAvailable)) {
response.setCharacterEncoding(this.encoding);
}
}
filterChain.doFilter(request, response);
}
}
GenericFilterBean類
項目中使用過的一個過濾器：InvilidCharacterFilter（防止腳本攻擊的過濾器）。
GenericFilterBean類：
public abstract class GenericFilterBean implements Filter, BeanNameAware, ServletContextAware, InitializingBean, DisposableBean
import java.io.IOException;
import java.util.Enumeration;
import javax.servlet.FilterChain;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.Apache.commons.lang.StringUtils;
import org.springframework.web.filter.CharacterEncodingFilter;
/** InvalidCharacterFilter：過濾request請求中的非法字符，防止腳本攻擊* InvalidCharacterFilter繼承了Spring框架的CharacterEncodingFilter過濾器，當然，我們也可以自己實現這樣一個過濾器*/
public class InvalidCharacterFilter extends CharacterEncodingFilter{
// 需要過濾的非法字符
private static String[] invalidCharacter = new String[]{
"script","select","insert","document","window","function",
"delete","update","prompt","alert","create","alter","drop",
"iframe","link","where","replace","function","onabort",
"onactivate","onafterprint","onafterupdate","onbeforeactivate",
"onbeforecopy","onbeforecut","onbeforedeactivateonfocus",
"onkeydown","onkeypress","onkeyup","","expression",
"applet","layer","ilayeditfocus","onbeforepaste","onbeforeprint",
"onbeforeunload","onbeforeupdate","onblur","onbounce",
"oncellchange","oncontextmenu","oncontrolselect","oncopy",
"oncut","ondataavailable","ondatasetchanged","ondatasetcomplete",
"ondeactivate","ondrag","ondrop","","onfilterchange",
"onfinish","onhelp","onlayoutcomplete","onlosecapture","onmouse",
"ote","onpropertychange","onreadystatechange","onreset","onresize",
"onresizeend","onresizestart","onrow","onscroll","onselect",
"onstaronsubmit","onunload","IMgsrc","infarction"};
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)throws ServletException, IOException{
String parameterName = null;String parameterValue = null;
// 獲取請求的參數
@SuppressWarnings("unchecked")
Enumeration<String> allParameter = request.getParameterNames();
while(allParameter.hasMoreElements()){
parameterName = allParameter.nextElement();
parameterValue = request.getParameter(parameterName);
if(null != parameterValue){
for(String str : invalidCharacter){
if (StringUtils.containsIgnoreCase(parameterValue, str)){
request.setAttribute("errorMessage", "非法字符：" + str);
RequestDispatcher requestDispatcher = request.getRequestDispatcher("/error.jsp");
requestDispatcher.forward(request, response);return;
}
}
}
}
super.doFilterInternal(request, response, filterChain);
}
}
接下來需要在web.xml中進行配置：
<filter>
<filter-name>InvalidCharacterFilter</filter-name>
<filter-class>com.test.filter.InvalidCharacterFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>InvalidCharacterFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
三、Filter的生命周期
Filter的創建
Filter的創建和銷毀由web服務器負責。web應用程序啟動時，web服務器將創建Filter的實例對象，并調用其init方法，完成對象的初始化
功能，從而為后續的用戶請求作好攔截的準備工作，filter對象只會創建一次，init方法也只會執行一次。通過init方法的參數，可獲得代表當前filter配置信息的FilterConfig對象。
Filter的銷毀
web容器調用destroy方法銷毀Filter。destroy方法在Filter的生命周期中僅執行一次。在destroy方法中，可以釋放過濾器使用的資源。
FilterConfig接口
用戶在配置filter時，可以使用<init-param>為filter配置一些初始化參數，當web容器實例化Filter對象，調用其init方法時，會把封裝了filter初始化參數的filterConfig對象傳遞進來。因此開發人員在編寫filter時，通過filterConfig對象的方法，就可獲得：
- String getFilterName()：得到filter的名稱。
- String getInitParameter(String name)：返回在部署描述中指定名稱的初始化參數的值。如果不存在返回null.
- Enumeration getInitParameterNames()：返回過濾器的所有初始化參數的名字的枚舉集合。
- public ServletContext getServletContext()：返回Servlet上下文對象的引用。
示例：利用FilterConfig得到filter配置信息
import java.io.IOException;
import java.util.Enumeration;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
public class FilterTest implements Filter {
/* 過濾器初始化* @see javax.servlet.Filter#init(javax.servlet.FilterConfig)*/
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("----過濾器初始化----");
//得到過濾器的名字
String filterName = filterConfig.getFilterName();
//得到在web.xml文件中配置的初始化參數
String initParam1 = filterConfig.getInitParameter("name");
String initParam2 = filterConfig.getInitParameter("like");
//返回過濾器的所有初始化參數的名字的枚舉集合。
Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();
System.out.println(filterName);
System.out.println(initParam1);
System.out.println(initParam2);
while (initParameterNames.hasMoreElements()) {
String paramName = (String) initParameterNames.nextElement();
System.out.println(paramName);
}
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println("FilterDemo02執行前！！！");
chain.doFilter(request, response);
//讓目標資源執行，放行
System.out.println("FilterDemo02執行后！！！");
}
@Override
public void destroy() {
System.out.println("----過濾器銷毀----");
}
}
總結
過濾器一般用于登錄權限驗證、資源訪問權限控制、敏感詞匯過濾、字符編碼轉換等等操作，便于代碼重用，不必每個servlet中還要進行相應的操作。
