SpringBoot 拦截器妙用你真的了解吗


Posted in Java/Android onJuly 01, 2021

HandlerInterceptor 详解

HandlerInterceptor 允许定制 handler 处理器执行链的工作流接口。我们可以自定义拦截器用于拦截 handlers 处理器(你可以理解为 controller 层的接口),从而可以添加一些共同的重复性的处理行为(例如接口鉴权,接口日志记录,性能监控等),而不用修改每一个 handler 的实现。

注意,此基于 SpringBoot 2.3.12.RELEASE 版本讲解。

HandlerInterceptor 接口只有三个默认空实现方法,在低版本中这三个方法不是默认方法,而是抽象方法。

public interface HandlerInterceptor {

	default boolean preHandle(HttpServletRequest request, HttpServletResponse response,                 Object handler) throws Exception {
		return true;
	}

	default void postHandle(HttpServletRequest request, HttpServletResponse response,                 Object handler, @Nullable ModelAndView modelAndView) throws Exception {
	}

	default void afterCompletion(HttpServletRequest request, HttpServletResponse response,             Object handler, @Nullable Exception ex) throws Exception {
	}
}

这三个方法的执行顺序图如下:

SpringBoot 拦截器妙用你真的了解吗

preHandle

preHandle 前置处理,拦截一个处理器(handler)的执行,preHandle 方法会在 HandlerMapping 确定一个适当的处理器对象之后,但在 HandlerAdapter 调用处理器之前被调用。可以简单理解为 controller 接口被调用之前执行。

Intercepter 是链式的,就是一个接着一个执行。如果此方法返回 true,则会执行下一个拦截器或者直接执行处理器。如果此方法返回 false 或者抛出异常则终止执行链,也不再调用处理器。

注意,此方法如果不返回 true,那么 postHandleafterCompletion 不会被执行。

那这个方法有什么用呢?其实可以做一些接口被调用前的预处理,例如用户权限校验。

package com.chenpi;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;

/**
 * @Description 用户权限验证拦截
 * @Author 陈皮
 * @Date 2021/6/27
 * @Version 1.0
 */
@Component
public class UserPermissionInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
            Object handler) {

        if (handler instanceof HandlerMethod) {

            HandlerMethod handlerMethod = (HandlerMethod) handler;

            // 获取用户权限校验注解
            UserAuthenticate userAuthenticate =
                    handlerMethod.getMethod().getAnnotation(UserAuthenticate.class);
            if (null == userAuthenticate) {
                userAuthenticate = handlerMethod.getMethod().getDeclaringClass()
                        .getAnnotation(UserAuthenticate.class);
            }
            if (userAuthenticate != null && userAuthenticate.permission()) {
                // 验证用户信息
                UserContext userContext = userContextManager.getUserContext(request);
                if (null == userContext) {
                    return false;
                }
            }
        }
        return true;
    }
}

postHandle

postHandle 后置处理,会在 HandlerAdapter 调用处理器之后,但在 DispatcherServlet 渲染视图之前被调用。可以在此对 ModelAndView 做一些额外的处理。可以简单理解为 controller 接口被调用之后执行。

注意,此方法在执行链中的执行顺序是倒着执行的,即先声明的拦截器后执行。

afterCompletion

afterCompletion 完成之后,在请求处理完之后被执行,也就是渲染完视图之后。一般用于做一些资源的清理工作,配合 preHandle 计算接口执行时间等。

注意,和 postHandle 一样,此方法在执行链中的执行顺序也是倒着执行的,即先声明的拦截器后执行。

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
                            Object handler, @Nullable Exception ex) {
    // 请求完后,清除当前线程的用户信息
    UserContextHolder.removeUserContext();
}

注册拦截器

注意,我们自定义的拦截器要通过 WebMvcConfigurer 的实现类进行注册,才能生效。

package com.yzj.ehr.common.config;

import com.yzj.ehr.common.context.UserContextResolver;
import org.springframework.stereotype.Component;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.yzj.ehr.common.interceptor.UserPermissionInterceptor;

/**
 * @Description 注册拦截器
 * @Author 陈皮
 * @Date 2021/6/27
 * @Version 1.0
 */
@Component
public class WebAppConfigurer implements WebMvcConfigurer {

    private UserPermissionInterceptor userPermissionInterceptor;

