springmvc中的拦截器interceptor用法

1.配置拦截器

　　在springMVC.xml配置文件增加：

1  <mvc:interceptors>
2    <!-- 日志拦截器 -->
3    <mvc:interceptor>
4     <mvc:mapping path="/**" />
5     <mvc:exclude-mapping path="/static/**" />
6     <bean class="拦截器java代码路径" />
7    </mvc:interceptor>
8  </mvc:interceptors>

　　说明：

　　1）mvc:mapping 拦截器路径配置

　　2）mvc:exclude-mapping 拦截器不需要拦截的路径

在mvc:interceptors标签下声明interceptor主要有两种方式：

• 直接定义一个Interceptor实现类的bean对象。使用这种方式声明的Interceptor拦截器将会对所有的请求进行拦截。
• 使用mvc:interceptor标签进行声明。使用这种方式进行声明的Interceptor可以通过mvc:mapping子标签来定义需要进行拦截的请求路径。

　　2、样例：

 1 public class LogsInterceptor extends HandlerInterceptorAdapter {
 2
 3     private static final Logger logger = LoggerFactory.getLogger(LogsInterceptor.class);
 4
 5     private  NamedThreadLocal<String> logContext = new NamedThreadLocal<String>("log-id");
 6
 7     @Autowired
 8     private TLogDao logDao;
 9
10     /**
11      * preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前进行调用，
12      * SpringMVC中的Interceptor拦截器是链式的，可以同时存在多个Interceptor，
13      * 然后SpringMVC会根据声明的前后顺序一个接一个的执行，
14      * 而且所有的Interceptor中的preHandle方法都会在Controller方法调用之前调用。
15      * SpringMVC的这种Interceptor链式结构也是可以进行中断的，
16      * 这种中断方式是令preHandle的返回值为false，当preHandle的返回值为false的时候整个请求就结束了。
17      */
18     @Override
19     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
20         String host = request.getRemoteHost();
21         String url = request.getRequestURI();
22         TLogEntity entity = new TLogEntity();
23         entity.setCreateTime(new Timestamp(System.currentTimeMillis()));
24         entity.setCreateUser("admin");
25         entity.setIpAddress(host);
26         entity.setLogUrl(url);
27         entity.setIsSuccess("N");
28         logDao.save(entity);
29         logContext.set(entity.getLogId());
30
31         logger.debug("IP为---->>> " + host + " <<<-----访问了系统");
32         return true;
33     }
34
35     /**
36      * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。
37      * postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之 后， 也就是在Controller的方法调用之后执行，
38      * 但是它会在DispatcherServlet进行视图的渲染之前执行，也就是说在这个方法中你可以对ModelAndView进行操作。
39      * 这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用，
40      * 这跟Struts2里面的拦截器的执行过程有点像，
41      * 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法，
42      * Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor或者是调用action，
43      * 然后要在Interceptor之前调用的内容都写在调用invoke之前，要在Interceptor之后调用的内容都写在调用invoke方法之后。
44      */
45     @Override
46     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
47     }
48
49     /**
50      * 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。
51      * 该方法将在整个请求完成之后，也就是DispatcherServlet渲染了视图执行， 这个方法的主要作用是用于清理资源的，
52      */
53     @Override
54     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
55         String host = request.getRemoteHost();
56         String logId = logContext.get();
57         TLogEntity entity = logDao.findOne(logId);
58         entity.setIsSuccess("Y");
59         logDao.save(entity);
60
61         logger.debug("IP为---->>> " + host + " <<<-----访问成功");
62     }
63
64 }

　　在这个拦截器中，在方法执行前可以做session或权限的。

总结：

interceptor 的执行顺序大致为：

1. 请求到达 DispatcherServlet
2. DispatcherServlet 发送至 Interceptor ，执行 preHandle
3. 请求达到 Controller
4. 请求结束后，postHandle 执行
5. 

   拦截器1放行，拦截器2 preHandle才会执行。

   拦截器2 preHandle不放行，拦截器2 postHandle和afterCompletion不会执行。

   只要有一个拦截器不放行，postHandle不会执行。

6. 拦截器1 preHandle不放行，postHandle和afterCompletion不会执行。

   拦截器1 preHandle不放行，拦截器2不执行。

Spring 中主要通过 HandlerInterceptor 接口来实现请求的拦截，实现 HandlerInterceptor 接口需要实现下面三个方法：

• preHandle() – 在handler执行之前，返回 boolean 值，true 表示继续执行，false 为停止执行并返回。
• postHandle() – 在handler执行之后, 可以在返回之前对返回的结果进行修改
• afterCompletion() – 在请求完全结束后调用，可以用来统计请求耗时等等

参考链接

https://www.cnblogs.com/lcngu/p/7096597.html

https://www.cnblogs.com/junzi2099/p/8022058.html

https://www.cnblogs.com/moxiaotao/p/9663351.html