Filter过滤器
Filter也称之为过滤器,WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp,Servlet, 静态图片文件或静态html文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些功能。
Servlet API中提供了一个Filter接口,开发web应用时,如果编写的Java类实现了这个接口,则把这个java类称之为过滤器Filter。通过Filter可以实现以下目的:
在客户端的请求访问后端资源之前,拦截这些请求。
在服务器的响应发送回客户端之前,处理这些响应。
主要应用场景/根据规范建议的各种类型的过滤器::
身份验证过滤器(Authentication Filters)。
数据压缩过滤器(Data compression Filters)。
加密过滤器(Encryption Filters)。
触发资源访问事件过滤器。
图像转换过滤器(Image Conversion Filters)。
日志记录和审核过滤器(Logging and Auditing Filters)。
MIME-TYPE 链过滤器(MIME-TYPE Chain Filters)。
标记化过滤器(Tokenizing Filters)。
XSL/T 过滤器(XSL/T Filters),转换 XML 内容。
Filter过滤器方法
方法 | 描述 |
---|---|
public void doFilter (ServletRequest, ServletResponse, FilterChain) | 该方法在每次一个请求/响应对因客户端在链的末端请求资源而通过链传递时由容器调用。 |
public void init(FilterConfig filterConfig) | 该方法由 Web 容器调用,指示一个过滤器被放入服务。 |
public void destroy() | 该方法由 Web 容器调用,指示一个过滤器被取出服务。 |
Filter的生命周期
Filter的创建和销毁由web服务器负责。
1.Filter的创建
web应用程序启动时,web服务器将创建Filter的实例对象,并调用其init方法,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作,filter对象只会创建一次,init方法也只会执行一次。通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象。
在 init 方法使用 FilterConfig 对象获取参数:
public void init(FilterConfig config) throws ServletException {
// 获取初始化参数
String name=config.getInitParameter("name");
System.out.println(name);
}
2.Filter的调用
web服务器在调用doFilter方法时,会传递一个filterChain对象进来,filterChain对象是filter接口中最重要的一个对象,它也提供了一个doFilter方法,开发人员可以根据需求决定是否调用此方法,调用该方法,则web服务器就会调用web资源的service方法,即web资源就会被访问,否则web资源不会被访问。
Filter链/filterChain
在一个web应用中,可以开发编写多个Filter,这些Filter组合起来称之为一个Filter链。web服务器根据Filter在web.xml文件中的注册顺序,决定先调用哪个Filter,当第一个Filter的doFilter方法被调用时,web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中,开发人员如果调用了FilterChain对象的doFilter方法,则web服务器会检查FilterChain对象中是否还有filter,如果有,则调用第2个filter,如果没有,则调用目标资源。
3.Filter的销毁
web容器调用destroy方法销毁Filter。destroy方法在Filter的生命周期中仅执行一次。在destroy方法中,可以释放过滤器使用的资源。
public void destroy() {
System.out.println("销毁登录过滤器");
}
Filter过滤器实例
Filter开发分为2步:
* 编写java类实现Filter接口,并实现其doFilter方法。
* 在web.xml 文件中使用和元素对编写的filter类进行注册,并设置它所能拦截的资源。
(1)编写过滤器
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.io.PrintWriter;
import java.text.SimpleDateFormat;
import java.util.GregorianCalendar;
@WebFilter(filterName = "LoginFilter")
public class LoginFilter implements Filter {
public void init(FilterConfig config) throws ServletException {
//获取初始化参数
String name=config.getInitParameter("name");
//输出初始化参数top
System.out.println(name);
}
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
HttpServletRequest hsr=(HttpServletRequest)req;
//获取输入账户
String name=hsr.getParameter("name");
//验证登录账户
if("top".equals(name)){
// 获取客户机的 IP 地址
String ipAddress = req.getRemoteAddr();
// 记录 IP 地址和当前时间戳
System.out.println("IP " + ipAddress + ", Time "
+ new SimpleDateFormat("HH:mm:SS").format(new GregorianCalendar().getTime()));
// 把请求传回过滤链
chain.doFilter(req, resp);
return;
}
/*登录验证失败*/
resp.setContentType("text/html;charset=UTF-8");
PrintWriter pw=resp.getWriter();
pw.println("<html>\n" +
"<head>\n" +
" <title></title>\n" +
"</head>\n" +
"<body>\n" +
" <h1>"+"账号不存在"+"</h1>" +
"</body>\n" +
"</html>");
}
public void destroy() {
System.out.println("销毁登录过滤器");
}
}
使用之前的ServletDemo:
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Calendar;
import java.util.GregorianCalendar;
/**
* Created by Top on 2017/12/5.
*/
public class ServletDemo extends javax.servlet.http.HttpServlet {
public ServletDemo() {
System.out.println("实例化servlet");
}
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("调用servlet");
// 设置刷新自动加载时间为 5 秒
resp.setIntHeader("Refresh", 5);
// 设置响应内容类型
resp.setContentType("text/html");
//获取当前时间
Calendar calendar = new GregorianCalendar();
String am_pm;
int hour = calendar.get(Calendar.HOUR);
int minute = calendar.get(Calendar.MINUTE);
int second = calendar.get(Calendar.SECOND);
if(calendar.get(Calendar.AM_PM) == 0)
am_pm = "AM";
else
am_pm = "PM";
String CT = hour+":"+ minute +":"+ second +" "+ am_pm;
System.out.println(CT);
resp.setCharacterEncoding("UTF-8");
PrintWriter pw=resp.getWriter();
pw.println("<html>\n" +
" <head>\n" +
" <title>"+"调用servlet"+"</title>\n" +
" </head>\n" +
" <body>\n" +
" <h1>\n"+
" 当前时间:"+CT+
" </h1>\n" +
" </body>\n" +
"</html>");
}
@Override
public void init() throws ServletException {
System.out.println("初始化servlet");
String a=this.getInitParameter("a");
String b=this.getInitParameter("b");
System.out.println(a);
System.out.println(b);
}
@Override
public void init(ServletConfig config) throws ServletException {
System.out.println("初始化有参servlet");
super.init(config);
}
@Override
public void destroy() {
System.out.println("销毁servlet");
}
}
(2)Web.xml 中的Filter过滤器映射(Filter Mapping)
定义过滤器,然后映射到一个 URL 或 Servlet,这与定义 Servlet,然后映射到一个 URL 模式方式大致相同。
在部署描述文件 web.xml 中为 filter 标签创建:
<filter>
<filter-name>login</filter-name>
<filter-class>filter.LoginFilter</filter-class>
<init-param>
<param-name>name</param-name>
<param-value>top</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>login</filter-name>
<!--配置拦截URL-->
<url-pattern>*.do</url-pattern>
</filter-mapping>
使用多个过滤器以及过滤器的应用顺序
Web 应用程序可以根据特定的目的定义若干个不同的过滤器。假设您定义了两个过滤器 AuthenFilter 和 LoginFilter。只需在部署文件中声明不同的映射,其余的处理与上述所讲解的大致相同。
web.xml 中的 filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。若要反转过滤器的顺序,您只需要在 web.xml 文件中反转 filter-mapping 元素即可。
web.xml配置各节点说明
<filter>指定一个过滤器。
<filter-name>用于为过滤器指定一个名字,该元素的内容不能为空。
<filter-class>元素用于指定过滤器的完整的限定类名。
<init-param>元素用于为过滤器指定初始化参数,它的子元素<param-name>指定参数的名字,<param-value>指定参数的值。
在过滤器中,可以使用FilterConfig接口对象来访问初始化参数。
<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定:Servlet 名称和资源访问的请求路径
<filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
<url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
<servlet-name>指定过滤器所拦截的Servlet名称。
<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARD和ERROR之一,默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截。
<dispatcher>子元素可以设置的值及其意义
REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。
INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
Filter监听器
(推荐:https://www.cnblogs.com/tabchanj/p/5516340.html)