FilterLog代码分析

Posted 2020-11-03 -zmj

1、Filter:Filter也称之为过滤器，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。Filter使用户可以改变一个request和修改一个response. Filter 不是一个servlet，它不能产生一个response，它能够在一个request到达servlet之前预处理request，也可以在response离开servlet时处理response。

　　2、实现Filter的3个方法：

• void init(FilterConfig config);用于完成Filter的初始化。
• void destroy();用于Filter销毁前，完成某些资源的回收。
• void doFilter(ServletRequest request, ServletResponse response, FilterChain chain);实现过滤功能，对每个请求及响应增加的额外处理.

3.核心代码分析

　　@WebFilter(filterName="log"

　　　　,urlPatterns={"/*"})//filterName指定该Filter的名称，urlPatterns指定该Filter所拦截的URL

　　public class LogFilter implements Filter

　　{

　　　　//FilterConfig可用于访问Filter的配置信息

　　　　private FilterConfig config;

　　　　//实现初始化方法

　　　　public void init(FilterConfig config)

　　　　{

　　　　　　this.config = config;

　　　　}

　　　　//实现销毁方法

　　　　public void destroy()

　　　　{　　

　　　　this.config = null;

　　　　}

　　　　//执行过滤的核心方法

　　　　public void doFilter(ServletRequest request,

　　　　　　ServletResponse response, FilterChain chain)//此方法的最后一个参数是FilterChain对象，此参数是用来调用servlet或JSP页。

　　　　　　throws IOException,ServletException

　　　　　{

　　　　　　　　//---------下面代码用于对用户请求执行预处理---------

　　　　　　　　//获取ServletContext对象，用于记录日志

　　　　　　　　ServletContext context = this.config.getServletContext();

　　　　　　　　long before = System.currentTimeMillis();

　　　　　　　　System.out.println("开始过滤...");

　　　　　　　　//将请求转换成HttpServletRequest请求

　　　　　　　　HttpServletRequest hrequest = (HttpServletRequest)request;

　　　　　　　　//输出提示信息

　　　　　　　　System.out.println("Filter已经截获到用户的请求的地址： " +

　　　　　　　　　　hrequest.getServletPath());

　　　　　　　　//Filter只是链式处理，请求依然放行到目的地址

　　　　　　　　chain.doFilter(request, response);

　　　　　　　　//---------下面代码用于对服务器响应执行后处理---------

　　　　　　　　long after = System.currentTimeMillis();

　　　　　　　　//输出提示信息

　　　　　　　　System.out.println("过滤结束");

　　　　　　　　//输出提示信息

　　　　　　　　System.out.println("请求被定位到" + hrequest.getRequestURI() +

　　　　　　　　　　　　" 所花的时间为: " + (after - before));

　　　　　　}　　

　　　　}

其中重要的方法实现是通过ServletContext context = this.config.getServletContext();获取ServletContext对象，用于记录日志和将请求转换成HttpServletRequest请求HttpServletRequest hrequest = (HttpServletRequest)request;以及chain.doFilter(request, response);几个对象的使用来实现。

4.filter例子

1.编写java类实现Filter接口，并实现其doFilter方法

package com.bjpowernode.drp.util.filter; 

import java.io.IOException; 
import javax.servlet.Filter; 
import javax.servlet.FilterChain; 
import javax.servlet.FilterConfig; 
mport javax.servlet.ServletException; 
import javax.servlet.ServletRequest; 
import javax.servlet.ServletResponse; 


public class CharseEncodingFilter implements Filter { 
//成员变量，存放读取filter配置文件中的信息 
private String endcoding; 
//销毁方法 
public void destroy() {} 
//filter核心方法 
public void doFilter(ServletRequest request, ServletResponse response, 
FilterChain chain) throws IOException, ServletException { 

//设置字符集 
//第一种方式直接填写字符编码的格式，这样不容易修改 
request.setCharacterEncoding("GB18030"); 
response.setCharacterEncoding("GB18030"); 

//第二种方式读取filter配置文件中的信息这样便于维护和修改字符编码格式 
request.setCharacterEncoding(endcoding); 
response.setCharacterEncoding(endcoding); 

//继续执行 
chain.doFilter(request, response); 
} 
//filter初始化 
public void init(FilterConfig arg0) throws ServletException { 
this.endcoding =arg0.getInitParameter("encoding"); //读取filter配置文件中的信息 
} 

}

     FilterConfig接口：用户在配置filter时，可以使用<init-param>为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。在编写filter时，通过filterConfig对象的方法，就可获得   
     String getFilterName()：得到filter的名称。　　   
     String getInitParameter(String name)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.    
     Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。    
     public ServletContext getServletContext()：返回Servlet上下文对象的引用。

2.配置web.xml

<filter>    
         <filter-name>CharseEncodingFilter</filter-name>   <!--别名-->  
         <filter-class>com.bjpowernode.drp.util.filter.CharseEncodingFilter</filter-class>    <!--执行操作的类-->  
         <init-param>     <!--参数-->  
               <param-name>encoding</param-name>    <!--参数名-->  
               <param-value>GBK</param-value>     <!--参数值-->  
         </init-param>         
    </filter>  
      
    <filter-mapping>      <!--定义需要过滤的资源-->  
         <filter-name>CharseEncodingFilter</filter-name>   <!--别名与上面的相同-->  
         <url-pattern>/sysmgr/user_modify.jsp</url-pattern>    <!--具体的页面-->  
    </filter-mapping>