SpringBoot统一功能处理——拦截器

目录

一、什么是拦截器？

二、拦截器使用

2.1 定义拦截器

2.2 注册配置拦截器 

三、拦截器详解

3.1 拦截器的拦截路径配置

3.2 拦截器执行流程

---

一、什么是拦截器？

拦截器是Spring框架提供的核心功能之一, 主要用来拦截用户的请求, 在指定方法前后, 根据业务需要执行预先设定的代码。

二、拦截器使用

2.1 定义拦截器

自定义拦截器：实现HandlerInterceptor接口，并重写所用到的方法：

• preHandle()方法：目标方法执行前执行。 返回true: 继续执行后续操作; 返回false: 中断后续操作。
• postHandle()方法：目标方法执行后执行。
• afterCompletion()方法：视图渲染完毕后执行，最后执行。

@Slf4j
@Component
public class LoginInterceptor implements HandlerInterceptor {
 
 @Override
 public boolean preHandle(HttpServletRequest request, HttpServletResponse 
response, Object handler) throws Exception {
 log.info("LoginInterceptor 目标⽅法执⾏前执行..");
 return true;
 }

 @Override
 public void postHandle(HttpServletRequest request, HttpServletResponse 
response, Object handler, ModelAndView modelAndView) throws Exception {
 log.info("LoginInterceptor 目标⽅法执⾏后执行");
 }

 @Override
 public void afterCompletion(HttpServletRequest request, 
  HttpServletResponse response, Object handler, Exception ex) throws Exception {
 log.info("LoginInterceptor 视图渲染完毕后执行，最后执行");
 }
}

2.2 注册配置拦截器 

实现WebMvcConfigurer接口，并重写addInterceptors方法：

@Configuration
public class WebConfig implements WebMvcConfigurer {
 //⾃定义的拦截器对象
 @Autowired
 private LoginInterceptor loginInterceptor;
 @Override
 public void addInterceptors(InterceptorRegistry registry) {
 //注册⾃定义拦截器对象
 registry.addInterceptor(loginInterceptor)
 .addPathPatterns("/**");//设置拦截器拦截的请求路径（ /** 表⽰拦截所有请求）
 }
}

三、拦截器详解

3.1 拦截器的拦截路径配置

拦截路径是指定义的这个拦截器, 对哪些请求生效。我们在注册配置拦截器的时候, 通过 addPathPatterns() 方法指定要拦截哪些请求，也可以通过 excludePathPatterns() 指定不拦截哪些请求。

比如用户登录校验，希望可以对除了登陆之外的所有路径生效。

import org.springframework.beans.factory.annotation.Autowired;
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 WebConfig implements WebMvcConfigurer {
 //⾃定义的拦截器对象
 @Autowired
 private LoginInterceptor loginInterceptor;
 @Override
 public void addInterceptors(InterceptorRegistry registry) {
 //注册⾃定义拦截器对象
 registry.addInterceptor(loginInterceptor)
 .addPathPatterns("/**")
 .excludePathPatterns("/user/login");//设置拦截器拦截的请求路径
(/** 表⽰拦截所有请求)
 }
}

在拦截器中除了可以设置 /** 拦截所有资源外，还有一些常见拦截路径设置：

拦截路径	含义	举例
/*	一级路径	能匹配/user，/book，/login，不能匹配 /user/login
/**	任意级路径	能匹配/user，/user/login，/user/reg
/book/*	/book下的一级路径	能匹配/book/addBook，不能匹配/book/addBook/1，/book
/book/**	/book下的任意级路径	能匹配/book，/book/addBook，/book/addBook/2，不能匹配/user/login

3.2 拦截器执行流程

正常的调用顺序：

有了拦截器之后，会在调用 Controller 之前进行相应的业务处理，执行的流程如下：

• 添加拦截器后, 执行Controller的方法之前, 请求会先被拦截器拦截住。执行 preHandle() 方法，这个方法需要返回一个布尔类型的值。如果返回true, 就表示放行本次操作, 继续访问controller中的方法。如果返回false，则不会放行(controller中的方法也不会执行)。
• controller当中的方法执行完毕后，再回过来执行 postHandle() 这个方法以及afterCompletion() 方法，执行完毕之后，最终给浏览器响应数据。