百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 热门文章 > 正文

API参数如何验证?别纠结,拿去用就是

bigegpt 2024-09-27 00:33 3 浏览


关注“一猿小讲”公众号的小伙伴都清楚,在七夕虐狗的日子,我们结合以往的实战项目,重磅推出《七夕,带你生撸一个验证框架》,一起生撸了一个 API 参数验证的轮子。

打造的那款轮子可以使研发人员,不再纠结参数校验,通过简单的配置就可以完成校验;可以腾出更多时间,去完成业务代码的编写;充分达到验证与业务剥离。

好了,低调点,不吹捧啦。还是回归一下今天的主题,今天我们主要分享项目实战中,另一种常用的参数校验框架 Hibernate Validator,请准备好小板凳,我们的分享开始。


1.

是啥?

先抛一张图,锻炼一下你的观察力。


通过上图有没有发现,数据校验可谓是贯穿所有的应用程序层(从表示层到持久层),而通常在每一层要实现相同的验证逻辑,这样既耗时又容易出错。

那再抛一张图,欢迎大家一起来找茬(结合上幅图)。


我们会发现,为了避免每层进行重复的数据验证,可以将验证逻辑直接捆绑到域模型中,将域类与验证代码混淆。

有点意思,你可能会有点懵,莫急!你就简单认为在你的实体类属性上加点校验规则,但是这些校验规则到底该怎么加呢?

这不在 JSR380-Bean Validation 2.0 中为实体和方法验证定义元数据模型和API,是不是又茫然啦,啥是 JSR?啥是JSR380?

为了以后再见到内心不发虚,我们再解释一下。

JSR 是 Java 界的一个重要标准,是 Java Specification Requests 的缩写,意思是 Java 规范提案,任何人都可以提交 JSR ,以向 Java 平台增添新的 API 和服务。

JSR380-Bean Validation 2.0 是 Java 定义的一套最新的数据校验规范。

说了这么多,只有规范没有实现,一切都是扯淡。别急,该我们的大猪蹄子 Hibernate Validator 登场了。

那 Hibernate Validator 到底是啥?一句话说清楚:Hibernate Validator 是 JSR 380 数据校验规范的一种实现。

到这,你多多少少应该了解 JSR、JSR 380、Hibernate Validator。

好了,光耍嘴皮子,不干活那是码农中的流氓,也是时候真刀真枪的操练起来了。


2.

咋用?

第一步:引入依赖包。不用太纠结,用就完了。

<dependencies>
 <dependency>
 <groupId>org.hibernate</groupId>
 <artifactId>hibernate-validator</artifactId>
 <version>6.0.17.Final</version>
 </dependency>
 <dependency>
 <groupId>org.glassfish</groupId>
 <artifactId>javax.el</artifactId>
 <version>3.0.1-b09</version>
 </dependency>
 <dependency>
 <groupId>org.hibernate</groupId>
 <artifactId>hibernate-validator-cdi</artifactId>
 <version>6.0.17.Final</version>
 </dependency>
</dependencies>


第二步:定义登录请求对象,添加校验规则。主要关注注解即可,So easy!!

import javax.validation.constraints.*;
public class UserLoginRequest {
 @NotNull(message = "[接口版本号]不能为空!")
 @Pattern(regexp = "^(\\d+)(\\.\\d+)?$", message = "[接口版本号]格式错误!")
 @Size(min = 0, max = 4, message = "[接口版本号]长度错误,最大长度为[{max}]!")
 private String versionNo;
 @NotNull(message = "[手机号]不能为空!")
 @Size(min = 0, max = 11, message = "[用户手机号码]长度错误,最大长度为[{max}]!")
 private String mobile;
 @NotNull(message = "[订单号]不能为空!")
 @Size(min = 0, max = 32, message = "[订单号]长度错误,最大长度为[{max}]!")
 private String orderId;
 @NotNull(message = "[验证码]不能为空!")
 @Size(min = 0, max = 6, message = "[验证码]长度错误,最大长度为[{max}]!")
 private String smsCode;
 //TODO 提供setter/getter ... ...
}


第三步:按照常规,应该写个测试类,跑跑看,这次咱们就一步到位,直接封装工具类。你可以直接拿到真实项目去实践,用良心保证绝对好用。

import javax.validation.*;
import java.util.*;
public class ValidateUtil {
 public static <T> void validate(T t) {
 if (null == t) {
 throw new ValidateException("E0001", "参数为空");
 }
 ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
 Validator validator = factory.getValidator();
 Set<ConstraintViolation<T>> constraintViolations = validator.validate(t);
 List<String> errorList = new ArrayList<String>();
 for (ConstraintViolation<T> constraintViolation : constraintViolations) {
 errorList.add(constraintViolation.getMessage());
 }
 if (!errorList.isEmpty()) {
 throw new ValidateException("E9999", errorList.toString());
 }
 }
}


第四步:自定义异常,这个根据实际情况而定,非必须。

public class ValidateException extends RuntimeException {
 private String code;
 private String msg;
 
 /**
 * @param code 异常码
 * @param msg 异常消息
 */
 public ValidateException(String code, String msg) {
 super(msg);
 this.setCode(code);
 this.setMsg(msg);
 }
 
 //TODO 提供setter/getter ... ...
}


第五步:跑起来,看一看是否经得起考验。

