Filter过滤器
什么是Filter
Filter被称为过滤器或拦截器,其基本功能就是对Servlet容器调用Servlet的过程进行拦截,从而在Servlet进行响应处理前后实现了一些特殊功能。
当浏览器访问服务器中的目标资源时,会被Filter拦截,在Filter中进行预处理操作,然后再将请求转发给目标资源。当服务器接收到这个请求后会对其进行响应,在服务器进行处理响应的过程中,也需要先将响应结果发送给拦截器,在拦截器中对响应结果进行处理后,才会发送给客户端。
其实,Filter过滤器就是一个实现了javax.servlet.Filter接口的类,在javax.servlet.Filter接口中定义了三个方法。
方法声明 | 功能描述 |
---|---|
init(FilterConfig filterConfig) | 用于来初始化过滤器,开发人员可以在方法中完成与构造方法类似的初始化功能,如果初始化代码中要使用到FilterConfig对象,那么这些初始化代码只能在Filter的init()方法中编写,而不能在构造方法中编写。 |
doFilter(ServletRequest request,ServletResponse response,FilterChain chain) | 方法有多个参数,其中参数request和response为Web服务器或Filter链中的上一个Filter传递过来的请求和响应对象;参数chain代表当前Filter链的对象,在当前Filter对象中的doFilter()方法内部需要调用FilterChain对象的doFilter()方法,才能把请求交付给Filter链中的下一个Filter或者目标程序去处理。 |
destroy() | 方法在Web服务器卸载Filter对象之前被调用,该方法用于释放被Filter对象打开的资源。 |
这三个方法都是Filter的生命周期方法,其中,init()方法在Web应用程序加载的时候调用,destroy()方法在Web应用程序卸载的时候调用,这两个方法都只会被调用一次,而doFilter()方法只要客户端请求被调用就会被调用,并且Filter所有的工作集中在doFilter()方法。
实现第一个Filter程序
1)创建一个filter的包,然后创建java程序
MyServlet.java
package filter;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet("/MyServlet")
public class MyServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
response.getWriter().write("Hello MyServlet");
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}
}
2)拦截MyServlet程序。创建过滤器MyFilter,用于拦截程序。
package filter;
import java.io.*;
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;
@WebFilter("/MyServlet")
public class MyFilter implements Filter {
public void destroy() {
// TODO Auto-generated method stub
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
PrintWriter out=response.getWriter();
out.write("Hello MyFilter");
}
public void init(FilterConfig fConfig) throws ServletException {
// TODO Auto-generated method stub
}
}
需要注意MyFilter的注解@WebFilter参数为/MyServlet,来拦截MyServlet的请求。
如果使用web.xml同样可以实现
<filter>
<filter-name>MyFilter</filter-name>
<filter-class>chapter04.MyFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>MyFilter</filter-name>
<url-pattern>/MyServlet</url-pattern>
</filter-mapping>
可以看到,在浏览器的地址栏访问MyServlet,却返回了MyFilter的结果。说明拦截成功。
Filter映射
1、使用通配符*拦截用于的所有请求
Filter的<filter-mapping>元素可以配置过滤器所有拦截的资源如果想让过滤器拦截所有的请求访问,那么需要使用通配符实现。
2、拦截不同方式的请求方式
在web.xml文件中,一个<filter-mapping>元素用于配置一个filter所负责拦截的资源。<filter-mapping>元素中有一个特殊的子元素<dispatcher>,该元素用于指定过滤器所拦截的资源被Servlet容器调用的方式,<dispatcher>元素的值共有4个。
1)REQUEST
当用户直接访问页面时,Web容器会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器将不会被调用。
2)INCLUDE
如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
3)FORWARD
如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
4)ERROR
如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
3、WebFilter设置拦截不同方式
@WebFilter(value="拦截地址",dispatcherTypes={参数1[,参数2...]})
参数通过javax.servlet.DispathcherType的静态属性获取。
例如REQUEST参数通过DispatcherType.REQUEST获取。
1)创建一个ServletTest.java,用于转发请求给first.jsp
package filter;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet("/ServletTest")
public class ServletTest extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
request.getRequestDispatcher("/first.jsp").forward(request, response);
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}
2)创建一个first.jsp页面,该页面用于输出。
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
first.jsp
</body>
</html>
3)创建一个FilterTest.java程序,专门用于拦截first.jsp页面
FilterTest.java
package filter;
import java.io.*;
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;
/**
* Servlet Filter implementation class FilterTest
*/
@WebFilter("/first.jsp")
public class FilterTest implements Filter {
public void destroy() {
// TODO Auto-generated method stub
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
PrintWriter out=response.getWriter();
out.write("Hello FilterTest");
}
public void init(FilterConfig fConfig) throws ServletException {
// TODO Auto-generated method stub
}
}
访问ServletTest
可以看到,请求没有被拦截,这是因为filter默认只拦截直接请求。
我们通过设置WebFilter参数来使其也拦截转发请求。
@WebFilter(value="/first.jsp",dispatcherTypes={DispatcherType.REQUEST,DispatcherType.FORWARD})
当然相同的效果通过修改web.xml也可以实现。
Filter链
在一个Web应用程序中可以注册多个Filter程序,每个Filter程序都可以针对某一个URL进行拦截。如果多个Filter程序都对同一个URL进行拦截,那么这些Filter就会形成一个Filter链(过滤器链)。Filter链用FilterChain对象来表示,FilterChain对象有一个doFilter()方法,该方法的作用就是让Filter链上的当前过滤器放行,请求进入下个Filter。
当浏览器访问Web服务器中的资源时需要经过两个过滤器Filter1和Filter2,首先Filter1会对这个请求进行拦截,在Filter1过滤器中处理好后,通过调用Filter1的doFilter()方法将请求传递给Filter2,Filter2同样请求处理后调用doFilter()方法,最终将请求发送给目标资源。当Web服务器对这个请求做出响应时,也会被过滤器拦截,这个拦截顺序与之前相反,最终将响应结果发送给客户端。
1)MyFilter01.java
package filter;
import java.io.*;
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;
@WebFilter("/MyServlet")
public class MyFilter01 implements Filter {
public void destroy() {
// TODO Auto-generated method stub
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
PrintWriter out=response.getWriter();
out.write("<html><head></head><body>");
out.write("Hello MyFilter01<br/>");
chain.doFilter(request, response);
out.write("</body></html>");
}
public void init(FilterConfig fConfig) throws ServletException {
// TODO Auto-generated method stub
}
}
2)MyFilter02.java
package filter;
import java.io.*;
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;
@WebFilter("/MyServlet")
public class MyFilter02 implements Filter {
public void destroy() {
// TODO Auto-generated method stub
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
PrintWriter out=response.getWriter();
out.write("MyFilter02 Before<br/>");
chain.doFilter(request, response);
out.write("MyFilter02 After<br/>");
}
public void init(FilterConfig fConfig) throws ServletException {
// TODO Auto-generated method stub
}
}
3)取消原MyFilter对MyServlet的拦截,防止影响实验。
需要注意的是,如果Filter映射是由wen.xml配置的,那么Filter链中各个Filter的拦截顺序与它们在web.xml文件中<filter-mapping>元素的映射顺序一致;如果映射是由注解配置的,那么容器会按照文件名的字典序加载文件,字典序靠前的优先拦截。
例如:MyFilter01字典序比MyFilter02的靠前,所有MyFilter01首先进行了拦截。
FilterConfig接口
为了获取Filter程序在web.xml文件中的配置信息,Servlet API提供了一个FilterConfig接口,该接口封装了Filter程序在web.xml中的所有注册信息,并且提供了一系列获取这些配置信息的方法。
方法声明 | 功能描述 |
---|---|
String getFilterName() | 方法用于返回在web.xml文件中为Filter所设置的名称,也就是返回<filter-name>元素的设置值 |
ServletContext getServletContext() | getServletContext()方法用于返回FilterConfig对象中所包装的ServletContext对象的引用 |
String getInitParameter(String name) | 方法用于返回在web.xml文件中为Filter所设置的某个名称的初始化参数值,如果指定名称的初始化参数不存在,则返回null |
Enumeration getInitParameterNames() | 方法用于返回一个集合对象,该集合对象中包含在web.xml文件中为当前Filter设置的所有初始化参数的名称 |
A_MyFilter03.java
package 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;
public class A_MyFilter03 implements Filter {
private String characterEncoding;
FilterConfig fc;
public void destroy() {
// TODO Auto-generated method stub
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
characterEncoding=fc.getInitParameter("encoding");
System.out.println("encoding初始化参数的值为:"+characterEncoding);
}
public void init(FilterConfig fConfig) throws ServletException {
this.fc=fConfig;
}
}
web.xml
<filter>
<filter-name>MyFilter03</filter-name>
<filter-class>filter.MyFilter03</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>GBK</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>MyFilter03</filter-name>
<url-pattern>/MyServlet</url-pattern>
</filter-mapping>
可以看到网页中没有输出,证明Myfilter03优先拦截了MyServlet,并且没有继续请求Filter链。
这是因为web.xml设置的映射优先级高于注解映射,不论字典序。
Filter高级应用
如果想对request和response对象中的任何信息进行修改,则需要通过保证类来实现。在Servlet API中,提供了HttpServletRequestWrapper和HttpServletResponseWrapper两个类,他们分别是request和response对象的包装类
装饰设计模式
HttpServletRequestWrapper和HttpServletResponseWrapper作为request和response对象的包装类,都采用了装饰设计模式。所谓装饰设计模式,指的是通过包装类的方式,动态的增强某个类的功能。
设计模式特点
1)包装类要和被包装类对象实现同样的接口。
2)包装类持有一个被包装类对象,例如,在HttpServletRequestWrapper定义的构造方法中,需要传递一个HttpServletRequest参数。
3)包装类在实现接口的过程中,对于不需要包装的方法原封不动地调用被包装地方法来实现,对于需要包装地方法自己实现。
Filter实现统一全站编码
在Web开发中,经常会遇到中文乱码问题,按照前面所学的知识,解决乱码的通常做法都是在Servlet程序中设置编码方式,但是多个Servlet程序都需要设置编码方式,势必会书写大量重复的代码。
为了解决上面的问题,可以在Filter中对获取到的请求和响应消息进行编码,从而统一全站编码方式。
1)编写form.jsp页面
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8" import="java.util.*"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<center>
<h3>用户登录</h3>
</center>
<body style="text-align:center;">
<a href="<%=request.getContextPath()%>/CharacterServlet?name=root&password=123">GET方式登录</a>
<from action="<%=request.getContextPath()%>/CharacterServlet" method="post">
<table>
<tr>
<td height="30" align="center">用户名:</td>
<td><input type="text" name="name"/></td>
</tr>
<tr>
<td height="30" align="center">密码:</td>
<td><input type="password" name="password"/></td>
</tr>
<tr>
<td height="30" align="center" colspan="2">
<input type="submit"/>
</td>
</tr>
</table>
</from>
</body>
</html>
2)编写CharacterServlet.java程序
package filter;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet("/CharacterServlet")
public class CharacterServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
System.out.println(request.getParameter("name"));
System.out.println(request.getParameter("password"));
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}
3)编写CharacterFilter.java过滤器
package filter;
import java.io.*;
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.http.*;
@WebFilter("/*")
public class CharacterFilter implements Filter {
public void destroy() {
// TODO Auto-generated method stub
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
HttpServletRequest req=(HttpServletRequest)request;
HttpServletResponse resp=(HttpServletResponse)response;
req.setCharacterEncoding("utf-8");
resp.setContentType("text/html;charset=utf-8");
CharacterRequest Creq=new CharacterRequest(req);
chain.doFilter(Creq, resp);
}
public void init(FilterConfig fConfig) throws ServletException {
// TODO Auto-generated method stub
}
}
class CharacterRequest extends HttpServletRequestWrapper{
public CharacterRequest(HttpServletRequest request) {
super(request);
}
public String getParameter(String name){
String value=super.getParameter(name);
if(value==null){
return null;
}
String method=super.getMethod();
if("get".equalsIgnoreCase(method)){
try{
value=new String(value.getBytes("iso-8859-1"),"utf-8");
}catch(UnsupportedEncodingException e){
throw new RuntimeException(e);
}
}
return value;
}
}
访问form.jsp
使用提交键登录
使用超链接登录
Filter实现页面静态化
在实际开发中,有时为了提高程序性能,减轻数据库压力以及对搜索引擎进行优化,可以使用Filter实现动态页面静态化。页面静态化就是先于用户获取资源或数据库数据进而通过静态化处理,生成静态页面,所有人都访问这一个静态页面,而静态化处理的页面的访问速度要比动态页面快得多,因此程序性能会有大大得提升。