xyZGHio

本是青灯不归客,却因浊酒恋风尘

0%

基于SpringBoot的Interceptor实践

本文介绍如何使用Spring MVC中的Interceptor拦截器

abstract.jpg

概述

Interceptor拦截器作为Spring中的组件,其底层使用AOP对请求进行拦截处理。提供类似于Servlet中Filter过滤器的能力。但其作用目标、范围与Filter不同,其是对Controller中的请求进行拦截、处理。拦截器与过滤器间的关系如下所示。当然我们可以同时使用多个拦截器,各拦截器会依次对用户请求进行处理。通过它可以实现拦截用户请求并作相应的处理,例如:记录请求信息、请求耗时统计分析等

figure 1.jpg

Spring当中如果期望实现拦截器,可以实现HandlerInterceptor接口或者继承HandlerInterceptorAdapter抽象类。二者本质上并无差别,因为后者实际上是实现了前者。故这里重点介绍HandlerInterceptor接口中定义的几个方法

  • preHandle:该方法会在Controller方法调用前执行,其返回值表示是否中断后续所有操作。如果为true则继续向下执行; 反之则表示请求结束, 终止后续所有操作(包括后续的Interceptor和Controller)
  • postHandle:该方法会在Controller方法调用后、解析视图之前执行,可通过此方法对ModelAndView做进一步修改。事实上在前后分离的时代背景下,该方法可以直接忽略,直接空实现即可
  • afterCompletion:该方法会在视图渲染结束之后执行。主要用于执行资源清理的工作

这里补充说明下:

  1. 当配置多个拦截器时,与Filter类似。各拦截器在Controller方法调用前后的执行顺序是相反的。即:拦截器1 preHandle 方法 -> 拦截器2 preHandle 方法 -> Controller方法 -> 拦截器2 postHandle 方法 -> 拦截器1 postHandle 方法 -> 拦截器2 afterCompletion 方法 -> 拦截器1 afterCompletion 方法
  2. 当某拦截器的preHandle方法返回false后,则该请求会直接终止。即不会向后面的拦截器或Controller传递、执行、处理。自然该拦截器的postHandle、afterCompletion方法也不会被执行

实践

这里我们选择通过实现HandlerInterceptor接口来开发拦截器1

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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
public class MyInterceptor1 implements HandlerInterceptor {

/**
* 该方法会在Controller方法调用前执行,其返回值表示是否中断后续所有操作
* @param request
* @param response
* @param handler
* @return true: 继续向下执行; false: 表示请求结束, 终止后续所有操作(包括后续的Interceptor和Controller)
* @throws Exception
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
log.info("[Interceptor 1] This is preHandle method");
String name = request.getParameter("name");

// Tony 无权限
if("Tony".equals(name)) {
ServletOutputStream outputStream = response.getOutputStream();
String str = "No Power !!!";
outputStream.write(str.getBytes("utf-8"));
outputStream.flush();
return false;
}
return true;
}

/**
* 该方法会在Controller方法调用后、解析视图之前执行,可通过此方法对ModelAndView做进一步修改
* @param request
* @param response
* @param handler
* @param modelAndView
* @throws Exception
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
log.info("[Interceptor 1] This is postHandle method");
}

/**
* 该方法会在视图渲染结束之后执行。主要用于执行资源清理的工作
* @param request
* @param response
* @param handler
* @param ex
* @throws Exception
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
log.info("[Interceptor 1] This is afterCompletion method");
ServletOutputStream outputStream = response.getOutputStream();
String str = " <Thank You>";
outputStream.write(str.getBytes("utf-8"));
outputStream.flush();
}
}

同理,为便于验证多拦截器的执行顺序。这里我们提供了一个空实现的拦截器2

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
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
public class MyInterceptor2 implements HandlerInterceptor {

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
log.info("[Interceptor 2] This is preHandle method");
return true;
}

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

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
log.info("[Interceptor 2] This is afterCompletion method");
}
}

最后只需利用Java配置类,通过实现WebMvcConfigurer接口中的addInterceptors方法进行拦截器的注册即可。事实上,我们还可以通过继承WebMvcConfigurerAdapter抽象类的addInterceptors方法来注册拦截器。但WebMvcConfigurerAdapter本质上依然是一个对WebMvcConfigurer接口进行空实现的抽象类。但由于JDK 8通过default关键字,提供了对接口支持默认实现的能力。故Spring 5.0中已经重写WebMvcConfigurer接口并提供了默认的空实现,故在Spring 5.0中已不推荐使用WebMvcConfigurerAdapter抽象类

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
39
40
41
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;

@Configuration
public class MyInterceptorConfig implements WebMvcConfigurer {

@Bean
public MyInterceptor1 myInterceptor1() {
return new MyInterceptor1();
}

@Bean
public MyInterceptor2 myInterceptor2() {
return new MyInterceptor2();
}

/**
* 注册拦截器
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
//注册拦截器1
registry.addInterceptor( myInterceptor1() )
// 数字越小,优先级越高
.order(5)
// 指定需要拦截的URL
.addPathPatterns("/testInterceptor/*")
// 指定不拦截的URL
.excludePathPatterns("/hello/*", "/person/add");

//注册拦截器2
registry.addInterceptor( myInterceptor2() )
// 数字越小,优先级越高
.order(996)
// 指定需要拦截的URL
.addPathPatterns("/testInterceptor/*");
}
}

不难看出,通过指定优先级。我们期望拦截器1比拦截器2先被调用。下述测试结果不仅验证了拦截器效果,同时验证了多拦截器的执行顺序

figure 2.jpg

对于preHandle方法返回false场景的测试结果表明,符合预期。请求立即终止执行,不会往下继续传递、执行

figure 3.jpg

请我喝杯咖啡捏~

欢迎关注我的微信公众号:青灯抽丝