java web filter 之一 基礎實現

本文主要對filter的基本使用進行了講解，其中涉及到了

      filter是什麼

      一個filter處理一個jsp

      多個filter處理一個jsp

filter是什麼

       Filter 是java下的一種過濾器 ，能實現對java web程序 客戶端和服務器端消息的過濾，也就是在服務器段接受request之前，可以預先對request進行處理，或在客戶端接受response之前，對response進行處理。

       Filter的使用非常靈活，是在“鏈”到客戶端和服務器之間的，在需要時可以配置到客戶端與服務器之間，在不需要時可以去掉。filter還可以設置其對發送到哪些頁面或從哪些頁面發出的消息進行過濾，即是一中橫切性的編程，可插拔。Filter執行的大致過程如下圖

 

       實現filter相關的功能，需要實現javax.servlet.jar包下的filter接口，該接口有三個方法，分別是init doFilter，destory方法，把需要執行某些功能的代碼放到doFilter方法中

一個Filter處理一個jsp：

實現filter要實現javax.servlet包下的filter接口，本例子實現的是設置所有jsp也的字符編碼

package com.tgb.drp.util.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;

/**
 * 採用filter統一處理字符集
 *
 */
public class CharsetEncodingFilter implements Filter {
	
	private String encodeString;
        //Filter註銷方法
	@Override
	public void destroy() {
	

	}
        //filter要實現的功能
	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {
		System.out.println("begin");
		// 設置字符集
		request.setCharacterEncoding(encodeString);
		
		//繼續向下執行，如果還有其他filter繼續調用其他filter，沒有的話將消息發送給服務器或客戶端
		chain.doFilter(request, response);
		System.out.println("end");
	}
        //初始化方法
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		//
		encodeString=filterConfig.getInitParameter("encoding");
	}

}

寫好filter類後，需要在配置文件中設置對哪些request和response進行過濾處理，本例子設置對所有的jsp頁進行處理，在web.xml的web-app節點下，配置好後，可以寫一個jsp頁進行測試了。

    <filter>
    	<filter-name>CharsetEncodingFilter</filter-name>
    	<filter-class>com.tgb.drp.util.filter.CharsetEncodingFilter</filter-class>
    	<init-param>
    		<param-name>encoding</param-name>
    		<param-value>GBK</param-value>
    	</init-param>
    </filter>
    <filter-mapping>
    	<filter-name>CharsetEncodingFilter</filter-name>
    	<url-pattern>*.jsp</url-pattern>
    </filter-mapping>

多個filter處理一個jsp頁

       如果想實現多個filter對同一個jsp頁進行處理，例如既需要設置字符編碼，又需要驗證身份，只需要在在寫好響應的filter後繼續配置在web.xml裏。我們繼續上面的例子，再寫一個驗證身份的Filter，命名爲AuthenticationFilter，代碼如下

package com.tgb.drp.util.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.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;


public class AuthenticationFilter implements Filter {

	@Override
	public void destroy() {

	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {
		//控制用戶訪問權限
		HttpServletRequest req=(HttpServletRequest)request;
		HttpServletResponse res=(HttpServletResponse)response;
		HttpSession session=req.getSession();

		if(session.getAttribute("user_info")!=null){
			chain.doFilter(request, response);
		}else{
			res.sendRedirect(req.getContextPath()+"/error.html");
		}
	}

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

	}

}

然後在配置文件裏繼續進行下配置，代碼如下

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4" 
	xmlns="http://java.sun.com/xml/ns/j2ee" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
	http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
  	<welcome-file-list>
        <welcome-file>index.html</welcome-file>

    </welcome-file-list> 
    <filter>
    	<filter-name>CharsetEncodingFilter</filter-name>
    	<filter-class>com.tgb.drp.util.filter.CharsetEncodingFilter</filter-class>
    	<init-param>
    		<param-name>encoding</param-name>
    		<param-value>GBK</param-value>
    	</init-param>
    </filter>
    <filter-mapping>
    	<filter-name>CharsetEncodingFilter</filter-name>
    	<url-pattern>*.jsp</url-pattern>
    </filter-mapping>
    
    <filter>
    	<filter-name>AuthenticationFilter</filter-name>
    	<filter-class>com.tgb.drp.util.filter.AuthenticationFilter</filter-class>
    </filter>
    <filter-mapping>
    	<filter-name>AuthenticationFilter</filter-name>
    	<url-pattern>*.jsp</url-pattern>
    </filter-mapping>
	
	<session-config>
		<session-timeout>60</session-timeout>
	</session-config>
</web-app>

好了到此就可以設置兩個filter對一個jsp頁進行處理了，當啓動tomcat，訪問響應的jsp頁時，設置的filter就會起作用。