接口参数校验

方式一:使用hibernate-validator注解方式参数校验


类似的框架太多了。缺点:返回的提示信息顺序不太确定

文档:https://hibernate.org/validator/documentation/

参考资料:https://blog.csdn.net/weixin_45080272/article/details/128413908

<dependency><groupId>org.hibernate.validator</groupId><artifactId>hibernate-validator</artifactId>
</dependency>

① 在实体类的字段上添加参数校验的注解,如@Max、@Min、@NotNull等校验规则

/*** 模板类型:1-同城寄,2-省内寄,3-经济区互寄,4-跨省*/
@ApiModelProperty(value = "模板类型:1-同城寄,2-省内寄,3-经济区互寄,4-跨省", required = true)
@Max(value = 4, message = "类型值必须是1、2、3、4")
@Min(value = 1, message = "类型值必须是1、2、3、4")
@NotNull(message = "模板类型不能为空")
private Integer templateType;

② 在对应controller类上添加@@Validated 注解,表示开启参数校验

@Slf4j
@Validated // 开启参数校验
@RestController
@Api(tags = "运费管理")
@RequestMapping("/carriages")
public class CarriageController {......
}    

对于表单、url参数校验,在controller方法入参上添加校验规则:

image.png
常见的校验注解:

  • @Null 被注释的元素必须为 null
  • @NotNull 被注释的元素必须不为 null
  • @AssertTrue 被注释的元素必须为 true
  • @AssertFalse 被注释的元素必须为 false
  • @Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
  • @Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
  • @DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
  • @DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
  • @Size(max=, min=) 被注释的元素的大小必须在指定的范围内
  • @Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内
  • @Past 被注释的元素必须是一个过去的日期
  • @Future 被注释的元素必须是一个将来的日期
  • @Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式
  • Hibernate Validator 提供的校验注解:
    • @NotBlank(message =) 验证字符串非null,且长度必须大于0
    • @Email 被注释的元素必须是电子邮箱地址
    • @Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
    • @NotEmpty 被注释的字符串的必须非空
    • @Range(min=,max=,message=) 被注释的元素必须在合适的范围内

对于controller方法入参的实体类数进行校验:(需要在方法形参前面添加@Valid注解,这样实体类里的字段校验规则才能生效)

@PostMapping
public CarriageDTO saveOrUpdate(@Valid @RequestBody CarriageDTO carriageDto) {return carriageService.saveOrUpdate(carriageDto);
}

但是这样操作太耦合了,每次使用都要往形参对象上加注解。

补充:使用AOP切面方式,在方法入参时对请求体对象进行参数校验