    public WebAppConfigurer(final UserPermissionInterceptor userPermissionInterceptor) {
        this.userPermissionInterceptor = userPermissionInterceptor;
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 匹配所有接口,排除/base/test接口
        registry.addInterceptor(userPermissionInterceptor).addPathPatterns("/**")
                .excludePathPatterns("/base/test");
    }
}

到此这篇关于SpringBoot 拦截器妙用你真的了解吗的文章就介绍到这了,更多相关SpringBoot 拦截器内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Java/Android 相关文章推荐
浅谈Python魔法方法
Jun 28 Java/Android
分析并发编程之LongAdder原理
Jun 29 Java/Android
详解Spring Boot使用系统参数表提升系统的灵活性
Jun 30 Java/Android
看完这篇文章获得一些java if优化技巧
Jul 15 Java/Android
SpringBoot快速入门详解
Jul 21 Java/Android
SpringBoot中HttpSessionListener的简单使用方式
Mar 17 Java/Android
使用HttpSessionListener监听器实战
Mar 17 Java/Android
spring注解 @PropertySource配置数据源全流程
Mar 25 Java/Android
SpringBoot整合Minio文件存储
Apr 03 Java/Android
Android Rxjava3 使用场景详解
Apr 07 Java/Android
Spring Cloud Netflix 套件中的负载均衡组件 Ribbon
Apr 13 Java/Android
详解Flutter网络请求Dio库的使用及封装
Apr 14 Java/Android
解决SpringBoot文件上传临时目录找不到的问题
java实现对Hadoop的操作
Jul 01 #Java/Android
解决MultipartFile.transferTo(dest) 报FileNotFoundExcep的问题
Jul 01 #Java/Android
Java中多线程下载图片并压缩能提高效率吗
分析ZooKeeper分布式锁的实现
Java并发编程必备之Future机制
详解Spring Boot使用系统参数表提升系统的灵活性
Jun 30 #Java/Android
You might like
PHP架构及原理知识点详解
2019/12/22 PHP
js操作select控件的几种方法
2010/06/02 Javascript
javascript判断ie浏览器6/7版本加载不同样式表的实现代码
2011/12/26 Javascript
基于jquery库的tab新形式使用
2012/11/16 Javascript
jquery索引在使用中的一些困惑
2013/10/24 Javascript
Javascript中Array.prototype.map()详解
2014/10/22 Javascript
JavaScript插件化开发教程 (一)
2015/01/27 Javascript
JS模式之单例模式基本用法
2015/06/30 Javascript
关于JS中prototype的理解
2015/09/07 Javascript
深入剖析JavaScript编程中的对象概念
2015/10/21 Javascript
JS判断输入字符串长度实例代码(汉字算两个字符,字母数字算一个)
2016/08/02 Javascript
nodeJs链接Mysql做增删改查的简单操作
2017/02/04 NodeJs
JQuery搜索框自动补全(模糊匹配)功能实现示例
2019/01/08 jQuery
小程序如何构建骨架屏
2019/05/29 Javascript
axios如何取消重复无用的请求详解
2019/12/15 Javascript
Python使用matplotlib填充图形指定区域代码示例
2018/01/16 Python
python读取文本中的坐标方法
2018/10/14 Python
python如何实现从视频中提取每秒图片
2020/10/22 Python
Python全局锁中如何合理运用多线程(多进程)
2019/11/06 Python
Python 生成VOC格式的标签实例
2020/03/10 Python
Keras自定义IOU方式
2020/06/10 Python
Win10下配置tensorflow-gpu的详细教程(无VS2015/2017)
2020/07/14 Python
详解Pycharm安装及Django安装配置指南
2020/09/15 Python
Python实现PS滤镜中的USM锐化效果
2020/12/04 Python
pycharm 如何取消连按两下shift出现的全局搜索
2021/01/15 Python
html5 canvas-2.用canvas制作一个猜字母的小游戏
2013/01/07 HTML / CSS
Europcar意大利:汽车租赁
2019/07/07 全球购物
艺术专业大学生自我评价
2013/09/22 职场文书
人事专员的岗位职责
2014/03/01 职场文书
2014年五一促销活动方案
2014/03/09 职场文书
群众路线个人对照检查材料
2014/09/23 职场文书
工作表扬信
2015/01/17 职场文书
商务宴会祝酒词
2015/08/11 职场文书
2016年优秀共产党员先进事迹材料
2016/02/29 职场文书
德生TECSUN S-2000使用手册文字版
2022/05/10 无线电
python数字图像处理:图像简单滤波
2022/06/28 Python