七、过滤器(Filter)、拦截器(Interceptor)、监听器(Listener)

七、过滤器(Filter)、拦截器(Interceptor)、监听器(Listener)

    1、过滤器（Filter）

        依赖于Servlet容器，是JavaEE标准，是在请求进入容器之后，还未进入Servlet之前进行预处理，并且在请求结束返回给前端这之间进行后期处理。在实现上，基于函数回调，它可以对几乎所有请求进行过滤，但是缺点是一个过滤器实例只能在容器初始化时调用一次。使用过滤器的目的，是用来做一些过滤操作，获取我们想要获取的数据，比如：在Javaweb中，对传入的request、response提前过滤掉一些信息，或者提前设置一些参数，然后再传入servlet或者Controller进行业务逻辑操作。通常用的场景是：在过滤器中修改字符编码（CharacterEncodingFilter）、在过滤器中修改HttpServletRequest的一些参数（XSSFilter（自定义过滤器）），如：过滤低俗文字、危险字符等。

        (1)、过滤器定义

public class FilterTest extends Filter {

    @Override
    protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        //FilterPre：在DispatcherServlet之前执行  
        System.out.println("############FilterTest doFilterInternal executed############");
        //将请求转发给过滤器链的下一个Filter
        filterChain.doFilter(request, response);
        //Filter After：在视图页面返回给客户端之前执行，但是执行顺序在Interceptor之后  
        System.out.println("############FilterTest doFilter after############");
    }
}

        (2)、注册自定义Filter

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean registrationBean() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new FilterTest());
        filterRegistrationBean.addUrlPatterns("/*");
        return filterRegistrationBean;
    }
}

        过滤器的运行是依赖于servlet容器，跟SpringMVC等框架并没有关系。并且，多个过滤器的执行顺序跟xml文件中定义的先后关系有关。

    2、拦截器（Interceptor）

        依赖于web框架，在SpringMVC中就是依赖于SpringMVC框架。在实现上，基于Java的反射机制，属于面向切面编程（AOP）的一种运用，就是在service或者一个方法前，调用一个方法，或者在方法后，调用一个方法，比如JDK动态代理就是拦截器的简单实现，在调用方法前打印出字符串（或者做其它业务逻辑的操作），也可以在调用方法后打印出字符串，甚至在抛出异常的时候做业务逻辑的操作。由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）获取IOC容器中的各个Bean，进行一些业务操作，同时一个拦截器实例在一个controller生命周期之内可以多次调用。但是缺点是只能对controller请求进行拦截，对其他的一些比如直接访问静态资源的请求则没办法进行拦截处理。

        (1)、拦截器定义

public class InterceptorTest implements HandlerInterceptor{

    /**
     * 在DispatcherServlet之前执行 
     * */
    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
        System.out.println("************BaseInterceptor preHandle executed**********");
        return true;
    }

    /**
     * 在controller执行之后的DispatcherServlet之后执行 
     * */
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3) throws Exception {
        System.out.println("************BaseInterceptor postHandle executed**********");
    }

    /**
     * 在页面渲染完成返回给客户端之前执行 
     * */
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {
        System.out.println("************BaseInterceptor afterCompletion executed**********");
    }
}

        (2)、注册自定义Interceptor

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    /**
     * 注册配置自定义拦截器
     * */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new InterceptorTest()).addPathPatterns("/**");
    }
}

    3、过滤器（Filter）和拦截器（Interceptor）的区别

        (1)、范围不同：过滤器是Servlet规范规定的，只能用于Web程序中，而拦截器既可以用于Web程序，也可以用于Application、Swing程序中。

        (2)、规范不同：过滤器是在Servlet规范中定义的，是Servlet容器支持的。而拦截器是在Spring容器内的，是Spring框架支持的。

        (3)、深度不同：过滤器只能在Servlet前后起作用，而拦截器能够深入到方法前后、异常抛出前后等，因为拦截器的使用具有更大的弹性，在Spring框架中优先使用拦截器。

        (4)、机制不同：过滤器是基于函数回调的，而拦截器是基于Java的反射机制。

        (5)、拦截器只能对action请求起作用，而过滤器则可以对几乎所有的请求起作用。

        (6)、拦截器可以访问action上下文、值栈里的对象，而过滤器不能访问。

        (7)、在action的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次。

        (8)、拦截器可以获取IOC容器中的各个bean，而过滤器就不行，这点很重要，在拦截器里注入一个service，可以调用业务逻辑。

    4、多个过滤器和多个拦截器的执行顺序

        拦截器（Interceptor）是基于Java的反射机制，而过滤器（Filter）是基于函数回调。从灵活性上说拦截器功能更强大些，Filter能做的事情，Interceptor都能做，而且可以在请求前，请求后执行，比较灵活。Filter主要是针对URL地址做一个编码的事情、过滤掉没用的参数、安全校验（比较泛的，比如登录不登录之类），太细的话，还是建议用interceptor。不过还是根据不同情况选择合适的。

    5、监听器

        监听器用于监听Web应用中某些对象的创建、销毁、增加、修改、删除等动作的发生，然后作出相应的响应处理。当监听范围的对象的状态发生变化的时候，服务器自动调用监听器对象中的方法。就是在Application，Session，Request三个对象创建消亡或者往其中添加修改删除属性时自动执行代码的功能组件。

        (1)、分类

            ①、按监听的对象划分可以分为：

                ServletContext对象的监听器，即ServletContextListener；

                HttpSession对象的监听器，即HttpSessionListener；

                ServletRequest对象的监听器，即ServletRequestListener；

            ②、按监听的事件划分可以分为：

                对象自身的创建和销毁的监听器

                对象中属性的创建和消除的监听器

                Session中的某个对象的状态变化的监听器

        (2)、自定义监听器

/**
 * 用监听器统计网站的在线人数
 * 注：Servlet3.0 以上版本，监听器的配置可以直接在代码中通过注解来完成，无需在web.xml中再配置
 **/

@WebListener
public class ListenerTest implements HttpSessionListener {

    //记录session的数量
    public int count=0;

    /**
     * 监听session的创建
     */
    public void sessionCreated(HttpSessionEvent arg0) {
        count++;
        arg0.getSession().getServletContext().setAttribute("Count", count);

    }

    /**
     * 监听session的撤销
     */
    @Override
    public void sessionDestroyed(HttpSessionEvent arg0) {
        count--;
        arg0.getSession().getServletContext().setAttribute("Count", count);
    }
}