@Controller层自定义注解拦截request请求校验

一、背景

笔者工作中遇到一个需求，需要开发一个注解，放在controller层的类或者方法上，用以校验请求参数中(不管是url还是body体内，都要检查，有token参数，且符合校验规则就放行)是否传了一个token的参数，并且token符合一定的生成规则，符合就不予拦截，放行请求，否则拦截请求。

用法如下图所示

可以看到 @TokenCheck 注解既可以放在类上，也可以放在方法上 ，放在类上则对该类中的所有的方法进行拦截校验。

注意：是加了注解才会校验是否拦截，不加没有影响。

整个代码都是使用的最新springboot版本开发的，所以servlet相关的类都是使用jakarta

 

如果你的springboot版本比较老 ，请使用javax

先引入以下依赖(javax不飘红不用引入)

<dependency>

      <groupId>javax.servlet</groupId>

      <artifactId>javax.servlet-api</artifactId>

      <version>4.0.1</version>

      <scope>provided</scope>

</dependency>

 

 

我用到的第三方依赖

<dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId><version>3.12.0</version>
</dependency>
<dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>5.8.24</version>
</dependency>
<dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>6.0.11</version>
</dependency>

二、TokenCheck注解

package com.example.demo.interceptorToken;import java.lang.annotation.*;/*** 是否有token*/
@Documented
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface TokenCheck {
}

三、请求包装器RequestWrapper

主要是对request请求包装下，因为拦截器会拦截request，会读取其中的参数流，而流只能读一次，后续再用到流的读取会报错，所以用一个包装器类处理下，把流以字节形式读出来，重写了getInputStream()，后续可以重复使用。

package com.example.demo.interceptorToken;import jakarta.servlet.ReadListener;
import jakarta.servlet.ServletInputStream;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletRequestWrapper;
import org.apache.commons.lang3.StringUtils;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;/*** @author hulei* @date 2024/1/11 19:48* @Description 由于 request中getReader()和getInputStream()只能调用一次 导致在Controller @ResponseBody的时候获取不到 null 或 Stream closed* 在项目中，可能会出现需要针对接口参数进行校验等问题* 构建可重复读取inputStream的request*/
public class RequestWrapper extends HttpServletRequestWrapper {// 将流保存下来private final byte[] requestBody;public RequestWrapper(HttpServletRequest request) throws IOException {super(request);requestBody = readBytes(request.getReader());}@Overridepublic ServletInputStream getInputStream() {final ByteArrayInputStream basic = new ByteArrayInputStream((requestBody != null && requestBody.length >0) ? requestBody : new byte[]{});return new ServletInputStream() {@Overridepublic int read() {return basic.read();}@Overridepublic boolean isFinished() {return false;}@Overridepublic boolean isReady() {return false;}@Overridepublic void setReadListener(ReadListener readListener) {}};}@Overridepublic BufferedReader getReader() {return new BufferedReader(new InputStreamReader(getInputStream()));}/*** 通过BufferedReader和字符编码集转换成byte数组*/private byte[] readBytes(BufferedReader br) throws IOException {String str;StringBuilder retStr = new StringBuilder();while ((str = br.readLine()) != null) {retStr.append(str);}if (StringUtils.isNotBlank(retStr.toString())) {return retStr.toString().getBytes(StandardCharsets.UTF_8);}return null;}
}

四、过滤器RequestFilter

自定义请求过滤器，把请求用自定义的包装器RequestWrapper包装下，往调用下文传递，也是为了让request请求的流能多次读取

 

