SpringMVC源码系列-拦截器

最新推荐文章于 2024-08-08 15:10:28 发布

Adam_allen

最新推荐文章于 2024-08-08 15:10:28 发布

阅读量585

点赞数

分类专栏： springmvc 文章标签： Interceptor

本文链接：https://blog.csdn.net/Adam_allen/article/details/80159106

版权

springmvc 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

1.简介
2.重要的接口及类
- 2.1 HandlerInterceptor
- 2.2 HandlerInterceptorAdapter
3.执行流程
4.拦截器的使用
5.源码分析
6.多拦截器的执行情况
- 6.1配置多个拦截器
- 6.2 各种情况下执行情况
总结

1.简介

Spring MVC的处理器拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。
1、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。
2、权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；
3、性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间

2.重要的接口及类

2.1 HandlerInterceptor

要实现拦截器的功能，你就必须实直接或者间接实现这个接口：

package org.springframework.web.servlet;
public interface HandlerInterceptor {
    boolean preHandle(
            HttpServletRequest request, HttpServletResponse response, 
            Object handler) 
            throws Exception;

    void postHandle(
            HttpServletRequest request, HttpServletResponse response, 
            Object handler, ModelAndView modelAndView) 
            throws Exception;

    void afterCompletion(
            HttpServletRequest request, HttpServletResponse response, 
            Object handler, Exception ex)
            throws Exception;
}

我们可能注意到拦截器一个有3个回调方法，返回true，表示继续执行，返回false，表示拦截不继续执行

1.preHandle：预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器；返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应

2.postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。

3.afterCompletion：整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间
并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。

2.2 HandlerInterceptorAdapter

有时候我们可能只需要实现三个回调方法中的某一个，如果实HandlerInterceptor接口的话，三个方法必须实现，不管你需不需要，此时spring提供了一个HandlerInterceptorAdapter适配器（一种适配器设计模式的实现），允许我们只实现需要的回调方法。

public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {
     //省略代码 此处所以三个回调方法都是空实现，preHandle返回true。
}

适配器就是人家帮助你实现了接口，但是实现接口的方法体内容为空，你用的时候需要继承人家，然后重写人家的方法。

3.执行流程

这里写图片描述

4.拦截器的使用

下面我们来完成一个登录检测的功能，在访问某些资源时（如订单页面），需要用户登录后才能查看，因此需要进行登录检测。
流程：
1、访问需要登录的资源时，由拦截器重定向到登录页面；
2、如果访问的是登录页面，拦截器不应该拦截；
3、用户登录成功后，往cookie/session添加登录成功的标识（如用户编号）；
4、下次请求时，拦截器通过判断cookie/session中是否有该标识来决定继续流程还是到登录页面；
5、在此拦截器还应该允许游客访问的资源。

4.1 继承HandlerInterceptorAdapter

重写preHandle方法

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, 
Object handler) throws Exception {
    //1、请求到登录页面 放行
    if(request.getServletPath().startsWith(loginUrl)) {
        return true;
    }

    //2、TODO 比如退出、首页等页面无需登录，即此处要放行 允许游客的请求

    //3、如果用户已经登录 放行  
    if(request.getSession().getAttribute("username") != null) {
        //更好的实现方式的使用cookie
        return true;
    }

    //4、非法请求 即这些请求需要登录后才能访问
    //重定向到登录页面
    response.sendRedirect(request.getContextPath() + loginUrl);
    return false;
}

4.2 在spring-mvc.xml配置拦截器

<!--配置拦截器-->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <!--排除静态资源映射-->
            <mvc:exclude-mapping path="/static/**"/>
            <bean class="com.shangfu.interceptor.LoginInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>

4.3 Controller编写

完成登陆功能即可，自己随便写

5.源码分析

//doDispatch方法
//1、处理器拦截器的预处理（正序执行）
HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();
if (interceptors != null) {
    for (int i = 0; i < interceptors.length; i++) {
    HandlerInterceptor interceptor = interceptors[i];
        if (!interceptor.preHandle(processedRequest, response, mappedHandler.getHandler())) {
            //1.1、失败时触发afterCompletion的调用
            triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
            return;
        }
        interceptorIndex = i;//1.2、记录当前预处理成功的索引
}
}
//2、处理器适配器调用我们的处理器
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
//当我们返回null或没有返回逻辑视图名时的默认视图名翻译
if (mv != null && !mv.hasView()) {
    mv.setViewName(getDefaultViewName(request));
}
//3、处理器拦截器的后处理（逆序）
if (interceptors != null) {
for (int i = interceptors.length - 1; i >= 0; i--) {
      HandlerInterceptor interceptor = interceptors[i];
      interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);
}
}
//4、视图的渲染
if (mv != null && !mv.wasCleared()) {
render(mv, processedRequest, response);
    if (errorView) {
        WebUtils.clearErrorRequestAttributes(request);
}
//5、触发整个请求处理完毕回调方法afterCompletion
triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);

// triggerAfterCompletion方法
private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,
            HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {
        // 5、触发整个请求处理完毕回调方法afterCompletion （逆序从1.2中的预处理成功的索引处的拦截器执行）
        if (mappedHandler != null) {
            HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();
            if (interceptors != null) {
                for (int i = interceptorIndex; i >= 0; i--) {
                    HandlerInterceptor interceptor = interceptors[i];
                    try {
                        interceptor.afterCompletion(request, response, mappedHandler.getHandler(), ex);
                    }
                    catch (Throwable ex2) {
                        logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
                    }
                }
            }
        }
    }

6.多拦截器的执行情况

6.1配置多个拦截器

自己按照上面的方法，再写三个类，然后配置，
他们的实现方法就是简单的打印一句话，证明他们执行了，好分析执行顺序

<!-- 配置拦截器 -->
<mvc:interceptors>
    <!-- 多个拦截器，按顺序执行 -->        
    <mvc:interceptor>
        <mvc:mapping path="/**"/> <!-- 表示拦截所有的url包括子url路径 -->
        <bean class="ssm.interceptor.HandlerInterceptor1"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="ssm.interceptor.HandlerInterceptor2"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="ssm.interceptor.HandlerInterceptor3"/>
    </mvc:interceptor>
</mvc:interceptors>

6.2 各种情况下执行情况

1.三个拦截器都放行

HandlerInterceptor1….preHandle 
HandlerInterceptor2….preHandle 
HandlerInterceptor3….preHandle

HandlerInterceptor3….postHandle 
HandlerInterceptor2….postHandle 
HandlerInterceptor1….postHandle

HandlerInterceptor3….afterCompletion 
HandlerInterceptor2….afterCompletion 
HandlerInterceptor1….afterCompletion

根据打印的结果做一个总结：当所有拦截器都放行的时候，preHandle方法是按照配置的顺序执的；而另外两个方法按照配置的顺序逆向执行的。

2.有一个拦截器不放行

HandlerInterceptor1….preHandle 
HandlerInterceptor2….preHandle 
HandlerInterceptor3….preHandle

HandlerInterceptor2….afterCompletion 
HandlerInterceptor1….afterCompletion

根据打印的结果做一个总结：
a. 由于拦截器1和2放行，所以拦截器3的preHandle才能执行。也就是说前面的拦截器放行，后面的拦截器才能执行preHandle。
b. 拦截器3不放行，所以其另外两个方法没有被执行。即如果某个拦截器不放行，那么它的另外两个方法就不会背执行。
c. 只要有一个拦截器不放行，所有拦截器的postHandle方法都不会执行，但是只要执行过preHandle并且放行的，就会执行afterCompletion方法。

3.三个拦截器都不放行