Spring MVC拦截器

这次我们主要看下Spring MVC的拦截器与它的用法，在看DispatchServlet的源码时候，可以看到interceptor在整个处理过程中都有它的影子。

image

如图：拦截器出现的位置

image

在处理请求前，处理请求后，完成请求时拦截器都会起作用。拦截器在请求的生命周期中都存在，可以用来记录请求日志，修改请求的参数等。我们根据一个实际案例来看看

案例

1. 搭建运行环境，参考前面写的Spring MVC入门，搭建好完整的Spring MVC运行环境。

2. 编写interceptor，拦截器必须要实现HandlerInterceptor接口。HandlerInterceptor有三个主要的方法：

• prehandle() 实际的处理器执行前，视图对象还未生成，如果返回true，代表请求会继续交给下一个拦截器处理，如果返回为false，那么DispatcherServlet假设请求已经处理响应，终止当前的请求处理。
• postHandle() 在Handler处理完之后执行，但是在DispatcherServlet渲染视图之前执行
• afterCompletion() 完成请求，并且视图也已经生成之后执行

这三个方法足够灵活应对我们要对请求做的各种处理了。

3. Interceptor的完整代码

public class LoggerInterceptor implements HandlerInterceptor {

    private Logger log = LoggerFactory.getLogger(LoggerInterceptor.class);


    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("[preHandle][" + request + "]" + "[" + request.getMethod()
                + "]" + request.getRequestURI() + getParameters(request));

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("[postHandle][" + request + "]");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        if (ex != null){
            ex.printStackTrace();
        }
        log.info("[afterCompletion][" + request + "][exception: " + ex + "]");
    }

    private String getParameters(HttpServletRequest request) {
        StringBuffer posted = new StringBuffer();
        Enumeration<?> e = request.getParameterNames();
        if (e != null) {
            posted.append("?");
        }
        while (e.hasMoreElements()) {
            if (posted.length() > 1) {
                posted.append("&");
            }
            String curr = (String) e.nextElement();
            posted.append(curr + "=");
            if (curr.contains("password")
                    || curr.contains("pass")
                    || curr.contains("pwd")) {
                posted.append("*****");
            } else {
                posted.append(request.getParameter(curr));
            }
        }
        String ip = request.getHeader("X-FORWARDED-FOR");
        String ipAddr = (ip == null) ? getRemoteAddr(request) : ip;
        if (ipAddr!=null && !ipAddr.equals("")) {
            posted.append("&_psip=" + ipAddr);
        }
        return posted.toString();
    }

    private String getRemoteAddr(HttpServletRequest request) {
        String ipFromHeader = request.getHeader("X-FORWARDED-FOR");
        if (ipFromHeader != null && ipFromHeader.length() > 0) {
            log.debug("ip from proxy - X-FORWARDED-FOR : " + ipFromHeader);
            return ipFromHeader;
        }
        return request.getRemoteAddr();
    }

}

4. 配置拦截器，可以使用Java代码配置，也可以使用XML的方式配置。

使用XML的配置:

    <mvc:interceptors>
        <bean class="me.aihe.LoggerInterceptor" />
    </mvc:interceptors>

5. 运行查看结果，可以看到我们写的拦截器已经生效了。我们的拦截器会记录所有访问我们应用的请求。

image

注意：
如果配置了多个Spring的拦截器， preHandle会按照配置的顺序执行，但是 postHandle和 afterCompletion会按照配置顺序的反向执行。

最后

这次我们一起看了下Spring MVC拦截器，做了一个简单的演示案例，希望能帮助到大家

参考

• Introduction to Spring MVC HandlerInterceptor