package com.example.demo.interceptorToken;
import jakarta.servlet.*;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.NonNull;
import org.springframework.core.annotation.Order;
import org.springframework.web.filter.OncePerRequestFilter;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import org.springframework.web.multipart.support.StandardServletMultipartResolver;
import java.io.IOException;/*** @author hulei* @date 2024/1/11 19:48* 自定义请求过滤器*/
//排序优先级,最先执行的过滤器
@Order(0)
public class RequestFilter extends OncePerRequestFilter {//spring6.0版本后删除了CommonsMultipartResolver,使用StandardServletMultipartResolver//如果是spring6.0版本,此行代码不报错请使用如下// private CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver();private final StandardServletMultipartResolver multipartResolver = new StandardServletMultipartResolver();/****/@Overrideprotected void doFilterInternal(@NonNull HttpServletRequest request, @NonNull HttpServletResponse response, @NonNull FilterChain filterChain) throws ServletException, IOException {//请求参数有form_data的话，防止request.getHeaders()报已使用,单独处理if (request.getContentType().contains("multipart/form-data")) {MultipartHttpServletRequest multiReq = multipartResolver.resolveMultipart(request);filterChain.doFilter(multiReq, response);}else{ServletRequest requestWrapper;requestWrapper = new RequestWrapper(request);filterChain.doFilter(requestWrapper, response);}}}

五、请求过滤器配置类TokenFilterConfig

这个很好理解，把自定义配置类注入spring容器

package com.example.demo.interceptorToken;import jakarta.servlet.Filter;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletContext;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;import java.util.Enumeration;/*** @author hulei* @date 2024/1/11 19:48* 将过滤器注入spring容器中*/
@Configuration
public class TokenFilterConfig implements FilterConfig {@BeanFilter bodyFilter() {return new RequestFilter();}@Beanpublic FilterRegistrationBean<RequestFilter> filters() {FilterRegistrationBean<RequestFilter> filterRegistrationBean = new FilterRegistrationBean<>();filterRegistrationBean.setFilter((RequestFilter) bodyFilter());filterRegistrationBean.addUrlPatterns("/*");filterRegistrationBean.setName("requestFilter");//多个filter的时候order的数值越小 则优先级越高//filterRegistrationBean.setOrder(0);return filterRegistrationBean;}@Overridepublic String getFilterName() {return null;}@Overridepublic ServletContext getServletContext() {return null;}@Overridepublic String getInitParameter(String s) {return null;}@Overridepublic Enumeration<String> getInitParameterNames() {return null;}
}

