Servlet下监听器、过滤器和SpringMVC的拦截器总结分析

青旅半醒 2022-02-23 11:18 319阅读 0赞

### Servlet下监听器、过滤器和SpringMVC的拦截器 ###

#### Listener ####

Servlet提供了三种监听器接口，分别是ServletContext事件监听器、ServletRequest事件监听器、HttpSession事件监听器。  
  声明Listener有两种方式

1.  通过WebListener注解
2.  通过在web.xml中配置

<listener>
            <listener-class>com.huqi.Listener</listener-class>
     </listener>

##### ServletContext事件监听器（web容器生命周期监听器） #####

**1. ServleContextListener**  
  
  实现ServletContextListener要实现其init和destroy方法，即可以实现对web容器的初始化和销毁做处理。  
  
  使用场景减少，多用于容器初始化时加载一些配置文件信息  
  
**2. ServletContextAttributeListener**  
  
  该接口提供三个方法：ServletContext的改变、增加、删除都会触发监听，很少用。

##### ServletRequest事件监听器（Servlet监听器） #####

我们知道到Web容器接收到http请求后，然后由其创建一个HttpServlRequest和HttpServletResponse,HttpServletRequest继承自ServletRequest。  
  
**1. ServletRequestListener**  
  
  和ServletContext一样，实现ServletRequestListener需要实现他的init和destroy方法，用于监听请求的初始化和销毁。  
  
**2. ServletRequestAttributeListener**  
  
  该接口提供三个方法： 用于ServletRequest的改变、增加、删除都会触发监听，很少用。

##### HttpSession事件监听器(用于Session的监听) #####

**1. HttpSessionListener**

实现HttpSessionListener，需要实现SessionCreated和SessionDestroy方法，用于监听Session创建和销毁时，自定义动作。

**2. HttpSessionAttributeListener**

HttpSessionAttributeListener主要是提供了对session的全局属性的增加、移除、修改接口，用于监听session中存放的属性值发送变化时，自定义动作。

**2. HttpSessionAttributeListener**  
  
  HttpSessionAttributeListener主要是提供了对session的全局属性的增加、移除、修改接口，用于监听session中存放的属性值发送变化时，自定义动作。

**3. HttpSessionBindingListener**

HttpSessionBindingListener和HttpSessionAttributeListener很类似，其提供了Bound和Unbound方法监听session中存放的属性值进入和取消

但和HttpSessionAttributeListener不一样的是，其不需要用@WebListener或者web.xml中声明，而是通过entry去继承HttpSessionBindingListener，当该实体的对象被加入Session前后，实体类会去做一些操作。

**4 HttpSessionActivationListener**

对象迁移监听器，一般用于分布式系统，当Session需要在服务器上迁移时，实现监听并自定义操作。

--------------------

#### 过滤器Fiter ####

##### 过滤器能解决什么问题？ #####

我们知道，web容器接收到http请求，创建一个httpServletRequest和httpServletResponse并给Service，由Service去根据Request的方法去对应执行get/post方法。  
  
可能会有如下场景：

1.  需要对传来的参数做统一验证/过滤/转码：如果在对应doGet/DoPost方法再做处理，代码冗余严重。
2.  对部分接口只对特殊用户开放：在过滤器做拦截无疑是一个好的选择。

##### 过滤器具体实现 #####

1.  实现Filter接口，重写doFilter方法
2.  通过WebFilter注解，或者在web.xml配置

