JAVA WEB 三器之过滤器（Filter）

过滤器（Filter）

1. 简介 

　　过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息，它是 Servlet 技术中最实用的技术，属于系统级别，主要是利用函数的回调实现。对 Jsp， Servlet  静态图片文件或静态 html 文件等进行拦截。主要应用的场景有：如实现 URL 级别的权限访问控制、过滤敏感词汇、压缩响应信息、设置字符编码等一些高级功能。

　　它主要用于对用户请求进行预处理，也可以对HttpServletResponse 进行后处理。使用Filter 的完整流程：Filter 对用户请求进行预处理，接着将请求交给Servlet 进行处理并生成响应，最后Filter 再对服务器响应进行后处理。

　　Filter功能：

• 在HttpServletRequest 到达 Servlet 之前，拦截客户的 HttpServletRequest 。 根据需要检查 HttpServletRequest ，也可以修改HttpServletRequest 头和数据。
• 在HttpServletResponse 到达客户端之前，拦截HttpServletResponse 。 根据需要检查 HttpServletResponse ，也可以修改HttpServletResponse头和数据。

2. 方法

序号	方法
1	public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) 该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的 URL 时，Servlet 容器将先调用过滤器的 doFilter 方法。 FilterChain 用户访问后续过滤器。
2	public void init(FilterConfig filterConfig) web 应用程序启动时，web 服务器将创建 Filter 的实例对象，并调用其 init 方法，读取 web.xml 配置，完成对象的初始化功能， 从而为后续的用户请求作好拦截的准备工作（filter 对象只会创建一次，init 方法也只会执行一次）。开发人员通过 init 方法的参数， 可获得代表当前 filter 配置信息的 FilterConfig 对象。
3	public void destroy() Servlet 容器在销毁过滤器实例前调用该方法，在该方法中释放 Servlet 过滤器占用的资源。

3. 应用顺序

　　web.xml 中的 filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。

4. web.xml 文件配置信息

• <filter> 指定一个过滤器。
  • <filter-name> 用于为过滤器指定一个名字，该元素的内容不能为空。
  • <filter-class> 元素用于指定过滤器的完整的限定类名。
  • <init-param> 元素用于为过滤器指定初始化参数，它的子元素 <param-name> 指定参数的名字，<param-value> 指定参数的值。
  • 在过滤器中，可以使用 FilterConfig 接口对象来访问初始化参数。
• <filter-mapping> 元素用于设置一个 Filter 所负责拦截的资源。一个 Filter 拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
  • <filter-name> 子元素用于设置filter的注册名称。该值必须是在 <filter> 元素中声明过的过滤器的名字
  • <url-pattern> 设置 filter 所拦截的请求路径(过滤器关联的 URL 样式)
• <servlet-name> 指定过滤器所拦截的 Servlet 名称。
• <dispatcher> 指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是 REQUEST, INCLUDE, FORWARD 和 ERROR 之一，默认 REQUEST。用户可以设置多个 <dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。
• <dispatcher> 子元素可以设置的值及其意义
  • REQUEST：当用户直接访问页面时，Web 容器将会调用过滤器。如果目标资源是通过 RequestDispatcher 的 include() 或 forward() 方法访问时，那么该过滤器就不会被调用。
  • INCLUDE：如果目标资源是通过 RequestDispatcher 的 include() 方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
  • FORWARD：如果目标资源是通过 RequestDispatcher 的 forward() 方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
  • ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

5. 应用实例

（1）简单结构

public class AuthorityFilter implements Filter {
    
    /**
     * 销毁
     */
    @Override
    public void destroy() {
        
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        HttpSession session = request.getSession();
        
        boolean flag = false;
        if(xxx) {
             flag = false;
        } else {
            flag = true;
        }
        if (flag) {
            chain.doFilter(req, resp);
            return;
        } else {
            // 这是返回403错误
            response.sendError(HttpServletResponse.SC_FORBIDDEN, "");
            return;
        }
    }

    /**
     * 初始化
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        
    }

}            

web.xml 配置

<filter>
    <filter-name>authorityFilter</filter-name>
    <filter-class>com.jd.nw.filter.AuthorityFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>authorityFilter</filter-name>
    <url-pattern>*</url-pattern>
  </filter-mapping>

（2）中文乱码过滤器

项目使用spring框架时。当前台JSP页面和Java代码中使用了不同的字符集进行编码的时候就会出现表单提交的数据或者上传/下载中文名称文件出现乱码的问题，那就可以使用这个过滤器。

<filter>
    <filter-name>encoding</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name><!--用来指定一个具体的字符集-->
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name><!--true：无论request是否指定了字符集，都是用encoding；false：如果request已指定一个字符集，则不使用encoding-->
        <param-value>false</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>encoding</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

（3） Spring + Hibernate 的 OpenSessionInViewFilter 控制 session 的开关

　　当 hibernate + spring 配合使用的时候，如果设置了 lazy = true（延迟加载）,那么在读取数据的时候，当读取了父数据后，hibernate 会自动关闭 session，这样，当要使用与之关联数据、子数据的时候，系统会抛出 lazyinit 的错误，这时就需要使用 spring 提供的OpenSessionInViewFilter 过滤器。

　　OpenSessionInViewFilter 主要是保持 Session 状态直到 request 将全部页面发送到客户端，直到请求结束后才关闭 session，这样就可以解决延迟加载带来的问题。

　　注意：OpenSessionInViewFilter 配置要写在 struts2 的配置前面。因为 tomcat 容器在加载过滤器的时候是按照顺序加载的，如果配置文件先写的是 struts2 的过滤器配置，然后才是 OpenSessionInViewFilter 过滤器配置，所以加载的顺序导致，action 在获得数据的时候 session 并没有被 spring 管理。

<filter>
    <filter-name>OpenSessionInViewFilter</filter-name>
    <filter-class>org.springframework.orm.hibernate3.support.OpenSessionInViewFilter</filter-class>
    <init-param>
        <param-name>sessionFactoryBeanName</param-name><!-- 可缺省。默认是从spring容器中找id为sessionFactory的bean，如果id不为sessionFactory，则需要配置如下，此处SessionFactory为spring容器中的bean。 -->
        <param-value>sessionFactory</param-value>
    </init-param>
    <init-param>
        <param-name>singleSession</param-name><!-- singleSession默认为true,若设为false则等于没用OpenSessionInView -->
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>OpenSessionInViewFilter</filter-name>
    <url-pattern>*.do</url-pattern>
</filter-mapping>

6. 总结

　　过滤器顾名思义是用来过滤的，Java 的过滤器能够为我们提供系统级别的过滤，也就是说，能过滤所有的 web 请求，这一点，是拦截器无法做到的。在 Java Web 中，你传入的 request，response 提前过滤掉一些信息，或者提前设置一些参数，然后再传入 servlet 或者 action 进行业务逻辑，比如过滤掉非法 url，或者在传入servlet或者struts的action前统一设置字符集，或者去除掉一些非法字符。filter  流程是线性的，url 传来之后，检查之后，可保持原来的流程继续向下执行，被下一个 filter， servlet 接收。

参考资料：

https://www.cnblogs.com/CloverSH/p/4531492.html