目录
一、什么是拦截器
二、快速入门程序
三、拦截器的使用细节
preHandle方法
postHandle方法
afterCompletion方法
拦截路径
四、拦截器执行流程
五、登录校验- Interceptor
在现代Web应用开发中，拦截器（Interceptor）是一个非常重要的概念。它允许我们在请求到达控制器之前或之后执行一些额外的逻辑，比如日志记录、权限校验等。本文将通过三个方面来详细介绍拦截器的概念、使用细节以及如何通过拦截器实现登录校验功能。
一、什么是拦截器
在Spring Boot中，拦截器是一种中间件，用于在请求到达控制器之前或之后执行一些通用的功能。比如：我们可以通过拦截器来拦截前端发起的请求，将登录校验的逻辑全部编写在拦截器当中。在校验的过程当中，如发现用户登录了(携带JWT令牌且是合法令牌)，就可以直接放行，去访问spring当中的资源。如果校验时发现并没有登录或是非法令牌，就可以直接给前端响应未登录的错误信息。 它基于Spring MVC框架中的HandlerInterceptor接口实现。通过创建一个自定义的拦截器类并实现该接口，可以定义拦截器要执行的逻辑和行为。是一种动态拦截方法调用的机制，类似于过滤器。
二、快速入门程序
下面是一个简单的示例，展示了如何创建一个基本的拦截器并在Spring Boot应用中使用它：
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;@Component
public class LogInterceptor implements HandlerInterceptor {//目标资源方法执行前执行。 返回true：放行 返回false：不放行@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {System.out.println("Request URL: " + request.getRequestURL());//true表示放行return true;}
} 在这个例子中，我们创建了一个名为LogInterceptor的拦截器，它实现了preHandle方法，用于在每个请求处理之前打印请求的URL。
//目标资源方法执行后执行@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {System.out.println(" ... ");}//视图渲染完毕后执行，最后执行@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {System.out.println(" .... ");}接下来，我们需要将这个拦截器注册到Spring容器中：
mport 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 {//自定义的拦截器对象@Autowiredprivate LogInterceptor logInterceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(logInterceptor).addPathPatterns("/**");//设置拦截器拦截的请求路径（ /** 表示拦截所有请求）}
} 现在，每当有请求进入我们的应用时，都会先经过LogInterceptor的处理。可以重新启动SpringBoot服务，打开postman进行测试。
三、拦截器的使用细节
preHandle方法
preHandle方法是最先执行的方法，用于在请求处理之前进行一些预处理操作。该方法返回一个布尔值，如果返回false，则请求会被立即终止，后续的Interceptor和Controller都不会再执行；如果返回true，则会继续调用下一个Interceptor的preHandle方法，直到所有的Interceptor都执行完毕或者某个Interceptor返回了false。
postHandle方法
postHandle方法是在当前请求处理完成之后，也就是Controller方法调用之后执行的。这个方法可以用来对Controller处理之后的ModelAndView对象进行操作。
afterCompletion方法
afterCompletion方法是在整个请求结束之后执行的，也就是在DispatcherServlet渲染了对应的视图之后执行。这个方法主要用来进行资源清理工作。
拦截路径
在注册配置拦截器的时候，我们要指定拦截器的拦截路径，通过addPathPatterns("要拦截路径")方法，就可以指定要拦截哪些资源。
在入门程序中我们配置的是/**，表示拦截所有资源，而在配置拦截器时，不仅可以指定要拦截哪些资源，还可以指定不拦截哪些资源，只需要调用excludePathPatterns("不拦截路径")方法，指定哪些资源不需要拦截。
在拦截器中除了可以设置/**拦截所有资源外，还有一些常见拦截路径设置：
| 拦截路径 | 含义 | 举例 |
|---|---|---|
| /* | 一级路径 | 能匹配/depts，/emps，/login，不能匹配 /depts/1 |
| /** | 任意级路径 | 能匹配/depts，/depts/1，/depts/1/2 |
| /depts/* | /depts下的一级路径 | 能匹配/depts/1，不能匹配/depts/1/2，/depts |
| /depts/** | /depts下的任意级路径 | 能匹配/depts，/depts/1，/depts/1/2，不能匹配/emps/1 |
四、拦截器执行流程
-
当我们打开浏览器来访问部署在web服务器当中的web应用时，此时我们所定义的过滤器会拦截到这次请求。拦截到这次请求之后，它会先执行放行前的逻辑，然后再执行放行操作。而由于我们当前是基于springboot开发的，所以放行之后是进入到了spring的环境当中，也就是要来访问我们所定义的controller当中的接口方法。
-
Tomcat并不识别所编写的Controller程序，但是它识别Servlet程序，所以在Spring的Web环境中提供了一个非常核心的Servlet：DispatcherServlet（前端控制器），所有请求都会先进行到DispatcherServlet，再将请求转给Controller。
-
当我们定义了拦截器后，会在执行Controller的方法之前，请求被拦截器拦截住。执行
preHandle()方法，这个方法执行完成后需要返回一个布尔类型的值，如果返回true，就表示放行本次操作，才会继续访问controller中的方法；如果返回false，则不会放行（controller中的方法也不会执行）。 -
在controller当中的方法执行完毕之后，再回过来执行
postHandle()这个方法以及afterCompletion()方法，然后再返回给DispatcherServlet，最终再来执行过滤器当中放行后的这一部分逻辑的逻辑。执行完毕之后，最终给浏览器响应数据。
五、登录校验- Interceptor
在实际的Web应用中，登录校验是一个非常常见的需求。我们可以利用拦截器来实现这个功能。下面是一个示例：
//自定义拦截器
@Component //当前拦截器对象由Spring创建和管理
@Slf4j
public class LoginCheckInterceptor implements HandlerInterceptor {//前置方式@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {System.out.println("preHandle .... ");//1.获取请求url//2.判断请求url中是否包含login，如果包含，说明是登录操作，放行//3.获取请求头中的令牌（token）String token = request.getHeader("token");log.info("从请求头中获取的令牌：{}",token);//4.判断令牌是否存在，如果不存在，返回错误结果（未登录）if(!StringUtils.hasLength(token)){log.info("Token不存在");//创建响应结果对象Result responseResult = Result.error("NOT_LOGIN");//把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)String json = JSONObject.toJSONString(responseResult);//设置响应头（告知浏览器：响应的数据类型为json、响应的数据编码表为utf-8）response.setContentType("application/json;charset=utf-8");//响应response.getWriter().write(json);return false;//不放行}//5.解析token，如果解析失败，返回错误结果（未登录）try {JwtUtils.parseJWT(token);}catch (Exception e){log.info("令牌解析失败!");//创建响应结果对象Result responseResult = Result.error("NOT_LOGIN");//把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)String json = JSONObject.toJSONString(responseResult);//设置响应头response.setContentType("application/json;charset=utf-8");//响应response.getWriter().write(json);return false;}//6.放行return true;}这段代码是一个自定义的拦截器，用于在处理HTTP请求之前进行登录检查。具体步骤如下：
- 获取请求的URL。
- 判断URL中是否包含"login"，如果包含，说明是登录操作，放行。
- 从请求头中获取令牌（token）。
- 判断令牌是否存在，如果不存在，返回错误结果（未登录）。
- 解析令牌，如果解析失败，返回错误结果（未登录）。
- 如果以上条件都满足，放行请求。
最后，我们需要将这个拦截器注册到Spring容器中，并指定它应用于哪些路径：
@Configuration
public class WebConfig implements WebMvcConfigurer {//拦截器对象@Autowiredprivate LoginCheckInterceptor loginCheckInterceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**").excludePathPatterns("/login");}
} 在这个例子中，拦截器名为LoginCheckInterceptor。它实现了WebMvcConfigurer接口，并重写了addInterceptors方法。在这个方法中，将loginCheckInterceptor添加到拦截器注册表中，并指定了拦截所有路径（"/**"），但排除了"/login"路径。这意味着当用户访问除登录页面之外的任何页面时，都会触发LoginCheckInterceptor进行拦截处理。
总的来说，拦截器是一种强大的工具，可以帮助我们在请求处理的不同阶段插入自定义逻辑，从而实现日志记录、权限检查、性能监控等功能。通过合理使用拦截器，可以提高代码的可维护性和扩展性。