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中Collection的一些常用方法总结
Jun 13 Java/Android
自从在 IDEA 中用了热部署神器 JRebel 之后,开发效率提升了 10(真棒)
Jun 26 Java/Android
Java使用jmeter进行压力测试
Jul 09 Java/Android
SpringBoot+VUE实现数据表格的实战
Aug 02 Java/Android
聊聊SpringBoot自动装配的魔力
Nov 17 Java/Android
关于Spring配置文件加载方式变化引发的异常详解
Jan 18 Java/Android
Java字符串逆序方法详情
Mar 21 Java/Android
引用计数法和root搜索算法以及JVM中判定对象需要回收的方法
Apr 19 Java/Android
spring IOC容器的Bean管理XML自动装配过程
May 30 Java/Android
Java服务调用RestTemplate与HttpClient的使用详解
Jun 21 Java/Android
Java多线程并发FutureTask使用详解
Jun 28 Java/Android
Java结构型设计模式之组合模式详解
Sep 23 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笔记之:有规律大文件的读取与写入的分析
2013/04/26 PHP
再Docker中架设完整的WordPress站点全攻略
2015/07/29 PHP
thinkphp多层MVC用法分析
2015/12/30 PHP
php字符串的替换,分割和连接方法
2016/05/23 PHP
解决php扩展安装不生效问题
2019/10/25 PHP
Laravel相关的一些故障解决
2020/08/19 PHP
了解jQuery技巧来提高你的代码
2010/01/08 Javascript
JS维吉尼亚密码算法实现代码
2010/11/09 Javascript
在Javascript里访问SharePoint列表数据的实现方法
2011/05/22 Javascript
鼠标悬浮显示二级菜单效果的jquery实现
2014/10/29 Javascript
JS基于VML技术实现的五角星礼花效果代码
2015/10/26 Javascript
javascript url几种编码方式详解
2016/06/06 Javascript
JS使用单链表统计英语单词出现次数
2016/06/16 Javascript
BootStrapValidator校验方式
2016/12/19 Javascript
基于JavaScript实现验证码功能
2017/04/01 Javascript
node.js监听文件变化的实现方法
2019/04/17 Javascript
python虚拟环境 virtualenv的简单使用
2020/01/21 Javascript
微信浏览器下拉黑边解决方案 wScroollFix
2020/01/21 Javascript
小程序开发之模态框组件封装
2020/04/23 Javascript
Vant 在vue-cli 4.x中按需加载操作
2020/11/05 Javascript
[58:09]Spirit vs NB Supermajor小组赛 A组败者组决赛 BO3 第三场 6.2
2018/06/03 DOTA
Python实现的微信公众号群发图片与文本消息功能实例详解
2017/06/30 Python
Python 从列表中取值和取索引的方法
2018/12/25 Python
python批量下载抖音视频
2019/06/17 Python
python tkinter库实现气泡屏保和锁屏
2019/07/29 Python
Python利用WMI实现ping命令的例子
2019/08/14 Python
详解Python的爬虫框架 Scrapy
2020/08/03 Python
css3实现的下拉菜单效果示例
2014/01/22 HTML / CSS
行政管理专业推荐信
2013/11/02 职场文书
行政助理岗位职责范文
2013/12/03 职场文书
大学生自我鉴定评语
2014/01/27 职场文书
安全生产承诺书
2014/03/26 职场文书
环保倡议书400字
2014/05/15 职场文书
大学开学典礼新闻稿
2015/07/17 职场文书
Java中多线程下载图片并压缩能提高效率吗
2021/07/01 Java/Android
java中为什么说子类的构造方法默认访问的是父类的无参构造方法
2022/04/13 Java/Android