Java Web(6) 过滤器Filter

过滤器(Filter)是 J2EE Servlet模块性的组件。Filter的作用是对URL进行统一的拦截处理。Filter通常用于应用程序层面进行全局处理。

1. 实现Filter

开发过滤器三要素

  • 任何过滤器都要实现javax.servlet.Filter接口
  • 在 Filter接口的 doFilter()方法中编写过滤器的功能代码。
  • 在web.xml中对过滤器进行配置,说明拦截URL的范围

接下来具体实现:

  • xml配置方式:
public class FirstFilter implements Filter {
    public void destroy() {
//...
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
       System.out.println("过滤器FirstFilter已生效");
       chain.doFilter(req,resp);
    }

    public void init(FilterConfig config) throws ServletException {
     //...
    }

}
<filter>
       <filter-name>First</filter-name>
       <filter-class>Filter.FirstFilter</filter-class>
   </filter>
    <filter-mapping>
        <filter-name>First</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
  • 注解@WebFilter配置方式
属性名 类型 描述
filterName String 指定过滤器的 name 属性,等价于 <filter-name>
value String[] 该属性等价于 urlPatterns 属性。但是两者不应该同时使用。
urlPatterns String[] 指定一组过滤器的 URL 匹配模式。等价于 <url-pattern> 标签。
servletNames String[] 指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值,或者是 web.xml 中 <servlet-name> 的取值。
dispatcherTypes DispatcherType 指定过滤器的转发模式。具体取值包括:ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。
initParams WebInitParam[] 指定一组过滤器初始化参数,等价于 <init-param> 标签。
asyncSupported boolean 声明过滤器是否支持异步操作模式,等价于 <async-supported> 标签。
description String 该过滤器的描述信息,等价于 <description> 标签。
displayName String 该过滤器的显示名,通常配合工具使用,等价于 <display-name> 标签。
@WebFilter(filterName = "FirstFilter", urlPatterns = "/*")
public class FirstFilter implements Filter { //...}

2. 过滤器生命周期

  • 初始化 :Filter.init()服务器启动后
  • 提供服务 :Filter.doFilter()
  • 销毁 :Filter.destroy()服务器关闭前
    过滤器对象在Web应用启动时被创建且全局唯一。唯一的过滤器 对象在并发环境中采用”多线程“提供服务。

3. 过滤器参数化

过滤器为了增强灵活性,允许配置信息放在web.xml。在web.xml中配置<init-param>设置过滤器参数

  • xml方式
<filter>
       <filter-name>First</filter-name>
       <filter-class>Filter.FirstFilter</filter-class>
        <init-param>
              <param-name>encoding</param-name>
              <param-value>UTF-8
        </init-param>
   </filter>
    <filter-mapping>
        <filter-name>First</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
public class FirstFilter implements Filter {
       String encoding;
         public void init(FilterConfig config) throws ServletException {
                encoding =  config.getInitParameter("encoding");
          }
......
    }
  • 注解方式
@WebFilter(filterName = "FirstFilter", urlPatterns = "/*",
        initParams = {
                @WebInitParam(name = "encoding",value = "UTF-8"),
                @WebInitParam(name = "P2",value = "V2")
        })
public class FirstFilter implements Filter {
       String encoding;
         public void init(FilterConfig config) throws ServletException {
                encoding =  config.getInitParameter("encoding");
          }
    }

4. 过滤链

过滤链

过滤器的执行顺序以<filter-mapping>的顺序为准。调用chain.doFilter()将请求向后转递。

  • xml方式
<filter>
       <filter-name>FilterA</filter-name>
       <filter-class>Filter.FilterA</filter-class>
   </filter>
    <filter-mapping>
        <filter-name>FilterA</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

<filter>
       <filter-name>FilterB</filter-name>
       <filter-class>Filter.FilterB</filter-class>
   </filter>
    <filter-mapping>
        <filter-name>FilterB</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

<filter>
       <filter-name>FilterC</filter-name>
       <filter-class>Filter.FilterC</filter-class>
   </filter>
    <filter-mapping>
        <filter-name>FilterC</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
public class FilterA implements Filter {
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
          System.out.println("A is printed")
           chain.doFilter(req,resp);
    }
}
public class FilterB implements Filter {
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
          System.out.println("B is printed")
           chain.doFilter(req,resp);
    }
}
public class FilterC implements Filter {
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
          System.out.println("C is printed")
           chain.doFilter(req,resp);
    }
}
public class FirstServlet extends HttpServlet {
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
       System.out.println("Servlet is printed")
    }
}

输出:

A is printed
B is printed
C  is printed
Servlet is printed

如果将输出语句位置调换

public class FilterA implements Filter {
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
           chain.doFilter(req,resp);
           System.out.println("A is printed")
    }
}

输出:

Servlet is printed
C  is printed
B is printed
A is printed

  • 注解方式
    使用注解方式时,过滤链按照名称的字典顺序,很不合理。

eg:字符集过滤器

Web中文乱码的解决

  • GET请求 :server.xml增加URIEncoding="UTF-8"
  • POST请求 :使用request.setCharacterEncoding("UTF-8")
  • 响应 response.setContentType("text/html;charset=UTF-8")
@WebFilter(filterName = "CharacterEncodingFilter")
public class CharacterEncodingFilter implements Filter {
    public void destroy() {
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
       //因为Tomcat中request的实现类继承自HttpServletRequest
        //所以可以转化为HttpServletRequest,以防ServletRequest不含有某些方法
        //详情见前面的 Java Web(3)HttpServletRequest和HttpServletResponse
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response =   (HttpServletResponse) resp;
        request.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
        chain.doFilter(request, response);

    }

    public void init(FilterConfig config) throws ServletException {
    }

}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 222,627评论 6 517
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 95,180评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 169,346评论 0 362
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 60,097评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 69,100评论 6 398
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,696评论 1 312
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,165评论 3 422
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,108评论 0 277
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,646评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,709评论 3 342
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,861评论 1 353
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,527评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,196评论 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,698评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,804评论 1 274
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,287评论 3 379
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,860评论 2 361