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()方法來實現過濾器更多的功能。