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 相关文章推荐
Java实战之用Swing实现通讯录管理系统
Jun 13 Java/Android
Jackson 反序列化时实现大小写不敏感设置
Jun 29 Java/Android
Java tomcat手动配置servlet详解
Nov 27 Java/Android
深入浅出讲解Java8函数式编程
Jan 18 Java/Android
java objectUtils 使用可能会出现的问题
Feb 28 Java/Android
SpringBoot中使用Redis作为全局锁示例过程
Mar 24 Java/Android
Java 深入探究讲解简单工厂模式
Apr 07 Java/Android
Java字符缓冲流BufferedWriter
Apr 09 Java/Android
多线程Spring通过@Scheduled实现定时任务
May 25 Java/Android
Java时间工具类Date的常用处理方法
May 25 Java/Android
Java实现超大Excel文件解析(XSSF,SXSSF,easyExcel)
Jul 15 Java/Android
SpringBoot Http远程调用的方法
Aug 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 isset()与empty()的使用区别详解
2010/08/29 PHP
php批量上传的实现代码
2013/06/09 PHP
PHP接收json 并将接收数据插入数据库的实现代码
2015/12/01 PHP
Yii2框架自定义类统一处理url操作示例
2019/05/25 PHP
event.srcElement 用法笔记e.target
2009/12/18 Javascript
用函数模板,写一个简单高效的 JSON 查询器的方法介绍
2013/04/17 Javascript
jquery通过ajax加载一段文本内容的方法
2015/01/15 Javascript
ExtJs动态生成treepanel的Json格式
2015/07/19 Javascript
jquery带动画效果幻灯片特效代码
2015/08/27 Javascript
JavaScript获取键盘按键的键码(参照表)
2017/01/10 Javascript
Vue.js tab实现选项卡切换
2017/05/16 Javascript
基于Cookie常用操作以及属性介绍
2017/09/07 Javascript
Node.js中你不可不精的Stream(流)
2018/06/08 Javascript
vue中设置、获取、删除cookie的方法
2018/09/21 Javascript
微信JS-SDK实现微信会员卡功能(给用户微信卡包里发送会员卡)
2019/07/25 Javascript
Vue 3.0 全家桶抢先体验
2020/04/28 Javascript
微信小程序自定义支持图片的弹窗
2020/12/21 Javascript
详解Vue.js 可拖放文本框组件的使用
2021/03/03 Vue.js
[03:16]DOTA2完美大师赛主赛事首日集锦
2017/11/23 DOTA
[03:01]完美世界DOTA2联赛PWL S2 集锦第二期
2020/12/03 DOTA
详解Django中类视图使用装饰器的方式
2018/08/12 Python
修改默认的pip版本为对应python2.7的方法
2018/11/06 Python
Python图像处理实现两幅图像合成一幅图像的方法【测试可用】
2019/01/04 Python
python安装numpy和pandas的方法步骤
2019/05/27 Python
详解Python中的各种转义符\n\r\t
2019/07/10 Python
opencv转换颜色空间更改图片背景
2019/08/20 Python
Python作用域与名字空间原理详解
2020/03/21 Python
介绍一下except的用法和作用
2015/01/22 面试题
机电一体化毕业生求职信
2013/11/02 职场文书
营销人才自我鉴定范文
2013/12/25 职场文书
《我的信念》教学反思
2014/02/15 职场文书
工作睡觉检讨书
2014/02/25 职场文书
人口与计划生育目标管理责任书
2014/07/29 职场文书
关于保护环境的建议书
2019/06/24 职场文书
浅谈redis五大数据结构和使用场景
2021/04/12 Redis
SQL Server中T-SQL标识符介绍与无排序生成序号的方法
2022/05/25 SQL Server