十二、WEB项目开发之Spring拦截器

（一）主要作用

  SpringMVC 中的Interceptor 拦截器也是相当重要和相当有用的，它的主要作用是拦截用户的请求并进行相应的处理。比如通过它来进行权限验证，或者是来判断用户是否登陆，或者是像12306 那样子判断当前时间是否是购票时间。

（二）Spring拦截器的使用

  SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的，HandlerInterceptor 接口中定义了三个方法，我们就是通过这三个方法来对用户的请求进行拦截处理的：

  （1）

preHandle (HttpServletRequest request, HttpServletResponse response, Object handle)

方法，顾名思义，该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。

  （2）

postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView)

方法，由preHandle 方法的解释我们知道这个方法包括后面要说到的afterCompletion 方法都只能是在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用。postHandle 方法，顾名思义就是在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行，这和Struts2 里面的Interceptor 的执行过程有点类型。Struts2 里面的Interceptor 的执行过程也是链式的，只是在Struts2 里面需要手动调用ActionInvocation 的invoke 方法来触发对下一个Interceptor 或者是Action 的调用，然后每一个Interceptor 中在invoke 方法调用之前的内容都是按照声明顺序执行的，而invoke 方法之后的内容就是反向的。

  （2）

afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex)

方法，该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

（三）案例演示

  1、创建拦截器

package com.imooc.interceptor;

import com.imooc.bean.SysUser;
import com.imooc.constant.SessionKeyConst;
import com.imooc.dao.SysUserDao;
import com.imooc.util.Md5Util;
import com.imooc.util.SpringContextHolder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

/**
 * 拦截Session，判断是否登录（HandlerInterceptor是Spring提供的拦截器，不是原生JDK的拦截器）
 * @author **
 * @date 2018/6/13 11:37
 */
public class SessionInterceptor implements HandlerInterceptor {
    private static final Logger LOGGER = LoggerFactory.getLogger(SessionInterceptor.class);
    /**
     * 在进入Handler方法（就是Controller中映射路径对应的方法）执行之前执行本方法
     * @return  true：执行下一个拦截器，直到所有的拦截器都执行完毕，再执行拦截的Controller中的Handler方法
     *         false：从当前的拦截器往回执行所有拦截器的afterCompletion()方法，再退出拦截器链，不再执行Handler方法
     */
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        HttpSession session = httpServletRequest.getSession();
        //若Session中有User，说明用户已经登录，可以继续执行后续代码
        if (session.getAttribute(SessionKeyConst.SESSION_USER) != null){
            return true;
        }
        //验证Cookie中是否有登陆标识
        if (validateLoginWithCookie(httpServletRequest)){
            return true;
        }
        //若Session中没有User，说明用户未登录或登录超时，跳转到登录界面
        httpServletRequest.getRequestDispatcher("/login/sessionTimeout").forward(httpServletRequest, httpServletResponse);
        return false;
    }

    private boolean validateLoginWithCookie(HttpServletRequest httpServletRequest) {
        String loginToken = "";
        Cookie[] cookies = httpServletRequest.getCookies();
        if (cookies != null && cookies.length >){
            for (Cookie cookie : cookies){
                if (SessionKeyConst.SESSION_LOGIN_TOKEN.equals(cookie.getName())){
                    loginToken = cookie.getValue();
                }
            }
        }
        if (!loginToken.trim().equals("")){
            //切割出userId
            String[] strs = loginToken.split(":");
            String md5Str = strs[];
            String userId = strs[];
            //因为拦截器启动的时候，SysUserDao还未注入到Spring容器中，所以通过@AutoWired无法注入SysUserDao对象
            SysUserDao sysUserDao = SpringContextHolder.getBean(SysUserDao.class);
            SysUser sysUser = sysUserDao.selectUserWithId(Integer.parseInt(userId));
            if (sysUser != null){
                //因为这个时候，LoginServiceImpl不一定能注入到Spring容器中，所以它生成token的方法这里没法调用，老老实实自己写
                String str = Md5Util.getMD5WithSalt(sysUser.getUsername()+sysUser.getPassword(), SessionKeyConst.ENCRYPT_SALT);
                //经过相同加密手段得到的字符串相同，则说明通过验证
                if (md5Str.equals(str)){
                    //构建Session，供服务器内做已登录跳转（这步必须做，否则内部跳转还是需要登录！！）
                    httpServletRequest.getSession().setAttribute(SessionKeyConst.SESSION_USER, sysUser);
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * 在进入Handler方法之后，返回ModelAndView之前执行（就是拿到了Handler方法的返回值之后）
     */
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {

    }
    /**
     * 在Handler方法执行完之后执行
     */
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

    }
}
           

  2、在Spring中配置拦截器

<!-- 配置Spring拦截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <!-- 拦截所有的请求 -->
            <mvc:mapping path="/**"/>
            <!-- 由于上面配置了拦截所有的请求，而我们在登录时，需要跳转到登录页面的请求也会被拦截，而拦截了之后，需要
            验证是否登录，未登录，则需要跳转到登录页，这就陷入了一个死循环，所以这里就将所有的登录请求全部排除在外 -->
            <mvc:exclude-mapping path="/login/**"/>
            <!-- 将所有的api请求全部排除在外 -->
            <mvc:exclude-mapping path="/api/**"/>
            <!-- 因为是所有的访问都被拦截，包括静态资源，所以这里就需要将所有的静态资源请求全部排除在外 -->
            <mvc:exclude-mapping path="/resources/**"/>
            <!-- 拦截器的具体实施逻辑，这里面主要是验证Session中是否有登录用户 -->
            <bean class="com.imooc.interceptor.SessionInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
           

  备注：在配置拦截器的过程中，需要特别注意的是：

  （1）拦截所有的请求是

/**

，不是

/*

，两颗星，不是一颗星

  （2）一旦配置了拦截路径为

/**

，拦截器会拦截所有的请求，包括对“CSS/JS/images”等静态资源的请求，所以为了保证我们页面的正常显示，需要将这部分路径排除在外