JavaWeb学习笔记（二十二）—— 过滤器filter

一、什么是过滤器

　　过滤器filter是JavaWeb三大组件之一，它与Servlet很相似！不过过滤器是用来拦截请求的，而不是处理请求的。WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

　　Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，如下所示：

二、Filter是如何实现拦截的？

　　Filter接口中有一个doFilter方法，当我们编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：

调用目标资源之前，让一段代码执行。
是否调用目标资源（即是否让用户访问web资源）。
调用目标资源之后，让一段代码执行。

　　web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

三、Filter开发入门

　　第一步：写一个类实现Filter接口

public class HelloFilter implements Filter {
    /**
     * 创建之后马上执行,用来做初始化
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    /**
     * 每次过滤时都会执行
     */
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("AFilter#start");
        chain.doFilter(request, response);
        System.out.println("AFilter#end");
    }

    /**
     * 销毁之前执行,用来对非内存资源进行释放
     */
    @Override
    public void destroy() {

    }
}

　　第二步:在web.xml中进行配置

<filter>
    <filter-name>helloFilter</filter-name>
    <filter-class>cn.itcast.filter.HelloFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>helloFilter</filter-name>
    <!--指定要拦截的路径,当用户访问index.jsp页面时,HelloFilter就会被执行-->
    <url-pattern>/index.jsp</url-pattern>
</filter-mapping>

四、Filter的生命周期

【Filter的创建】——init(FilterConfig)：

　　Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作，filter对象只会创建一次，init方法也只会执行一次。通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

【Filter的销毁】——destroy()

　　服务器会在创建Filter对象之后，把Filter放到缓存中一直使用，通常不会销毁它。一般会在服务器关闭时销毁Filter对象，在销毁Filter对象之前，服务器会调用Filter对象的destory()方法。

【doFilter方法】

　　doFilter(ServletRequest req,ServletResponse res,FilterChain chain)：这个方法会在用户每次访问“目标资源（<url->pattern>index.jsp</url-pattern>）”时执行，如果需要“放行”，那么需要调用FilterChain的doFilter(ServletRequest,ServletResponse)方法，如果不调用FilterChain的doFilter()方法，那么目标资源将无法执行；

五、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()：获取所有初始化参数的名称。

六、FilterChain

　　doFilter()方法的参数中有一个类型为FilterChain的参数，它只有一个方法：doFilter(ServletRequest,ServletResponse)。

　　前面我们说doFilter()方法的放行，让请求流访问目标资源！但这么说不严密，其实调用该方法的意思是，“我（当前Filter）”放行了，但不代表其他人（其他过滤器）也放行。

　　也就是说，一个目标资源上，可能部署了多个过滤器，就好比在你去北京的路上有多个打劫的匪人（过滤器），而其中第一伙匪人放行了，但不代表第二伙匪人也放行了，所以调用FilterChain类的doFilter()方法表示的是执行下一个过滤器的doFilter()方法，或者是执行目标资源！

　　如果当前过滤器是最后一个过滤器，那么调用chain.doFilter()方法表示执行目标资源；如果不是最后一个过滤器，那么chain.doFilter()表示执行下一个过滤器的doFilter()方法。

七、多个过滤器的执行顺序

　　一个目标资源可以指定多个过滤器，过滤器的执行顺序是在web.xml文件中的部署顺序。

　　MyFilter1：

public class MyFilter1 extends HttpFilter {
    public void doFilter(HttpServletRequest request, HttpServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("filter1 start...");
        chain.doFilter(request, response);//放行，执行MyFilter2的doFilter()方法
        System.out.println("filter1 end...");
    }
}

　　MyFilter2：

public class MyFilter2 extends HttpFilter {
    public void doFilter(HttpServletRequest request, HttpServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("filter2 start...");
        chain.doFilter(request, response);//放行，执行目标资源
        System.out.println("filter2 end...");
    }
}

　　web.xml

<filter>
    <!--因为MyFilter1配置在前面，所以先执行MyFilter1的doFilter()方法。-->
    <filter-name>myFilter1 </filter-name>
    <filter-class>cn.itcast.filter.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>cn.itcast.filter.MyFilter2</filter-class>
</filter>
<filter-mapping>
    <filter-name>myFilter2</filter-name>
    <url-pattern>/index.jsp</url-pattern>
</filter-mapping>

　　index.jsp

  <body>
    This is my JSP page. <br>
    <h1>index.jsp</h1>
    <%System.out.println("index.jsp"); %>
  </body>

　　当有用户访问index.jsp页面时，输出结果如下：

filter1 start...
filter2 start...
index.jsp
filter2 end...
filter1 end...

八、四种拦截方式

　　我们来做个测试，写一个过滤器，指定过滤的资源为b.jsp，然后我们在浏览器中直接访问b.jsp，你会发现过滤器执行了！

　　但是，当我们在a.jsp中request.getRequestDispathcer(“/b.jsp”).forward(request,response)时，就不会再执行过滤器了！也就是说，默认情况下，只能直接访问目标资源才会执行过滤器，而forward执行目标资源，不会执行过滤器！

　　其实过滤器有四种拦截方式！分别是：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>子元素，来说明当前访问的拦截方式。

<filter-mapping>
    <filter-name>myfilter</filter-name>
    <url-pattern>/b.jsp</url-pattern>
    <!--b.jsp为目标资源，当直接请求b.jsp时，会执行过滤器-->
    <dispatcher>REQUEST</dispatcher>
    <!--当转发到b.jsp页面时，会执行过滤器-->
    <dispatcher>FORWARD</dispatcher>
</filter-mapping>

<!--当没有给出拦截方式时，那么默认为REQUEST-->
<filter-mapping>
    <filter-name>myfilter</filter-name>
    <url-pattern>/b.jsp</url-pattern>
</filter-mapping>

<filter-mapping>
    <filter-name>myfilter</filter-name>
    <url-pattern>/b.jsp</url-pattern>
    <!--当转发到b.jsp页面时，会执行过滤器！
        因为已经给出了<dispatcher>FORWARD</dispatcher>了，
        那么就没有默认的REQUEST了！所以只有在转发到b.jsp时才会执行过滤，
        而转发到b.jsp时，不会执行b.jsp-->
    <dispatcher>FORWARD</dispatcher>
</filter-mapping>

九、过滤器的应用场景

　　过滤器的应用场景：

执行目标资源之前做预处理工作，例如设置编码，这种试通常都会放行，只是在目标资源执行之前做一些准备工作；（
几乎是的Sevlet中都需要写request.setCharacterEndoing() 可以把它入到一个Filter中）
通过条件判断是否放行，例如校验当前用户是否已经登录，或者用户IP是否已经被禁用；
在目标资源执行后，做一些后续的特殊处理工作，例如把目标资源输出的数据进行处理；

　　下面通过几个具体的案例来说明过滤器的应用:

9.1 统一全站字符编码

乱码问题：

获取请求参数中的乱码问题；
- POST请求：request.setCharacterEncoding(“utf-8”)；
- GET请求：new String(request.getParameter(“xxx”).getBytes(“iso-8859-1”), “utf-8”)；
响应的乱码问题：response.setContextType(“text/html;charset=utf-8”)。

　　基本上在每个Servlet中都要处理乱码问题，所以应该把这个工作放到过滤器中来完成。

参考：https://www.cnblogs.com/xdp-gacl/p/3948353.html

posted @ 2019-03-13 23:01 yi0123 阅读(287) 评论(0) 编辑收藏举报

刷新页面返回顶部

我的Java故居