SpringMvc拦截器的实现

SpringMvc拦截器的实现一般有两种方式

第一种是实现要定义的Interceptor类要实现Spring的Handlnterceptor接口

第二种是继承实现了HanlerIntercepeor接口的类,比如实现了比如Spring已经提供的实现了HandlerInterceptor接口的抽象类HandlerInterceptorAdapter(其实是实现了AsyncHandlerInterceptor接口,不过AsyncHandlerInterceptor继承了HanlerIntercepeor接口)

实现HanlerIntercepeor接口

HandlerInterceptor 接口中定义了三个方法,我们就是通过这三个方法来对用户的请求进行拦截处理的。

1
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object object)

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

1
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)

这个方法在当前请求进行处理之后,也就是Controller 方法调用之后执行,但是它会在DispatcherServlet 进行视图返回渲染之前被调用,所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的,也就是说先声明的InterceptorpostHandle 方法反而会后执行。

1
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)

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

AsyncHandlerInterceptor接口还扩展了一个方法

1
2
public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response,
Object handler)

每次处理程序得到正确执行时,都会调用此方法而不是调用postHandler()和afterCompletion()。它也可以对发送请求进行异步处理。通过Spring源码此方法注释可以知道,这个方法的典型的应用是可以用来清理本地线程变量

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor {

/**
* This implementation always returns {@code true}.
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {

return true;
}

/**
* This implementation is empty.
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
@Nullable ModelAndView modelAndView) throws Exception {
}

/**
* This implementation is empty.
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
@Nullable Exception ex) throws Exception {
}

/**
* This implementation is empty.
*/
@Override
public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
}

}

配置自定义的拦截器

用到了我以前项目中的拦截器作为例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
package com.bestrookie.config;

import com.bestrookie.interceptor.AuthenticationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
* @author : bestrookie
* @date : 9:48 2020/10/8
*/
@Configuration //mvc配置
public class InterceptorConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(authenticationInterceptor())//addInterceptor(这里面是自定义的拦截器)
.addPathPatterns("/**")//拦截除了白名单外的所有请求
.excludePathPatterns("/api/user/login/**")//请求白名单 就是不拦截
//可以添加多个拦截器 前面有说明

}
//注册到Spring容器
@Bean//自定义的拦截器
public AuthenticationInterceptor authenticationInterceptor() {
return new AuthenticationInterceptor();
}
}

评论