拦截器(Interceptor)是一种用于动态拦截方法调用的机制。在 Spring MVC 中,拦截器能够动态地拦截控制器方法的实行过程。以下是哀求发送与接收的基本流程:
当浏览器发出哀求时,哀求首先到达 Tomcat 服务器。Tomcat 根据哀求范例(静态资源或动态资源)举行处理。对于静态资源,Tomcat 直接返回相应的资源;而对于动态资源,哀求会颠末 Servlet 过滤器,接着交给 Spring 举行处理。Spring 通过中心控制器将哀求分发到详细的 Controller 中,实行相应操纵,并将处理后的数据返回给浏览器。
在这个过程中,可能会出现一些需求,比方权限控制和身份验证。为了在所有控制器的实行前或实行后统一处理这些操纵,拦截器就此出现。拦截器答应我们在控制器方法实行的前后添加统一的逻辑,从而实现更灵活和易于管理的代码结构。概括而言,拦截器的作用包括:
- 在指定的方法调用前后实行预先设定的代码
- 制止原始方法的实行
拦截器 vs 过滤器
在哀求发送与接收的过程中,涉及到过滤器(Filter)和拦截器(Interceptor)。两者之间的主要区别如下:
- 归属差别:过滤器属于 Servlet 技术,而拦截器则属于 Spring MVC 技术
- 拦截内容差别:过滤器在 Tomcat 服务器阶段举行配置,对所有访问举行增强;而拦截器仅针对 Spring MVC 的哀求举行增强。
拦截器利用
在现实开发过程中,拦截器的利用主要包括两个步骤:
(1)制作拦截器功能类
声明拦截器的 Bean,并实现 HandlerInterceptor 接口(注意:后续必要扫描加载 Bean)。详细地,创建一个 com.it.interceptor 包,在该包中创建一个拦截器 ProjectInterceptor,实现 HandlerInterceptor 接口,并且重写 preHandle、postHandle 和 afterCompletion 三个方法,这三个方法分别对应前置处理、后置处理和完成后处理:
- @Component
- public class ProjectInterceptor implements HandlerInterceptor {
- @Override
- public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
- System.out.println("preHandle...");
- return true;
- // return false 时,将终止原始操作,后续的 postHandle 和 afterCompletion 也不会执行
- }
- @Override
- public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
- System.out.println("postHandle...");
- }
- @Override
- public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
- System.out.println("afterCompletion...");
- }
- }
复制代码 当前置处理(对应 preHandle 方法)返回 false 时,将停止原始操纵,后续的 postHandle 和 afterCompletion 也不会实行,过程如下图所示。
(2)配置拦截器的实行位置
在 com.it.config 包中界说配置类,该类继承 WebMvcConfigurationSupport,并实现 addInterceptor 方法(注意:后续必要扫描加载配置)。在方法中注册拦截器并设定拦截的访问路径,路径可以通过可变参数设置多个。
- @Configuration
- public class SpringMvcSupport extends WebMvcConfigurationSupport {
- @Autowired
- private ProjectInterceptor projectInterceptor;
- @Override
- protected void addInterceptors(InterceptorRegistry registry) {
- // 所有以 /users 开头的访问路径都被拦截
- registry.addInterceptor(projectInterceptor).addPathPatterns("/users", "/users/*");
- }
- }
复制代码 (3)扫描加载
在 SpringMvcConfig 配置类中,多添加对 com.it.interceptor 和 com.it.config 包的扫描,以此完成对拦截器的加载:
- @Configuration
- @ComponentScan({"com.it.controller", "com.it.interceptor", "com.it.config"})
- @EnableWebMvc
- public class SpringMvcConfig {
- }
复制代码 (4)简化开发
上述拦截器的利用过程可以进一步简化。通过利用标准接口 WebMvcConfigurer,可以减少开发的复杂性。将 SpringMvcSupport 配置类与 SpringMvcConfig 配置类归并,可以有效降低代码量。
- @Configuration
- @ComponentScan({"com.it.controller", "com.it.interceptor"})
- @EnableWebMvc
- public class SpringMvcConfig implements WebMvcConfigurer {
- @Autowired
- private ProjectInterceptor projectInterceptor;
- @Override
- public void addInterceptors(InterceptorRegistry registry) {
- registry.addInterceptor(projectInterceptor).addPathPatterns("/users", "/users/*");
- }
- }
复制代码 拦截器参数
(1)前置处理
- public boolean preHandle(
- HttpServletRequest request,
- HttpServletResponse response,
- Object handler
- ) throws Exception {
- System.out.println("preHandle...");
- return true;
- }
复制代码
- 参数
- request:哀求对象
- response:相应对象
- handler:被调用的处理器对象,本质上是一个方法对象,对反射技术中的 Method 对象举行了再包装
- 返回值
(2)后置处理
- public void postHandle(
- HttpServletRequest request,
- HttpServletResponse response,
- Object handler,
- ModelAndView modelAndView
- ) throws Exception {
- System.out.println("postHandle...");
- }
复制代码
- 参数
- modelAndview:如果处理器实行完成具有返回效果,可以读取到对应数据与页面信息,并举行调解(现阶段开发模式下基本用不上)
(3)完成后处理
- public void afterCompletion(
- HttpServletRequest request,
- HttpServletResponse response,
- Object handler,
- Exception ex
- ) throws Exception {
- System.out.println("afterCompletion...");
- }
复制代码
- 参数
- ex:如果处理器实行过程中出现非常对象,可以针对非常环境举行单独处理
拦截器链配置
当配置多个拦截器时,会形成拦截器链。拦截器链的运行顺序遵循拦截器的添加顺序,详细实行顺序如下:
- preHandle:按照配置顺序实行
- postHandle:按照配置顺序的相反顺序实行
- afterCompletion:同样按照配置顺序的相反顺序实行
此外,还有几点必要注意:
- 如果某个拦截器拦截了原始处理器的实行,后续的拦截器将停止运行。
- 如果拦截器的实行过程中发生停止,仅会实行在前面配置的拦截器的 afterCompletion 操纵。
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。 |