/*** 请求参数校验切面,统一对Controller中@RequestBody映射的对象进行校验,在Controller方法中无需单独处理*/
@Aspect // 声明当前类为切面
@Slf4j
@EnableAspectJAutoProxy // 开启AOP注解功能
@Component
public class ValidatedAspect {@Resourceprivate Validator validator; //javax提供的参数校验/*** 定义切面---在controller方法入参时对请求体对象进行参数校验(校验规则在实体类中)** @param proceedingJoinPoint 切入点对象* @return* @throws Throwable*/// @Around: 环绕通知,可以在目标方法执行前后进行一些处理,方法参数与原方法一致, 返回值类型与原方法返回值类型一致// 切点表达式: "execution(* com.sl..controller.*Controller.*(..))",匹配所有controller方法@Around("execution(* com.sl..controller.*Controller.*(..))")public Object around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {// 获取@RequestBody映射的对象:请求体对象Object body = AspectUtil.getBody(proceedingJoinPoint);// 不为空的body进行拦截校验if (!ObjectUtil.isEmpty(body)) {// 进行校验// validator.validate(body):验证实体对象中的所有约束,他把校验失败的字段信息封装成一个Set集合返回Set<ConstraintViolation<Object>> validateResult = validator.validate(body);if (CollUtil.isNotEmpty(validateResult)) {//如果校验结果不为空,表示没有通过校验,则抛出异常,由统一异常处理机制进行处理,响应400String info = JSONUtil.toJsonStr(validateResult.stream().map(ConstraintViolation::getMessage).collect(Collectors.toList()));throw new SLException(info, HttpStatus.BAD_REQUEST.value());}}//校验通过,执行原方法:roceedingJoinPoint.proceed(传原方法的入参)return proceedingJoinPoint.proceed(proceedingJoinPoint.getArgs());}
}
/*** 切面工具类* * @author 白豆五* @date 2023/09/04* @since JDK8*/
@Slf4j
public class AspectUtil {/*** 获取被拦截方法对象* @param pjp {@link ProceedingJoinPoint}* @return {@link Method}*/public static Method getMethod(ProceedingJoinPoint pjp) {//获取参数的类型Signature sig = pjp.getSignature();if (sig instanceof MethodSignature) {MethodSignature methodSignature = (MethodSignature) sig;return methodSignature.getMethod();} else {throw new IllegalArgumentException("It's not method");}}/*** 解析SPEL表达式** @param key key* @param method {@link   Method}* @param args {@code Object[]}* @return key*/public static String parse(String key, Method method, Object[] args) {if (StringUtils.isNotBlank(key) && key.indexOf("#") > -1) {Pattern pattern = Pattern.compile("(\\#\\{([^\\}]*)\\})");Matcher matcher = pattern.matcher(key);List<String> keys = new ArrayList<>();while (matcher.find()) {keys.add(matcher.group());}if (!CollectionUtils.isEmpty(keys)) {LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();String[] paraNameArr = u.getParameterNames(method);ExpressionParser parser = new SpelExpressionParser();StandardEvaluationContext context = new StandardEvaluationContext();for (int i = 0; i < paraNameArr.length; i++) {context.setVariable(paraNameArr[i], args[i]);}for (String tmp : keys) {key = key.replace(tmp, parser.parseExpression("#" + tmp.substring(2, tmp.length() - 1)).getValue(context, String.class));}return key;}}return key;}/*** 获取请求体** @param pjp {@link ProceedingJoinPoint}* @return {@code Object}*/public static Object getBody(ProceedingJoinPoint pjp) {Object[] args = pjp.getArgs();Method method = getMethod(pjp);if (ObjectUtil.isNotEmpty(args)) {Annotation[][] parameterAnnotations = method.getParameterAnnotations();for (int count = 0; count < parameterAnnotations.length; count++) {for (Annotation annotation : parameterAnnotations[count]) {if (annotation instanceof RequestBody) {return args[count];}}}}return null;}
}

方式二:在程序中使用if语句进行参数校验


最粗暴的方式。

public boolean updateStatus(List<String> ids) {if(CollUtil.isEmpty(ids)){return false;       }
}

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

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

相关文章

实战 - Restful APi 格式规范

文章目录 1. 特征2. 优点3. 动作1. GET 获取资源2. POST 创建资源3. PUT 整体替换4. PATCH 部分替换5. DELETE 删除资源 4. 示例 RESTful是一种API的设计风格&#xff0c;他和GraphQL &#xff0c;JSON-RPC&#xff0c;WebService类似&#xff0c;用于定义在CS、BS架构下暴露服…

jenkins如何请求http接口及乱码问题解决

文章目录 1.插件安装2.请求pipline语法3.插件方式实现4.乱码问题解决5.值得注意 1.插件安装 需要安装HTTP Request 插件&#xff1b;安装方式不介绍。 2.请求pipline语法 官网链接&#xff0c;上面有详细语法&#xff1a;https://plugins.jenkins.io/http_request/ 附一个d…

OpenCV(十二):图像透视变换

目录 1.透视变换介绍 2.计算透视变换矩阵getPerspectiveTransform(&#xff09; 3.透视变换函数warpPerspective() 4.demo 1.透视变换介绍 透视变换是一种将原始图像映射到目标图像平面上的投影变换&#xff0c;又称为四点变换。 透视变换矩阵的一般形式如下所示&#xff…

Etherpad安装手册(win10 64位电脑)

Etherpad安装手册 我使用的为win10 64位电脑 一、按照教程下载安装Etherpad 按照该文章下载安装&#xff0c;下面记录我的过程 1.下载etherpad 2.解压缩etherpad到d盘 3.双击start.bat&#xff0c;启动编辑器服务 注意&#xff1a;可能出现问题如下图&#xff0c;跳转二 4.在…

websocket--技术文档--spring后台+vue基本使用

阿丹: 给大家分享一个可以用来进行测试websocket的网页&#xff0c;个人觉得还是挺好用的. WebSocket在线测试工具 还有一个小家伙ApiPost也可以进行使用websocket的测试。 本文章只是基本使用--给大家提供思路简单实现&#xff01;&#xff01; 使用spring-boot建立一个服…

【Vue】 Vue3 安装说明,适合小白新手

1、独立版本 我们可以在 Vue.js 的官网上直接下载最新版本, 并用 下载 Vue.js https://unpkg.com/vuenext 2、使用 CDN 方法 以下推荐国外比较稳定的两个 CDN&#xff0c;国内还没发现哪一家比较好&#xff0c;目前还是建议下载到本地。 Staticfile CDN&#xff08;国内&am…

React Hooks总览

总览 hooks 功能分类具体 hooks具体功能React v18新特性跨端支持数据更新驱动useState定义要在页面中渲染的数据❌✔useReducer定义要在页面中渲染的数据&#xff0c;且这个数据有多种处理逻辑❌✔useSyncExternalStoreconcurrent 模式下&#xff0c;订阅外部 store 的行为&am…

hive anti join 的几种写法

t_a 表的记录如下 c1 | :———— | a | b | c | 生成 SQL 如下&#xff1a; create table t_a(c1 string); insert into t_a values("a"),("b"),("c");t_b 表的记录如下 c1bm 生成 SQL 如下&#xff1a; create table t_b(c1 string); in…

Java低代码开发:jvs-list(列表引擎)功能(一)配置说明

在低代码开发平台中&#xff0c;列表页是一个用于显示数据列表的页面。它通常用于展示数据库中的多条记录&#xff0c;并提供搜索、排序和筛选等功能&#xff0c;以方便用户对数据进行查找和浏览。 jvs-list是jvs快速开发平台的列表页的配置引擎&#xff0c;它和普通的crud 具…

什么是SpringCloud Eureka服务注册与发现

&#x1f600;前言 本篇博文是关于SpringCloud Eureka 介绍&#xff0c;希望你能够喜欢 &#x1f3e0;个人主页&#xff1a;晨犀主页 &#x1f9d1;个人简介&#xff1a;大家好&#xff0c;我是晨犀&#xff0c;希望我的文章可以帮助到大家&#xff0c;您的满意是我的动力&…

CS420 课程笔记 P4 - 以16进制形态编辑游戏文件

文章目录 IntroductionFinding save filesStringsUnicodeExample!Value searchHealth searchConclusion Introduction 这节课我们将学习编辑十六进制&#xff0c;主要用于编辑保存文件&#xff0c;但十六进制编辑涉及的技能可以很好地转移到&#xff1a; Save file editingRe…

【go-zero】使用自带Redis方法

yaml配置文件 RedisS:Host: Type: Pass: config增加 RedisS struct {Host stringType stringPass string}svc文件 type * struct {RedisClient *redis.Redis } func *(c config.Config) * {sqlConn : sqlx.NewMysql(c.DB.DataSource)return &*{RedisClient: redis.New(c…

linux配置网络的几种常用方法

linux配置ip地址有多种不同的方法&#xff0c;大家可以根据自己的需要来使用不同的方法配置ip地址。 方法一 ifconfig命令 使用 ifconfig 命令配置 IP 地址ifconfig 命令用于查看和配置网络接口&#xff0c; 可以使用该命令为网络接口配置 IP 地址。假设需要配置 eth0 网卡的…

Flutter实现CombineExecutor进行多个异步分组监听,监听第一个异步执行的开始和最后一个异步执行结束时机。

1.场景 我们在调用接口时&#xff0c;很多时候会同时调用多个接口&#xff0c;接口都是异步执行&#xff0c;我们很难知道调用的多个接口哪个会最后执行完成&#xff0c;我们有时候需要对最后一个接口执行完成的时机监听&#xff0c;所以基于该需求&#xff0c;设计了CombineE…

Shell 运算符及语法结构

目录 一、Shell运算符 1.1 表达式expr 1.2 运算操作 1.3 操作实例 二、Shell条件判断 2.1 基本语法 2.2 值、权限、类型、多条件判断 三、Shell流程控制 3.1 if 流程语法 3.2 case 流程语法 3.3 for 流程语法 3.4 内部运算符 3.5 while循环流程语法 四、Shell读…

TOOLLLM: FACILITATING LARGE LANGUAGE MODELS TO MASTER 16000+ REAL-WORLD APIS

本文是LLM系列的文章之一&#xff0c;针对《TOOLLLM: FACILITATING LARGE LANGUAGE MODELS TO MASTER 16000 REAL-WORLD APIS》的翻译。 TOOLLLMs&#xff1a;让大模型掌握16000的真实世界APIs 摘要1 引言2 数据集构建3 实验4 相关工作5 结论 摘要 尽管开源大型语言模型&…

前端图形图像的框架

前端图形图像方面有许多强大的框架和库&#xff0c;使得开发者能够更容易地创建丰富的视觉效果和复杂的图形应用。下面列举了一些主要的框架和库&#xff1a; 1. Three.js Three.js 是一款运行在浏览器中的 3D 引擎&#xff0c;你可以用它创建各种三维场景&#xff0c;包括了相…

如何将两个pdf合并成一个?pdf合并技巧分享

在日常工作过程当中&#xff0c;我们经常需要处理一些文件&#xff0c;而文件的处理往往是琐碎的&#xff0c;想要提高工作效率&#xff0c;需要选择一些合适的方法&#xff0c;并掌握一定的技巧&#xff0c;那么&#xff0c;如何将两个pdf合并成一个?pdf合并技巧有哪些呢?接…

java实现状态模式

状态模式是一种行为设计模式&#xff0c;它允许对象在内部状态改变时改变其行为。在状态模式中&#xff0c;对象将其行为委托给表示不同状态的状态对象&#xff0c;这些状态对象负责管理其行为。以下是在 Java 中实现状态模式的一般步骤&#xff1a; 创建一个状态接口&#xff…

AFG EDI 解决方案

AFG一直是汽车行业出境物流的专家&#xff0c;不仅运输汽车&#xff0c;同时也提供模块化IT解决方案&#xff0c;用于接收、控制、互联以及整个车辆调度过程的可视化和监控。 对于物流行业而言&#xff0c;如果已经确定了供应链整合的目标&#xff0c;但却没有明确的计划及足够…