Java web----過濾器(Filter)

1 What is Filter?

過濾器JavaWeb三大組件之一，它與Servlet很相似！不它過濾器是用來攔截請求的，而不是處理請求的。

當用戶請求某個Servlet時，會先執行部署在這個請求上的Filter，如果Filter“放行”，那麼會繼承執行用戶請求的Servlet；如果Filter不“放行”，那麼就不會執行用戶請求的Servlet。

其實可以這樣理解，當用戶請求某個Servlet時，Tomcat會去執行註冊在這個請求上的Filter，然後是否“放行”由Filter來決定。可以理解爲，Filter來決定是否調用Servlet！當執行完成Servlet的代碼後，還會執行Filter後面的代碼。

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" 
	xmlns="http://java.sun.com/xml/ns/javaee" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
	http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
	
<filter>
	<filter-name>HelloFilter</filter-name>
	<filter-class>com.cug.filter.HelloFilter</filter-class>
</filter>

<filter-mapping>
	<filter-name>HelloFilter</filter-name>
	<url-pattern>/index.jsp</url-pattern>
</filter-mapping>

</web-app>

package com.cug.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;

public class HelloFilter implements Filter{

	@Override
	public void destroy() {
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {
		System.out.println("start doFilter~");
		chain.doFilter(request, response);
		System.out.println("end doFilter~");
	}

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
	}
	
}

2 過濾器的生命週期

我們已經學習過Servlet的生命週期，那麼Filter的生命週期也就沒有什麼難度了！

init(FilterConfig)：在服務器啓動時會創建Filter實例，並且每個類型的Filter只創建一個實例，從此不再創建！在創建完Filter實例後，會馬上調用init()方法完成初始化工作，這個方法只會被執行一次；
doFilter(ServletRequest req,ServletResponse res,FilterChain chain)：這個方法會在用戶每次訪問“目標資源（<url->pattern>index.jsp</url-pattern>）”時執行，如果需要“放行”，那麼需要調用FilterChain的doFilter(ServletRequest,ServletResponse)方法，如果不調用FilterChain的doFilter()方法，那麼目標資源將無法執行；
destroy()：服務器會在創建Filter對象之後，把Filter放到緩存中一直使用，通常不會銷燬它。一般會在服務器關閉時銷燬Filter對象，在銷燬Filter對象之前，服務器會調用Filter對象的destory()方法。

3 FilterConfig

Filter接口中的init()方法的參數類型爲FilterConfig類型。它的功能與ServletConfig相似，與web.xml文件中的配置信息對應。下面是FilterConfig的功能介紹：

ServletContext getServletContext()：獲取ServletContext的方法；
String getFilterName()：獲取Filter的配置名稱；與<filter-name>元素對應；
String getInitParameter(String name)：獲取Filter的初始化配置，與<init-param>元素對應；
Enumeration getInitParameterNames()：獲取所有初始化參數的名稱。

4 多個過濾器執行順序

一個目標資源可以指定多個過濾器，過濾器的執行順序是在web.xml文件中的部署順序：

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" 
	xmlns="http://java.sun.com/xml/ns/javaee" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
	http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
	
<filter>
	<filter-name>MyFilter1</filter-name>
	<filter-class>com.cug.filter01.MyFilter1</filter-class>
</filter>
<filter-mapping>
	<filter-name>MyFilter1</filter-name>
	<url-pattern>/index.jsp</url-pattern>
</filter-mapping>

<filter>
	<filter-name>MyFilter2</filter-name>
	<filter-class>com.cug.filter01.MyFilter2</filter-class>
</filter>
<filter-mapping>
	<filter-name>MyFilter2</filter-name>
	<url-pattern>/index.jsp</url-pattern>
</filter-mapping>

</web-app>

package com.cug.filter01;

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;

public class MyFilter1 implements Filter{

	@Override
	public void destroy() {
	}

	@Override
	public void doFilter(ServletRequest arg0, ServletResponse arg1,
			FilterChain arg2) throws IOException, ServletException {
		System.out.println("start MyFilter1~");
		arg2.doFilter(arg0, arg1);
		System.out.println("end MyFilter1");
	}

	@Override
	public void init(FilterConfig arg0) throws ServletException {
	}

}

package com.cug.filter01;

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;

public class MyFilter2 implements Filter{

	@Override
	public void destroy() {
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {
		System.out.println("start MyFilter2~");
		chain.doFilter(request, response);
		System.out.println("end MyFilte2~");
	}

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
	}
	
}

<%@ page language="java" import="java.util.*" pageEncoding="ISO-8859-1"%>
<%
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 'index.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 my JSP page. <br>
    <%
    	System.out.println("index.jsp");
    %>
  </body>
</html>

因爲MyFilter1配置在前面，所以先執行MyFilter1的doFilter()方法。

5 四種攔截方式

我們來做個測試，寫一個過濾器，指定過濾的資源爲b.jsp，然後我們在瀏覽器中直接訪問b.jsp，你會發現過濾器執行了！

但是，當我們在a.jsp中request.getRequestDispathcer(“/b.jsp”).forward(request,response)時，就不會再執行過濾器了！也就是說，默認情況下，只能直接訪問目標資源纔會執行過濾器，而forward執行目標資源，不會執行過濾器！

