SpringMVC学习笔记2_拦截器实现登录验证

本文记述如何使用SpringMVC提供的HandlerInterceptor 验证请求是否经过了登录页面的验证。

1.HandlerInterceptor 介绍

1.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;
} 

1.2 HandlerInterceptor 接口的源码分析

从上面的源码中可以看到，该接口一共有3个方法

preHandle：

预处理回调方法，实现处理器的预处理（如登录验证）


返回值：true表示继续流程（如调用下一个拦截器或处理器）；

             false表示流程中断（如登录验证失败），不会继续调用其他的拦截器或处理器，此时需要通过response来产生响应.

postHandle：

后处理回调方法，实现处理器的后处理（但在渲染视图之前），

此时可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。

afterCompletion：

整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，

类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion

2.自定义拦截器

实现思路：取得当前请求对应的session,如果session里存放的userId或者userName为空，

1.异步请求（ajax）的场合，强制输出缓存数据

2.同步请求的场合，则跳转到登录页面

2.1 SpringMVC xml配置

......
    <mvc:interceptors>
        <!-- permission check -->
        <mvc:interceptor>
            <!-- 需拦截的地址 -->
            <!-- 一级目录 -->
            <mvc:mapping path="/*.do"/>
            <mvc:mapping path="/*.ajax"/>
            <mvc:mapping path="/*.htm"/>
            <mvc:mapping path="/*.html"/>
            <bean class="com.xxx.interceptor.SessionCheckInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
......

2.2 Java代码

import java.io.PrintWriter;

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

import org.apache.log4j.Logger;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import com.xxx.UserLoginSession;
import com.xxx.controller.AbstractController;


public class SessionCheckInterceptor extends AbstractController implements HandlerInterceptor {
    private static Logger logger = Logger.getLogger(SessionCheckInterceptor.class);

     @Override
    public boolean preHandle(HttpServletRequest req, HttpServletResponse res, Object handler) throws Exception {
        // 取得用户登录Session
        UserLoginSession userLoginSession = getUserLoginSession(req);
        // 如果用户登录Session为空，或者userId的值为空或者userName的值为空
        if (userLoginSession == null || "".equals(userLoginSession.getUserId()) || "".equals(userLoginSession.getUserName())) {
            // 异步请求的场合
            if (req.getHeader("x-requested-with") != null &&
                    req.getHeader("x-requested-with").equalsIgnoreCase("XMLHttpRequest")) {
                res.setHeader("sessionstatus", "sessionTimeOut");
                PrintWriter wirter = res.getWriter();

                // 强制将缓冲区的数据输出
                wirter.flush();
                return false;
            } else {
            // 同步请求的场合
                String path = getPathUrl(req);
                logger.info("Interceptor中返回false");
                // 返回到登录页面
                res.sendRedirect(path + LOGIN_URL);
                return false;
            }
        } else {
            String USER_ID = userLoginSession.getUserId();
            logger.info("Interceptor中获取USER_ID: " + USER_ID);
        }
        logger.info("Interceptor中返回true");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest req, HttpServletResponse res, Object arg2, ModelAndView arg3) throws Exception {
    }

    @Override
    public void afterCompletion(HttpServletRequest req, HttpServletResponse res, Object arg2, Exception arg3) throws Exception {
    }

}