//注解
    @WebFilter(
            filterName = "myFilter",
            urlPatterns = "/*"
    )
    //配置：先声明Filter，再配置Filter生效范围
        <filter>
            <filter-name>myFilte</filter-name>
            <filter-class>MyFilter</filter-class>
        </filter>
        <filter-mapping>
            <filter-name>myFilte</filter-name>
            <url-pattern>/*</url-pattern>
        </filter-mapping>

1.  doFilter()方法中，可以获得request对象，对其进行编码，该类的过滤方法执行完成后，调用filterChain.doFilter(request,response)执行其他过滤器，执行完后，才会执行Service方法，当Service方法执行结束后，又会递归向上执行filter的后置处理

@WebFilter(
            filterName = "myFilter",
            urlPatterns = "/*"
    )
    public class MyFilter implements Filter {
    
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
    
        }
    
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
           HttpServletRequest request = (HttpServletRequest) servletRequest;
            if ("POST".equals(request.getMethod())){
                request.setCharacterEncoding("utf-8");
            }else {
                request = new MyRequsetWapper(request,"IOS88-59");
            }
            // filter前置处理
            filterChain.doFilter(request,servletResponse);
            // filter后置处理 多个filter时递归调用
        }
    }

##### filter扩展：请求/响应封装器 #####

HttpServletRequstWrapper、HttpServletResponseWrapper不是过滤器，不需要去做配置，他们是实现ServletRequest和ServletResponse的两个类  
  
  当需要对请求/响应做额外的操作时，用户可以继承HttpServletRequstWrapper、HttpServletResponseWrapper，重写他们的方法，在必要的地方调用（一般是在过滤器中）

// 这是考虑到因为Post方法可以直接通过request.setCharacterEncoding处理
    //而Get不能，所以重写了getParameter方法进行转码
    public class MyRequsetWapper extends HttpServletRequestWrapper {
        String encoding = null;
        public MyRequsetWapper(HttpServletRequest request,String encoding) {
            super(request);
            this.encoding = encoding;
        }
    
        @Override
        public String getParameter(String name) {
            String vlaue = super.getParameter(name);
            try {
                return new String(vlaue.getBytes("ISO-8859-1"),"utf-8");
            } catch (UnsupportedEncodingException e) {
                e.printStackTrace();
            }
            return null;
        }
    }

#### SpringMvc的拦截器 ####

依赖于web框架，在SpringMVC中就是依赖于SpringMVC框架。在实现上基于Java的反射机制，属于面向切面编程（AOP）的一种运用。由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）进行一些业务操作，同时一个拦截器实例在一个controller生命周期之内可以多次调用。但是缺点是只能对controller请求进行拦截，对其他的一些比如直接访问静态资源的请求则没办法进行拦截处理。

#### 运用场景 ####

1、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。

2、权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；

3、性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；

4、通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。

5、OpenSessionInView：如hibernate，在进入处理器打开Session，在完成后关闭Session。

#### 具体实现 ####

1.  实现HandlerInterceptor 接口
2.  继承实现了HandlerInterceptor接口的类,如HandlerInterceptorAdapter

##### HandlerInterceptor接口 #####

public interface HandlerInterceptor {
    
        /** 
             * 在业务处理器处理请求之前被调用 
             * 如果返回false 
             *     从当前的拦截器往回执行所有拦截器的afterCompletion(),再退出拦截器链
             *     
             * 如果返回true 
             *    执行下一个拦截器,直到所有的拦截器都执行完毕 
             *    再执行被拦截的Controller 
             *    然后进入拦截器链, 
             *    从最后一个拦截器往回执行所有的postHandle() 
             *    接着再从最后一个拦截器往回执行所有的afterCompletion() 
             */
        boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
                throws Exception;
        /**
             * 在业务处理器处理请求执行完成后,生成视图之前执行的动作   
             * 可在modelAndView中加入数据，比如当前时间
             */
        void postHandle(
                HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
                throws Exception;
         /** 
             * 在DispatcherServlet完全处理完请求后被调用,可用于清理资源等    
             * 当有拦截器抛出异常时,会从当前拦截器往回执行所有的拦截器的afterCompletion() 
             */
        void afterCompletion(
                HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
                throws Exception;
    
    }

实现HandlerInterceptor的方法，做具体的业务逻辑，然后再spring-MVC.xml中配置。

<mvc:interceptors> 
               <mvc:interceptor>
                        
                       <mvc:mapping path="/**" /> 
                         
                       
                       <bean id="commonInterceptor" class="CommonInterceptor"></bean> 
              </mvc:interceptor> 
              
        </mvc:interceptors>

#### 过滤器和拦截器区别： ####

（1）拦截器是基控制反转。

（2）拦截器不依赖于servlet容器，而过滤器依赖于servlet容器。

（3）拦截器只能对Controller请求起作用，而过滤器则可以对几乎所有的请求起作用。

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