@WebFilter
@WebFilter 用於將一個類聲明為過濾器,該注解將會在部署時被容器處理,容器將根據具體的屬性配置將相應的類部署為過濾器。該注解具有下表給出的一些常用屬性 ( 以下所有屬性均為可選屬性,但是 value、urlPatterns、servletNames 三者必需至少包含一個,且 value 和 urlPatterns 不能共存,如果同時指定,通常忽略 value 的取值 )
@WebFilter 的常用屬性

示例
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)方法, 即是否讓目標資源執行<br/>
* 2、在讓目標資源執行之前,可以對request\response作預處理,再讓目標資源執行 <br/>
* 3、在目標資源執行之后,可以捕獲目標資源的執行結果,從而實現一些特殊的功能 <br/>
*/
@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("----過濾器銷毀----");
}
}
Filter的生命周期
Filter的創建
Filter的創建和銷毀由WEB服務器負責。 web 應用程序啟動時,web 服務器將創建Filter 的實例對象,並調用其init方法,完成對象的初始化功能,從而為后續的用戶請求作好攔截的准備工作,filter對象只會創建一次,init方法也只會執行一次。通過init方法的參數,可獲得代表當前filter配置信息的FilterConfig對象。
Filter的銷毀
Web容器調用destroy方法銷毀Filter。destroy方法在Filter的生命周期中僅執行一次。在destroy方法中,可以釋放過濾器使用的資源。
FilterConfig接口
用戶在配置filter時,可以使用
- String getFilterName():得到filter的名稱。
- String getInitParameter(String name): 返回在部署描述中指定名稱的初始化參數的值。如果不存在返回null.
- Enumeration getInitParameterNames():返回過濾器的所有初始化參數的名字的枚舉集合。
- public ServletContext getServletContext():返回Servlet上下文對象的引用。
范例:利用FilterConfig得到filter配置信息
示例
package com.xc.common.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;
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;
@WebFilter(filterName = "FilterDemo02", urlPatterns = { "/*" }, initParams = { @WebInitParam(name = "name", value = "xc"),
@WebInitParam(name = "like", value = "java") })
public class FilterDemo02 implements Filter {
/*
* 過濾器初始化
*
* @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
*/
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("----FilterDemo02過濾器初始化----");
// <filter>
// <filter-name>FilterDemo02</filter-name>
// <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
// <!--配置FilterDemo02過濾器的初始化參數-->
// <init-param>
// <description>配置FilterDemo02過濾器的初始化參數</description>
// <param-name>name</param-name>
// <param-value>gacl</param-value>
// </init-param>
// <init-param>
// <description>配置FilterDemo02過濾器的初始化參數</description>
// <param-name>like</param-name>
// <param-value>java</param-value>
// </init-param>
// </filter>
//
// <filter-mapping>
// <filter-name>FilterDemo02</filter-name>
// <!--“/*”表示攔截所有的請求 -->
// <url-pattern>/*</url-pattern>
// </filter-mapping>
// 得到過濾器的名字
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("----過濾器銷毀----");
}
}
執行結果