public class MyFilter extends HttpFilter {
	public void doFilter(HttpServletRequest request,
			HttpServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		System.out.println("myfilter...");
		chain.doFilter(request, response);
	}
}

	<filter>
		<filter-name>myfilter</filter-name>
		<filter-class>cn.itcast.filter.MyFilter</filter-class>
	</filter>
	<filter-mapping>
		<filter-name>myfilter</filter-name>
		<url-pattern>/b.jsp</url-pattern>
	</filter-mapping>

  <body>
   <h1>b.jsp</h1>
  </body>

  <h1>a.jsp</h1>
    <%
    	request.getRequestDispatcher("/b.jsp").forward(request, response);
    %>
  </body>

http://localhost:8080/filtertest/b.jsp-->直接訪問b.jsp時，會執行過濾器內容；

http://localhost:8080/filtertest/a.jsp--> 訪問a.jsp，但a.jsp會forward到b.jsp，這時就不會執行過濾器！

其實過濾器有四種攔截方式！分別是：REQUEST、FORWARD、INCLUDE、ERROR。

REQUEST：直接訪問目標資源時執行過濾器。包括：在地址欄中直接訪問、表單提交、超鏈接、重定向，只要在地址欄中可以看到目標資源的路徑，就是REQUEST；
FORWARD：轉發訪問執行過濾器。包括RequestDispatcher#forward()方法、<jsp:forward>標籤都是轉發訪問；
INCLUDE：包含訪問執行過濾器。包括RequestDispatcher#include()方法、<jsp:include>標籤都是包含訪問；
ERROR：當目標資源在web.xml中配置爲<error-page>中時，並且真的出現了異常，轉發到目標資源時，會執行過濾器。

可以在<filter-mapping>中添加0~n個<dispatcher>子元素，來說明當前訪問的攔截方式。

b.jsp爲目標資源，當直接請求b.jsp時，會執行過濾器

當轉發到b.jsp頁面時，會執行過濾器

	<filter-mapping>
		<filter-name>myfilter</filter-name>
		<url-pattern>/b.jsp</url-pattern>
		<dispatcher>REQUEST</dispatcher>
		<dispatcher>FORWARD</dispatcher>
	</filter-mapping>

當沒有給出攔截方式時，那麼默認爲REQUEST

	<filter-mapping>
		<filter-name>myfilter</filter-name>
		<url-pattern>/b.jsp</url-pattern>
	</filter-mapping>

當轉發到b.jsp頁面時，會執行過濾器！因爲已經給出了<dispatcher>FORWARD</dispatcher>了，那麼就沒有默認的REQUEST了！所以只有在轉發到b.jsp時纔會執行過濾

	<filter-mapping>
		<filter-name>myfilter</filter-name>
		<url-pattern>/b.jsp</url-pattern>
		<dispatcher>FORWARD</dispatcher>
	</filter-mapping>

其實最爲常用的就是REQUEST和FORWARD兩種攔截方式，而INCLUDE和ERROR都比較少用！其中INCLUDE比較好理解，我們這裏不再給出代碼，學員可以通過FORWARD方式修改，來自己測試。而ERROR方式不易理解，下面給出ERROR攔截方式的例子：

當用戶訪問a.jsp頁面時會拋出異常，即500了！

這時服務器會轉發到b.jsp，在這之前會執行過濾器！

	<filter-mapping>
		<filter-name>myfilter</filter-name>
		<url-pattern>/b.jsp</url-pattern>
		<dispatcher>ERROR</dispatcher>
	</filter-mapping>
	<error-page>
		<error-code>500</error-code>
		<location>/b.jsp</location>
	</error-page>

  <body>
  <h1>a.jsp</h1>
   <%
   if(true)
   	throw new RuntimeException("嘻嘻~");
   %>
  </body>

6 過濾器的應用場景

過濾器的應用場景：

執行目標資源之前做預處理工作，例如設置編碼，這種試通常都會放行，只是在目標資源執行之前做一些準備工作；
通過條件判斷是否放行，例如校驗當前用戶是否已經登錄，或者用戶IP是否已經被禁用；
在目標資源執行後，做一些後續的特殊處理工作，例如把目標資源輸出的數據進行處理；

7 設置目標資源

在web.xml文件中部署Filter時，可以通過“*”來執行目標資源：

	<filter-mapping>
		<filter-name>myfilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>

表示過濾所有資源

這一特性與Servlet完全相同！通過這一特性，我們可以在用戶訪問敏感資源時，執行過濾器，例如：<url-pattern>/admin/*<url-pattern>，可以把所有管理員才能訪問的資源放到/admin路徑下，這時可以通過過濾器來校驗用戶身份。

還可以爲<filter-mapping>指定目標資源爲某個Servlet，例如：

	<servlet>
		<servlet-name>myservlet</servlet-name>
		<servlet-class>cn.itcast.servlet.MyServlet</servlet-class>
	</servlet>
	<servlet-mapping>
		<servlet-name>myservlet</servlet-name>
		<url-pattern>/abc</url-pattern>
	</servlet-mapping>
	<filter>
		<filter-name>myfilter</filter-name>
		<filter-class>cn.itcast.filter.MyFilter</filter-class>
	</filter>
	<filter-mapping>
		<filter-name>myfilter</filter-name>
		<servlet-name>myservlet</servlet-name>
	</filter-mapping>

這裏沒有指定<url-pattern>，而是指定<servlet-name>！注意，它與某個Servlet的配置名稱相同！

當用戶訪問http://localhost:8080/filtertest/abc時，會執行名字爲myservlet的Servlet，這時會執行過濾器。

Java web----過濾器(Filter)

Java web----文件上傳

Java web----POST和GET中文編碼問題

Java web----過濾器(Filter)

Java web----國際化

JavaEE----使用Struts2的輸入校驗之手動編碼校驗

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結