Filter
名为过滤器,是介于用户请求和web服务器之间的一种web组件,主要的作用是用于拦截用户的请求(request)和相应(response)并监视、修改或以某种方式处理正在通过的数据流。在编写完过滤器之后,你可以通过web.xml文件来对应多个JSP网页,可以让其移植性更强。
Filter链
你不仅可以通过1个过滤器来对应多个网站,也可以通过多个过滤器来对应一个网站。这些过滤器是通过链的形式从一个转接到下一个,这些过滤器是通过chain这个对象来传递的,有点类似数据结构内队列的概念,过滤器的调用先后顺序是先进先出。意思就是当调用过滤器的时候,哪个先被调用的当Servlet的service方法之后会后被后被回应,反之如果哪个后被调用的会先被回应。
Filter的3个重要方法
- init():这个方法在容器实例化过滤器时被调用,它主要设计用于使过滤器为处理做准备。该方法接受一个 FilterConfig 类型的对象作为输入。
- doFilter() :与 servlet 拥有一个 service() 方法来处理请求一样,过滤器拥有单个用于处理请求和响应的方法doFilter() 。这个方法接受三个输入参数:一个ServletRequest 、response 和一个 FilterChain 对象。
- destroy() :这个方法执行任何清理操作,这些操作可能需要在自动垃圾收集之前进行。
其中init( )方法和destroy( )方法在上一篇servlet学习中已经详细的提到过,另外doFilter()方法是类似像doget()和dopost()方法,相当于整个过滤器的主函数。
第一个小型Filter程序
我们定义2个简单的jsp网页
分别为
index.jsp
<%@ page language="java" import="java.util.*" contentType="text/html; charset=UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<base href="<%=basePath%>">
<title>Filter</title>
<meta http-equiv="pragma" content="no-cache">
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="expires" content="0">
<meta http-equiv="keywords" content="keyword1,keyword2,keyword3">
<meta http-equiv="description" content="This is my page">
<!--
<link rel="stylesheet" type="text/css" href="styles.css">
-->
</head>
<body>
This is index page. <br>
<%
System.out.println("处理过程结束");
%>
</body>
</html>
main.jsp
<%@ page language="java" import="java.util.*" contentType="text/html; charset=UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<base href="<%=basePath%>">
<title>My JSP 'main.jsp' starting page</title>
<meta http-equiv="pragma" content="no-cache">
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="expires" content="0">
<meta http-equiv="keywords" content="keyword1,keyword2,keyword3">
<meta http-equiv="description" content="This is my page">
<!--
<link rel="stylesheet" type="text/css" href="styles.css">
-->
</head>
<body>
This is Main page. <br>
</body>
</html>
接下来我们实现Filter类来实现我们的过滤器
Filter.java
这是一个过滤器,我们用到了
- chain.doFilter(request,response):这个表示的意思是这个通过链表来传递参数给下一个过滤器。但是当你只有一个过滤器的时候最好也把这句话写上,养成良好的编程习惯。
- System.out.println(“”):通过输出的方式查看Filter的3个方法是怎样被调用的和先后顺序。
package Test;
import java.io.IOException;
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.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* Servlet Filter implementation class Filter
*/
@WebFilter("/Test/Filter")
public class Filter implements javax.servlet.Filter {
/**
* Default constructor.
*/
public Filter() {
}
/**
* @see Filter#destroy()
*/
public void destroy() {
System.out.println("destroy ....FirstFilter ");
}
/**
* @see Filter#doFilter(ServletRequest, ServletResponse, FilterChain)
*/
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println("start .....dofilter....FirstFilter ");
chain.doFilter(request,response);
System.out.println("end .....dofiter....FirstFilter ");
}
/**
* @see Filter#init(FilterConfig)
*/
public void init(FilterConfig fConfig) throws ServletException {
System.out.println("init .......FirstFilter ");
}
}
secondfilter.java
package Test;
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;
/**
* Servlet Filter implementation class secondFilter
*/
@WebFilter("/secondFilter")
public class secondFilter implements Filter {
/**
* Default constructor.
*/
public secondFilter() {
}
/**
* @see Filter#destroy()
*/
public void destroy() {
System.out.println("destroy ....secondFilter ");
}
/**
* @see Filter#doFilter(ServletRequest, ServletResponse, FilterChain)
*/
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println("start ....secondFilter");
chain.doFilter(request, response);
System.out.println("end ....secondFilter");
}
/**
* @see Filter#init(FilterConfig)
*/
public void init(FilterConfig fConfig) throws ServletException {
System.out.println("init ....secondFilter");
}
}
最后记得配置我们的web.xml文件如下
还是要保证的第一点是filter-name参数一定要相同,否则就找不到对应的过滤器了,第二点是想要保证两次的url都是相同的,这样才会重定向到同一个网站上。
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" id="WebApp_ID" version="3.1">
<display-name>ServletFilterDemo</display-name>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
<welcome-file>index.jsp</welcome-file>
<welcome-file>default.html</welcome-file>
<welcome-file>default.htm</welcome-file>
<welcome-file>default.jsp</welcome-file>
</welcome-file-list>
<filter>
<filter-name>Filter</filter-name>
<filter-class>Test.Filter</filter-class>
</filter>
<filter-mapping>
<filter-name>Filter</filter-name>
<url-pattern>/index.jsp</url-pattern>
</filter-mapping>
<filter>
<filter-name>Fiter2</filter-name>
<filter-class>Test.secondFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>Fiter2</filter-name>
<url-pattern>/index.jsp</url-pattern>
</filter-mapping>
</web-app>
然后我们打开tomat服务,然后访问我们的jsp页面,通过console可以看到结果:
init .......Filter
init ....secondFilter
start .....dofilter....Filter
start ....secondFilter
end ....secondFilter
end .....dofiter....Filter
由结果可以验证我们Filter链的定义。这样一个简单的过滤器就完成了,接下来我们会学习通过重写doFilter()方法来实现过滤器更多的功能。