详解HandlerInterceptor处理器拦截器的用法
HandlerInterceptor处理器拦截器用法
SpringMVC 中的HandlerInterceptor 拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。
（如无特殊说明，下文所说的拦截器即处理器拦截器）
SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。
在SpringMVC 中定义一个Interceptor 非常简单，主要有两种方式
- 第一种方式：是要定义的Interceptor类要实现了Spring 的HandlerInterceptor 接口，或者是这个类继承实现了HandlerInterceptor 接口的类，比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ；
- 第二种方式：是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。
1.拦截器接口
先看下面的拦截器接口：
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个回调方法，而一般的过滤器Filter才两个，这是怎么回事呢？马上分析。
preHandle
预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器（如：Controller实现）；
preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前进行调用，
* SpringMVC中的Interceptor拦截器是链式的，可以同时存在多个Interceptor，
* 然后SpringMVC会根据声明的前后顺序一个接一个的执行，
* 而且所有的Interceptor中的preHandle方法都会在Controller方法调用之前调用。
* SpringMVC的这种Interceptor链式结构也是可以进行中断的，
* 这种中断方式是令preHandle的返回值为false，当preHandle的返回值为false的时候整个请求就结束了。
返回值：true表示继续流程（如调用下一个拦截器或处理器）；
false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；
postHandle
后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。
* 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。
* postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之后， 也就是在Controller的方法调用之后执行，
* 但是它会在DispatcherServlet进行视图的渲染之前执行，也就是说在这个方法中你可以对ModelAndView进行操作。
* 这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用。
afterCompletion
整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。
* 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。
* 该方法将在整个请求完成之后，也就是DispatcherServlet渲染了视图执行， 这个方法的主要作用是用于清理资源的。
2.拦截器适配器
有时候我们可能只需要实现三个回调方法中的某一个，如果实现HandlerInterceptor接口的话，三个方法必须实现，不管你需不需要，此时spring提供了一个HandlerInterceptorAdapter适配器（一种适配器设计模式的实现），允许我们只实现需要的回调方法。
public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {
//省略代码 此处所以三个回调方法都是空实现，preHandle返回true。
} 正常运行流程图：
中断流程图：
中断流程中，比如是HandlerInterceptor4中断的流程（preHandle返回false），此处仅调用它之前拦截器HandlerInterceptor3的preHandle返回true的afterCompletion方法。
3.配置拦截器
使用mvc:interceptors标签来声明需要加入到SpringMVC拦截器链中的拦截器。
在springMVC.xml配置文件增加：
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/**" />
<mvc:exclude-mapping path="/static/**" />
<bean class="拦截器java代码路径" />
</mvc:interceptor>
</mvc:interceptors>说明：
- 1）mvc:mapping 拦截器路径配置
- 2）mvc:exclude-mapping 拦截器不需要拦截的路径
示例：
上面的示例可以看出可以利用mvc:interceptors标签声明一系列的拦截器，然后它们就可以形成一个拦截器链，拦截器的执行顺序是按声明的先后顺序执行的，先声明的拦截器中的preHandle方法会先执行，然而它的postHandle方法和afterCompletion方法却会后执行。
4.示例
下面是一个登录拦截器的例子：
package cn.wmyskxz.interceptor;
import cn.wmyskxz.pojo.User;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.util.Arrays;
/**
* 登录拦截器：
*/
public class LoginInterceptor extends HandlerInterceptorAdapter {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
HttpSession session = request.getSession();
String[] noNeedAuthPage = new String[]{
"/home",
"/searchProduct",
"/sortProduct",
"/showProduct",
"/loginPage",
"/login",
"/registerPage",
"/register",
"/registerSuccessPage",
"/test",
"/checkLogin",
"/admin"
};
String uri = request.getRequestURI();
if (!Arrays.asList(noNeedAuthPage).contains(uri)) {
User user = (User) session.getAttribute("user");
if (null == user) {
response.sendRedirect("/loginPage");
return false;
}
}
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
super.afterCompletion(request, response, handler, ex);
}
}该拦截器作用就是对于所有不需要授权的请求（字符串数组noNeedAuthPage中列出的），正常执行Controller，否则重定向到loginPage页面。
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
最近项目需要写个小功能，需求就是实时下载ftp指定文件夹下的所有文件（包括子目录）到本地文件夹中，保留文件到目录路径不变。今天小编给大家分享使用ftpClient下载ftp上所有文件的方法，需要的的朋友参考下吧2017-04-04
这篇文章主要为大家详细介绍了struts2实现文件下载功能，一个非常常见的功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-03-03
这篇文章主要介绍了Spring 开发过程中Value 注解的使用场景，帮助大家更好的理解和使用spring框架，感兴趣的朋友可以了解下2020-11-11
这篇文章主要为大家详细介绍了java设计模式之装饰者模式，装饰者模式是一种结构式模式，感兴趣的朋友可以参考一下2021-10-10
Spring Cloud使用Feign实现Form表单提交的示例
本篇文章主要介绍了Spring Cloud使用Feign实现Form表单提交的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-03-03
最近稍微有点空闲，回头再来优化下基础框架，也是一种重新学习。今天主要写写跟大家分享下springboot使用undertow，废话不多说2022-07-07
这篇文章主要介绍了springboot Mongodb的集成与使用实例详解,需要的朋友可以参考下2018-04-04
idea中创建scala项目有三种方式1.通过maven；2.通过idea；3.通过sbt的方式；本文就每种方法通过图文并茂的形式给大家详细介绍，需要的朋友参考下吧2021-07-07
这篇文章主要为大家详细介绍一下Spring Security异常处理机制，文中的示例代码讲解详细，对我们学习Spring Security有一定帮助，感兴趣的可以学习一下2022-07-07
本篇文章主要介绍了Java+mysql本地图片上传数据库及下载示例，具有一定的参加价值，有兴趣的可以了解一下。2017-01-01
最新评论