 六、核心类RequestInterceptor拦截器

注意如果你的springboot版本也是低于3.0，请继承HandlerInterceptorAdapter类，实现其中方法，基本不用改动类中的内容，只需要 把implements HandlerInterceptor 改为extends HandlerInterceptorAdapter即可。

package com.example.demo.interceptorToken;import cn.hutool.json.JSONArray;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import jakarta.servlet.ServletInputStream;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.NonNull;
import org.apache.commons.lang3.StringUtils;
import org.springframework.util.StreamUtils;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import org.springframework.web.multipart.support.StandardServletMultipartResolver;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Method;
import java.net.URLDecoder;
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;/*** @author hulei* @date 2024/1/11 19:48* 自定义请求拦截器(spring boot 3.0以下的版本,需要继承HandlerInterceptorAdapter类,de方法)*/public class RequestInterceptor implements HandlerInterceptor {/*** 需要从请求里验证的关键字参数名*/private static final String TOKEN_STR = "token";/*** 进入拦截的方法前触发* 这里主要从打了注解请求中查找有没有token关键字,并且token的值是否符合一定的生成规则,是就放行,不是就拦截*/@Overridepublic boolean preHandle(@NonNull HttpServletRequest request,@NonNull HttpServletResponse response,@NonNull Object handler) throws Exception {if(handler instanceof HandlerMethod handlerMethod){//获取token注解TokenCheck tokenCheck = getTokenCheck(handlerMethod);//请求参数有form_data的话，防止request.getHeaders()或request.getInputStream()报已使用错误,单独处理if( request.getContentType() != null && request.getContentType().contains("multipart/form-data")){//判断当前注解是否存在if(tokenCheck != null){final StandardServletMultipartResolver multipartResolver = new StandardServletMultipartResolver();MultipartHttpServletRequest multipartHttpServletRequest = multipartResolver.resolveMultipart(request);//获取全部参数,不管是params里的还是form_data里的//Map<String,String[]> bodyParam = multipartHttpServletRequest.getParameterMap();//直接获取token参数String token = multipartHttpServletRequest.getParameter(TOKEN_STR);if(!StringUtils.isEmpty(token)){boolean tokenRuleValidation = tokenRuleValidation(token);if(!tokenRuleValidation){returnJson(response, "token校验失败");return false;}return true;}returnJson(response, "token校验失败");return false;}}else{//判断当前注解是否存在if (tokenCheck != null) {// 获取请求方式//String requestMethod = request.getMethod();// 获取请求参数Map<String,String> paramMap;//token关键字,分别是来自url的token或者来自body中的tokenString tokenFromUrl,tokenFromBody = "";request = new RequestWrapper(request);String bodyParamsStr = this.getPostParam(request);tokenFromBody = getTokenFromBody(bodyParamsStr,tokenFromBody);paramMap = getUrlQueryMap(request);tokenFromUrl = paramMap.get(TOKEN_STR);if(tokenRuleValidation(tokenFromUrl)|| tokenRuleValidation(tokenFromBody)){return true;}else {returnJson(response, "token校验失败");return false;}}}return true;}return true;}private static TokenCheck getTokenCheck(HandlerMethod handler) {Method method = handler.getMethod();//获取方法所属的类,并获取类上的@TokenCheck注解Class<?> clazz = method.getDeclaringClass();TokenCheck tokenCheck = null;if(clazz.isAnnotationPresent(TokenCheck.class)){tokenCheck = clazz.getAnnotation(TokenCheck.class);}//类上没有注解,则从方法上再获取@TokenChecktokenCheck = tokenCheck == null ? method.getAnnotation(TokenCheck.class) : tokenCheck;return tokenCheck;}/*** 从请求体获取token参数*/private String getTokenFromBody(String bodyParamsStr,String tokenFromBody){//判断是否是json数组boolean isJsonArray = JSONUtil.isTypeJSONArray(bodyParamsStr);if(!isJsonArray){tokenFromBody = JSONUtil.parseObj(bodyParamsStr).getStr(TOKEN_STR);}else{JSONArray jsonArray = JSONUtil.parseArray(bodyParamsStr);Set<String> tokenSet = new HashSet<>();for (int i = 0; i < jsonArray.size(); i++) {JSONObject jsonObject = jsonArray.getJSONObject(i);if(StringUtils.isNotEmpty(jsonObject.getStr(TOKEN_STR))){tokenSet.add(jsonObject.getStr(TOKEN_STR));}}if(!tokenSet.isEmpty()){tokenFromBody = tokenSet.stream().filter(this::tokenRuleValidation).findFirst().orElse("");}}return tokenFromBody;}/*** token 规则校验* @param token token关键字*/private boolean tokenRuleValidation(String token){return "AAABBB".equals(token);}/*** 如果是get请求,则把url中的请求参数获取到,转换为map*/public static Map<String, String> getUrlQueryMap(HttpServletRequest request) throws UnsupportedEncodingException {//获取当前请求的编码方式,用于参数value解码String encoding = request.getCharacterEncoding();String urlQueryString = request.getQueryString();Map<String, String> queryMap = new HashMap<>();String[] arrSplit;if (urlQueryString == null) {return queryMap;} else {//每个键值为一组arrSplit = urlQueryString.split("&");for (String strSplit : arrSplit) {String[] arrSplitEqual = strSplit.split("=");//解析出键值if (arrSplitEqual.length > 1) {queryMap.put(arrSplitEqual[0],URLDecoder.decode(arrSplitEqual[1], encoding));} else {if (!"".equals(arrSplitEqual[0])) {queryMap.put(arrSplitEqual[0], "");}}}}return queryMap;}/*** 离开拦截的方法后触发*/@Overridepublic void postHandle(@NonNull HttpServletRequest request,@NonNull HttpServletResponse response,@NonNull Object handler, ModelAndView modelAndView) {}/*** 返回*/private void returnJson(HttpServletResponse response, String json) throws IOException {response.setCharacterEncoding("UTF-8");response.setContentType("text/html; charset=utf-8");try (PrintWriter writer = response.getWriter()) {writer.print(json);}}private String getPostParam(HttpServletRequest request) throws Exception{RequestWrapper readerWrapper = new RequestWrapper(request);return StringUtils.isEmpty(getBodyParams(readerWrapper.getInputStream(), request.getCharacterEncoding())) ?"{}":getBodyParams(readerWrapper.getInputStream(), request.getCharacterEncoding());}/*** 获取POST、PUT、DELETE请求中Body参数**/private String getBodyParams(ServletInputStream inputStream, String charset) throws Exception {String body = StreamUtils.copyToString(inputStream, Charset.forName(charset));if (StringUtils.isEmpty(body)) {return "";}return body;}
}

七、拦截器注册InterceptorRegister

一个配置类，把自定义的拦截器注入spring

package com.example.demo.interceptorToken;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;/*** @author hulei* @date 2024/1/11 19:48* 将拦截注入spring容器*/
@Configuration
public class InterceptorRegister implements WebMvcConfigurer {@Beanpublic RequestInterceptor tokenInterceptor() {return new RequestInterceptor();}@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(tokenInterceptor());}
}

 八、总结

本例主要是自定义注解，完成请求参数的拦截校验，实际中可根据需求进行修改，如记录日志，拦截校验其他参数，修改RequestInterceptor中的拦截前方法和拦截后方法的逻辑即可

gitee地址: Token-Check-Demo: 自定义注解拦截request请求

注: 创作不易，转载请标明原作地址

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/625874.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

从车联网到智慧城市：智慧交通的革新之路

从车联网到智慧城市：智慧交通的革新之路

一、引言 1、智慧城市的概念和发展背景 智慧城市&#xff08;Smart City&#xff09;是指以信息技术为基础&#xff0c;运用信息与通信等手段&#xff0c;对城市各个核心系统各项关键数据进行感测、分析、整合和利用&#xff0c;实现对城市生活环境的感知、资源的调控&#x…
阅读更多...
Linux下的HTTPS配置：从证书到安全连接

Linux下的HTTPS配置：从证书到安全连接

在当今的互联网环境中&#xff0c;数据传输的安全性越来越受到重视。HTTPS&#xff0c;作为HTTP的安全版本&#xff0c;通过使用SSL/TLS协议来加密数据传输&#xff0c;确保了数据在传输过程中的安全。在Linux环境下&#xff0c;配置HTTPS需要从证书的生成到服务器的配置进行一…
阅读更多...
用 YAML 文件配置 CI/CD 管道

用 YAML 文件配置 CI/CD 管道

MSBuild 参数： 在使用 MSBuild 命令行生成打包项目（就像在 Visual Studio 中使用向导生成项目一样）之前，生成过程可以通过编辑 Package.appxmanifest 文件中 Package 元素的 Version 属性，来对生成的 MSIX 包进行版本控制。 在 Azure Pipelines 中，可以使用某个表达式来…
阅读更多...
内网yum仓库 ftp；http方式

内网yum仓库 ftp；http方式

ftp方式 服务端 客户端 vim /etc/yum.repos.d/ftp.repo http方式 服务端 yum install httpd -y systemctl start httpd cd /var/www/html/ mkdir centos7 mount /dev/sr0 /var/www/html/centos7 客户端
阅读更多...
pip与pip3的区别

pip与pip3的区别

pip 和 pip3 都是 Python 的包管理工具&#xff0c;用于安装第三方库。它们的区别在于&#xff1a; pip 是 Python 2 和 Python 3 通用的包管理工具&#xff0c;它可以安装适用于 Python 2 和 Python 3 的库。pip3 是专门用于 Python 3 的包管理工具&#xff0c;它只能安装适用…
阅读更多...
CAN-位填充

CAN-位填充

位填充定义&#xff08;Bit Stuffing&#xff09; 当CAN节点发送 逻辑电平&#xff08;显性dominant或隐性recessive&#xff09;为持续相同的5位时&#xff0c;它必须添加一位反向电平。 CAN接收 节点会自动删除这个新增的额外电平位。 位填充作用 1---位填充是为了防止突发…
阅读更多...
【2024-01-15】某安居客验证码分析-滑块验证码

【2024-01-15】某安居客验证码分析-滑块验证码

声明：该专栏涉及的所有案例均为学习使用，严禁用于商业用途和非法用途，否则由此产生的一切后果均与作者无关！如有侵权，请私信联系本人删帖！ 文章目录 一、抓包分析二、参数分析1.请求getInfoTp2.校验checkInfoTp一、抓包分析 网址： aHR0cHM6Ly9hcGkuYW5qdWtlLmNvbS93ZWI…
阅读更多...
任务15：使用Hive进行全国气象数据分析

任务15：使用Hive进行全国气象数据分析

任务描述 知识点&#xff1a; 使用Hive进行数据分析 重 点&#xff1a; 掌握Hive基本语句熟练使用Hive对天气数据进行分析 内 容&#xff1a; 使用Hive创建外部表使用Hive对数据进行统计分析 任务指导 1. 使用Hive创建基础表 将China_stn_city.csv文件上传到HDFS的/…
阅读更多...
统计学之常见的分布介绍

统计学之常见的分布介绍

统计学中常见的分布有&#xff1a; 1. 正态分布&#xff08;Normal Distribution&#xff09;&#xff1a;也称为高斯分布&#xff0c;是最常见的分布之一&#xff0c;具有钟形曲线&#xff0c;对称且均值和标准差可以完全描述该分布。 2. 二项分布&#xff08;Binomial Dist…
阅读更多...
Unity3D学习之数据持久化——PlayerPrefs

Unity3D学习之数据持久化——PlayerPrefs

文章目录 1. 概念2. 存储2.1 存到内存当中2.2 存到硬盘当中2.3 局限性2.4 相同键会覆盖 3.读取3.1 int型3.2 float型3.3 string型3.4 判断数据是否存在 4. 删除数据5. 存储位置6. 反射6.1 判断一个类型的对象是否可以让另一个类型为自己分配空间6.2 通过反射获得泛型类型 7 数据…
阅读更多...
斯坦福 Stats60：21 世纪的统计学：第十五章到第十八章

斯坦福 Stats60：21 世纪的统计学：第十五章到第十八章

第十五章&#xff1a;比较均值 原文&#xff1a;statsthinking21.github.io/statsthinking21-core-site/comparing-means.html 译者&#xff1a;飞龙 协议&#xff1a;CC BY-NC-SA 4.0 我们已经遇到了许多情况&#xff0c;我们想要询问样本均值的问题。在本章中&#xff0c;我们…
阅读更多...
Keepalived 双机热备

Keepalived 双机热备

本章主要内容&#xff1a; Keepalived 双机热备基础知识学会构建双机热备系统学会构建LVSHA 高可用群集 简介 在这个高度信息化的IT时代&#xff0c;企业的生产系统&#xff0c;业务运营&#xff0c;销售和支持&#xff0c;以及日常管理等环节越来越依赖于计算机和服务&#…
阅读更多...
Shape-IoU——综合考量边框形状与尺度的度量

Shape-IoU——综合考量边框形状与尺度的度量

今天看到一篇文章主要是提出了一种更有效的IOU度量方法&#xff0c;论文地址在这里&#xff0c;如下所示&#xff1a; 摘要 边界盒回归损失作为检测器定位分支的重要组成部分&#xff0c;在目标检测任务中起着重要作用。现有的边界框回归方法通常考虑GT框和预测框之间的几何关…
阅读更多...
使用ffmpeg进行视频截取

使用ffmpeg进行视频截取

1 原始视频信息 通过ffmpeg -i命令查看视频基本信息 ffmpeg version 6.1-essentials_build-www.gyan.dev Copyright (c) 2000-2023 the FFmpeg developersbuilt with gcc 12.2.0 (Rev10, Built by MSYS2 project)configuration: --enable-gpl --enable-version3 --enable-sta…
阅读更多...
SqlAlchemy使用教程(四) MetaData 与 SQL Express Language 的使用

SqlAlchemy使用教程(四) MetaData 与 SQL Express Language 的使用

四、Database MetaData 与 SQL Express Language 的使用 MetaData对象用于描述表结构&#xff0c;SQL Express Language是DBAPI SQL的统一封装器。MetaData 与SQL Express 语句可以在Core层使用&#xff0c;ORM层基于MetaData, SQL Express基础上做了进一步抽象。本章将介绍在…
阅读更多...
Python简单ORM实现：不使用元类的灵活数据操作与查询构建【第29篇—python：ORM】

Python简单ORM实现：不使用元类的灵活数据操作与查询构建【第29篇—python：ORM】

文章目录 不使用元类的简单ORM实现Field类Compare类Model类Query类示例使用扩展查询功能支持 LIMIT 和 OFFSET支持 GROUP BY 和 HAVING 示例用法总结 不使用元类的简单ORM实现 在 Python 中&#xff0c;ORM&#xff08;Object-Relational Mapping&#xff09;是一种将对象和数…
阅读更多...
基于uniapp的在线课程教学系统

基于uniapp的在线课程教学系统

介绍 项目背景&#xff1a; 随着互联网的快速发展&#xff0c;在线教育已经成为一种流行的学习方式。针对这一趋势&#xff0c;我们决定开发一个基于UniApp的在线课程教学系统。该系统旨在为学生提供方便快捷的在线学习体验&#xff0c;同时也为教师提供一个高效管理课程的平台…
阅读更多...
《计算机视觉处理设计开发工程师》

《计算机视觉处理设计开发工程师》

计算机视觉&#xff08;Computer Vision&#xff09;是一门研究如何让计算机能够理解和分析数字图像或视频的学科。简单来说&#xff0c;计算机视觉的目标是让计算机能够像人类一样对视觉信息进行处理和理解。为实现这个目标&#xff0c;计算机视觉结合了图像处理、机器学习、模…
阅读更多...
做品牌，怎么挖掘用户深层需求？

做品牌，怎么挖掘用户深层需求？

品牌想要长久发展&#xff0c;就需要去挖掘用户深层需求&#xff0c;什么是用户深层需求&#xff0c;比如做美业的认为用户想要变美是深层次的需求&#xff0c;但其实由美貌带来的附加利益比如说更上镜、竞争优势更大等才属于深层需求&#xff0c;今天媒介盒子就来和大家聊聊&a…
阅读更多...
compose 实验

compose 实验

cd /opt mkdir compose_nginx cd compose_nginx mkdir nginx cd nginx/ 此时顺便将nginx安装包拖进来 vim Dockerfile mkdir /opt/compose_nginx/wwwroot echo "<h1>this is test web</h1>" > /opt/compose_nginx/wwwroot/index.html docker netw…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023