过滤器（Filter）和监听器（Listener）

一、过滤器

Filter（过滤器）并不是一个标准的Servlet ，它不能处理用户请求，也不能对客户端生成响应。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

过滤器在执行过程中任何时候都可以打断，只要不执chain.doFilter()方法就不会再执行后面的过滤器和请求的内容。因此，要特别注意过滤链的执行顺序问题。假如在逻辑出现两次doFilter会导致有些页面会执行两次。

（一）Filter开发步骤

1、编写java类实现Filter接口，并重写其方法

例如：字符编码的 Filter

package 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;
/**
 * Description:
 * 设置编码格式的filter
 * @author lee
 */
public class ContentType implements Filter{
   
    private String charset;
    private boolean enabled;

    @Override
    public void destroy() {}

    /**
     * Description：
     * 设置编码格式
     */
    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
            throws IOException, ServletException {
        //设置编码格式
        if(enabled && charset!=null)
            resp.setCharacterEncoding(charset);

        //执行doFilter方法，放行,进入目标资源或下一个过滤器
        chain.doFilter(req, resp);
    }
    @Override
    public void init(FilterConfig config) throws ServletException {
        charset = config.getInitParameter("charset");
        enabled = "ture".equals(config.getInitParameter("enabled"));
    }
}

2、在 web.xml 文件中使用和元素对过滤器进行注册，并指定拦截资源。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
            xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" 
            id="WebApp_ID" 
            version="3.1">
  <display-name>web</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>

  <!-- 注册监听器 -->

  <filter>
    <!-- 监听器名称 -->
    <filter-name>charset</filter-name>
    <!-- 监听器的class全称，包名+类名 -->
    <filter-class>filter.ContentType</filter-class>
    <!-- 初始化参数 -->
    <init-param>
        <param-name>charset</param-name>
        <param-value>utf-8</param-value>
    </init-param>
    <init-param>
        <param-name>enabled</param-name>
        <param-value>true</param-value>
    </init-param>
  </filter>

  <filter-mapping>
    <filter-name>charset</filter-name>
    <!-- 
    设置 filter 所拦截的请求路径(过滤器关联的URL样式)
    值要与浏览器输入的地址相匹配，通过url-pattern查找指定的资源
    写法：
    1.完全匹配  要求以/开始，名称与url一致.
    2.使用通配符 *
    1.目录匹配   以/开始,以*结束.
    2.扩展名匹配 不能以/开始，以*.xxx对束
    （目录匹配和扩展名匹配不能同时使用，例如 /*.jsp） 
    -->
    <!-- /*意味着拦截所有资源 -->
    <url-pattern>/*</url-pattern>

    <!-- 根据servlet的内部名称拦截，拦截名内部名称为Servlet的servlet -->
    <servlet-name>Servlet</servlet-name>

    <!-- 
    指定过滤器所拦截的资源被 Servlet 容器调用的方式。用户可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。
    REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
    INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
    FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
    ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用 
    -->
    <dispatcher>REQUEST</dispatcher>
  </filter-mapping>

</web-app>

Filter链
多个Filter的访问先后顺序由 配置在前面的Filter 执行要早于配置在后面的Filter决定 。
（关于在<url-pattern> 元素中，的匹配方式可以参考另外一篇博客Servlet编程基础 中的映射路径）

这里也可以通过注解在注册过滤器，例如

@WebFilter(filterName="过滤器名称",urlPattern="需要进行过滤的url")

（二）Filter的生命周期

过滤器是服务器启动的时候创建和初始化，当有请求访问时就会调用过滤器的doFilter方法，当关闭服务器的时候就会调用destroy方法销毁过滤器。

public void init(FilterConfig filterConfig) throws ServletException;
//1、Filter的创建和销毁由WEB服务器负责。web应用程序启动时创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能。

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;
//2、当客户请求访问与过滤器关联的URL的时候，将先执行doFilter方法。

public void destroy();//销毁
//3、Filter对象创建后会驻留在内存，当web应用移除或服务器停止时才销毁。

（三）FilterConfig对象

在web.xml配置文件可以为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，初始化参数。
例如在web.xml文件中，配置filter初始化参数：

<!-- 部分代码 -->
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
            xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" 
            id="WebApp_ID" 
            version="3.1">
  <display-name>web</display-name>

  <filter>
    <filter-name>charset</filter-name>
    <filter-class>filter.ContentType</filter-class>
    <!-- 初始化参数 -->
    <init-param>
        <param-name>name1</param-name>
        <param-value>value1</param-value>
    </init-param>
  </filter>

  <filter-mapping>
    <filter-name>charset</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-app>

然后，我们就可以在filter中使用FilterConfig获取这些初始化参数：

//部分代码

public class ContentType implements Filter{
   
    FilterConfig config;
    @Override
    public void destroy() {
        config=null;}

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
            throws IOException, ServletException {
        //获取初始化参数
        Enumeration e = config.getInitParameterNames();
        while(e.hasMoreElement){
            paramName = e.nextElement();
            paramValue = e.getInitParameter(paramName);
        }
    }
    @Override
    public void init(FilterConfig config) throws ServletException {
        this.config = config;}
}

（四）过滤器案例

1、执行公用业务代码
2、无效数据过滤（引入ckeditor客户端组件）