@WebFilter注解
@WebFilter注解
@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时,可以使用为filter配置一些初始化参数,当web容器实例化Filter对象,调用其init方法时,会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时,通过filterConfig对象的方法,就可获得:
- 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("----过滤器销毁----");
}
}
执行结果
此博客只是为了记忆相关知识点,大部分为网络上的文章,在此向各个文章的作者表示感谢!