public class App {
 public static void main(String[] args) {
 UserLoginRequest request = new UserLoginRequest();
 request.setVersionNo("abc"); //版本号输入错误
 request.setMobile("138013800000"); //手机号长度有误
 try {
 ValidateUtil.validate(request);
 } catch (ValidateException e) {
 //TODO 在实际业务中直接获取异常码、异常信息进行包装返回给前端即可
 System.out.println(String.format("code: %s, msg:%s",e.getCode(),e.getMsg()));
 }
 }
}


第六步:结果分析,看到结果,果真达到预期:手机号码长度错误、接口版本号格式有误、其它参数值传入为空。


3.

技术无止境,剩下的还需要各位自行去耕耘,不过掌握上面这些,已经够你在项目中喝一壶的啦。

好了,通过这次正规军式的分享 + 上次野战军式的分享,相信你今后肯定能玩转 API 参数校验,也就可以专心去写业务代码啦,如果你之前尚未接触过这些,不妨拿去实践,大概率会大幅提升你的研发效率,腾出更多时间喝咖啡,幸福感陡然上升。

相关推荐

有些人能留在你的心里,但不能留在你生活里。

有时候,你必须要明白,有些人能留在你的心里,但不能留在你生活里。Sometimes,youhavetorealize,Somepeoplecanstayinyourheart,...

Python学不会来打我(34)python函数爬取百度图片_附源码

随着人工智能和大数据的发展,图像数据的获取变得越来越重要。作为Python初学者,掌握如何从网页中抓取图片并保存到本地是一项非常实用的技能。本文将手把手教你使用Python函数编写一个简单的百度图片...

软网推荐:图像变变变 一“软”见分晓

当我们仅需要改变一些图片的分辨率、裁减尺寸、添加水印、标注文本、更改图片颜色,或将一种图片转换为另一种格式时,总比较讨厌使用一些大型的图像处理软件,尤其是当尚未安装此类软件时,更是如此。实际上,只需一...

首款WP8.1图片搜索应用,搜照片得资料

首款WP8.1图片搜索应用,搜照片得资料出处:IT之家原创(天际)2014-11-1114:32:15评论WP之家报道,《反向图片搜索》(ReverseImageSearch)是Window...

分享一组美图(图片来自头条)(头条美女头像)

...

盗墓笔记电视剧精美海报 盗墓笔记电视剧全集高清种子下载

出身“老九门”世家的吴邪,因身为考古学家的父母在某次保护国家文物行动时被国外盗墓团伙杀害,吴家为保护吴邪安全将他送去德国读书,因而吴邪对“考古”事业有着与生俱来的兴趣。在一次护宝过程中他偶然获得一张...

微软调整Win11 24H2装机策略:6月起36款预装应用改为完整版

IT之家7月16日消息,微软公司今天(7月16日)发布公告,表示自今年6月更新开始,已默认更新Windows1124H2和WindowsServer2025系统中预装...

谷歌手把手教你成为谣言终结者 | 域外

刺猬公社出品,必属原创,严禁转载。合作事宜,请联系微信号:yunlugongby贾宸琰编译、整理11月23日,由谷歌新闻实验室(GoogleNewsLab)联合Bellingcat、DigD...

NAS 部署网盘资源搜索神器:全网资源一键搜,免费看剧听歌超爽!

还在为找不到想看的电影、电视剧、音乐而烦恼?还在各个网盘之间来回切换,浪费大量时间?今天就教你如何在NAS上部署aipan-netdisk-search,一款强大的网盘资源搜索神器,让你全网资源...

使用 Docker Compose 简化 INFINI Console 与 Easysearch 环境搭建

前言回顾在上一篇文章《搭建持久化的INFINIConsole与Easysearch容器环境》中,我们详细介绍了如何使用基础的dockerrun命令,手动启动和配置INFINICon...

为庆祝杜特尔特到访,这个国家宣布全国放假?

(观察者网讯)近日,一篇流传甚广的脸书推文称,为庆祝杜特尔特去年访问印度,印度宣布全国放假,并举办了街头集会以示欢迎。菲媒对此做出澄清,这则消息其实是“假新闻”。据《菲律宾世界日报》2日报道,该贴子...

一课译词:毛骨悚然(毛骨悚然的意思是?)

PhotobyMoosePhotosfromPexels“毛骨悚然”,汉语成语,意思是毛发竖起,脊梁骨发冷;形容恐惧惊骇的样子(withone'shairstandingonend...

Bing Overtakes Google in China&#39;s PC Search Market, Fueled by AI and Microsoft Ecosystem

ScreenshotofBingChinahomepageTMTPOST--Inastunningturnintheglobalsearchenginerace,Mic...

找图不求人!6个以图搜图的识图网站推荐

【本文由小黑盒作者@crystalz于03月08日发布,转载请标明出处!】前言以图搜图,专业说法叫“反向图片搜索引擎”,是专门用来搜索相似图片、原始图片或图片来源的方法。常用来寻找现有图片的原始发布出...

浏览器功能和“油管”有什么关联?为什么要下载

现在有没有一款插件可以实现全部的功能,同时占用又小呢,主题主要是网站的一个外观,而且插件则主要是实现wordpress网站的一些功能,它不仅仅可以定制网站的外观,还可以实现很多插件的功能,搭载chro...