[玩软件] Spring Boot 如何优雅的校验参数
作者:CC下载站 日期:2019-12-12 00:00:00 浏览:70 分类:玩软件
前言
做web开发有一点很烦人就是要校验参数,基本上每个接口都要对参数进行校验,比如一些格式校验 非空校验都是必不可少的。如果参数比较少的话还是容易 处理的一但参数比较多了的话代码中就会出现大量的 IF ELSE
就比如下面这样:
这个例子只是校验了一下空参数。如果需要验证邮箱格式和手机号格式校验的话代码会更多,所以介绍一下 validator
通过注解的方式进行校验参数。
<!--版本自行控制,这里只是简单举例-->
<dependency>
<groupId>javax. validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.0. Final</version>
</ dependency>
<dependency>
<groupId>org. hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.1. Final</vers ion>
</dependency>
注解介绍
validator
内置注解
@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(value)
被注释的元素必须符合指定的正则表达式Hibernate Validator
附加的 constraint
@Email
被注释的元素必须是电子邮箱地址@Length
被注释的字符串的大小必须在指定的范围内@NotEmpty
被注释的字符串的必须非空 @Range
被注释的元素必须在合适的范围内@NotBlank
验证字符串非null,且长度必须大于0注意:
@NotNull
适用于任何类型被注解的元素必须不能与NULL@NotEmpty
适用于String Map或者数组不能为Null且长度必须大于0@NotBlank
只能用于String上面 不能为null,调用trim()后,长度必须大于0
使用
模拟用户注册封装了一个 UserDTO
当提交数据的时候如果使用以前的做法就是 IF ELSE
判断参数使用 validator
则是需要增加注解即可。
例如非空校验:
然后需要在 controller
方法体添加 @Validated
不加 @Validated
校验会不起作用
然后请求一下请求接口,把 Email
参数设置为空
参数:
{
"userName":"luomengsun",
"mobileNo":"11111111111",
"sex":1,
"age":21,
"email":""
}
返回结果:
后台抛出异常
这样是能校验成功,但是有个问题就是返回参数并不理想,前端也并不容易处理返回参数,所以我们添加一下全局异常处理,然后添加一下全局统一返回参数这样比较规范。
添加全局异常
创建一个 GlobalExceptionHandler
类,在类上方添加 @RestControllerAdvice
注解然后添加以下代码:
/**
* 方法参数校验
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public ReturnVO handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
log.error(e.getMessage(), e);
return new ReturnVO().error(e.getBindingResult().getFieldError().getDefaultMessage());
}
此方法主要捕捉 MethodArgumentNotValidException
异常然后对异常结果进行封装,如果需要在自行添加其他异常处理。
添加完之后我们在看一下运行结果,调用接口返回:
{
"code": "9999",
"desc": "邮箱不能为空",
"data": null
}
OK 已经对异常进行处理。
校验格式
如果想要校验邮箱格式或者手机号的话也非常简单。
校验邮箱
/**
* 邮箱
*/
@NotBlank(message = "邮箱不能为空")
@NotNull(message = "邮箱不能为空")
@Email(message = "邮箱格式错误")
private String email;
使用正则校验手机号
校验手机号使用正则进行校验,然后限制了一下位数
/**
* 手机号
*/
@NotNull(message = "手机号不能为空")
@NotBlank(message = "手机号不能为空")
@Pattern(regexp ="^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")
@Max(value = 11,message = "手机号只能为{max}位")
@Min(value = 11,message = "手机号只能为{min}位")
private String mobileNo;
查看一下运行结果
传入参数:
{
"userName":"luomengsun",
"mobileNo":"111111a",
"sex":1,
"age":21,
"email":"1212121"
}
返回结果:
{
"code": "9999",
"desc": "邮箱格式错误",
"data": null
}
自定义注解
上面的注解只有这么多,如果有特殊校验的参数我们可以使用 Validator
自定义注解进行校验
首先创建一个 IdCard
注解类
@Documented
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = IdCardValidator.class)
public @interface IdCard {
String message() default "身份证号码不合法";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
在 UserDTO
中添加 @IdCard
注解即可验证,在运行时触发,本文不对自定义注解做过多的解释,下篇文章介绍自定义注解
- message 提示信息
- groups 分组
- payload 针对于Bean
然后添加 IdCardValidator
主要进行验证逻辑
上面调用了 is18ByteIdCardComplex
方法,传入参数就是手机号,验证身份证规则自行百度
然后使用
@NotNull(message = "身份证号不能为空")
@IdCard(message = "身份证不合法")
private String IdCardNumber;
分组
就比如上面我们定义的 UserDTO
中的参数如果要服用的话怎么办?
在重新定义一个类然后里面的参数要重新添加注解?
Validator
提供了分组方法完美了解决 DTO
服用问题
现在我们注册的接口修改一下规则,只有用户名不能为空其他参数都不进行校验
先创建分组的接口
public interface Create extends Default {
}
我们只需要在注解加入分组参数即可例如:
/**
* 用户名
*/
@NotBlank(message = "用户姓名不能为空",groups = Create.class)
@NotNull(message = "用户姓名不能为空",groups = Create.class)
private String userName;
@NotBlank(message = "邮箱不能为空",groups = Update.class)
@NotNull(message = "邮箱不能为空",groups = Update.class)
@Email(message = "邮箱格式错误",groups = Update.class)
private String email;
然后在修改Controller在@Validated中传入Create.class
@PostMapping("/user")
public ReturnVO userRegistra(@RequestBody @Validated(Create.class) UserDTO userDTO){
ReturnVO returnVO = userService.userRegistra(userDTO);
return returnVO ;
}
然后调用传入参数:
{
"userName":"",
}
返回参数:
{
"code": "9999",
"desc": "用户姓名不能为空",
"data": null
}
OK 现在只对Create的进行校验,而 Updata
组的不校验,如果需要复用 DTO
的话可以使用分组校验
校验单个参数
在开发的时候一定遇到过单个参数的情况,在参数前面加上注解即可
@PostMapping("/get")
public ReturnVO getUserInfo(@RequestParam("userId") @NotNull(message = "用户ID不能为空") String userId){
return new ReturnVO().success();
}
然后在 Controller
类上面增加 @Validated
注解,注意不是增加在参数前面。
作者:孙罗蒙
猜你还喜欢
- 04-19 [软件技巧] 5个在Chrome浏览器上恢复已删除的历史记录的顶级方法
- 03-29 [软件技巧] 剪映专业版怎么把两个草稿合在一起
- 03-29 [玩软件] Linux 虚拟机使用 xshell 连接 (debian、kali、CentOS)
- 03-29 [软件问题] 解决 win10 命令行下运行 python 弹出 Windows 应用商店
- 03-29 [软件技巧] Anaconda安装教程以及Anaconda和pip配置国内镜像
- 03-29 [玩软件] LatticePHP-使用PHP生成点阵图
- 03-29 [软件问题] chrome、Edge浏览器显示“您的浏览器受管理”是被植入病毒或其它程序了吗?
- 03-29 [环境问题] 为Nginx和Apache配置多版本PHP、切割多个conf文件
- 03-29 [软件玩法] 配置frp实现内网穿透
- 03-29 [软件玩法] VMware虚拟机安装MacOS系统教程
- 03-29 [软件技巧] frp 实现内网穿透(Windows 版)
- 03-27 [软件应用] 谷歌商店,可以访问了
取消回复欢迎 你 发表评论:
- 精品推荐!
-
- 最新文章
- 热门文章
- 热评文章
[电影] 《环太平洋两部合集》 4K REMUX原盘 [杜比视界] 国英双语音轨 [内封特效字幕] [133.8G]
[电影] 异人之下 The Traveller 2024✨【影版】【4K正式版/HQ超高码/DDP5.1】✚【1080高码】无水印/无压缩
[动漫] 头文字D 动漫 (1998) S01-S06季 1080P 国粤日音轨 续作 剧场版 电影
[小说] 知轩藏书全站7667册txt小说合集精心校对版
[杂志] 电脑爱好者杂志14年 超全 [PDF]
[电影] 西游记全部版本-4K高清修复-总计384G-1986+1996+1998+2002+2010浙版+西游记后传
[纪录片] 【国家地理百年纪念典藏】超经典100集全 MP4格式 (绝佳学习资料)27GB
[纪录片] B站食贫道收费纪录片 *迷失东京* [1080P] 揭露日本大家感兴趣却不为人知的秘密
[网络线报] 城通网盘福利线报解析器 - 获取直连下载地址
[福利线报] 一个「脚本」搞定六大网盘(百度/阿里/天翼/迅雷/夸克/移动)
[游戏] 《黑神话悟空》免安装学习版【全dlc整合完整版】+Steam游戏解锁+游戏修改工具!
[动画] 《名侦探柯南》名侦探柯南百万美元的五菱星 [TC] [MP4]
[电视剧集] [BT下载][黑暗城市- 清扫魔 Dark City: The Cleaner 第一季][全06集][英语无字][MKV][720P/1080P][WEB-RAW]
[涨点姿势] 男性性技宝典:14招实战驭女术——爱抚、按摩、催情、姿势、高潮全攻略
[动画] 2002《火影忍者》720集全【4K典藏版】+11部剧场版+OVA+漫画 内嵌简日字幕
[剧集] 《斯巴达克斯》1-4季合集 无删减版 1080P 内嵌简英特效字幕
[CG剧情] 《黑神话:悟空》158分钟CG完整剧情合集 4K120帧最高画质
[短剧] 被下架·禁播的羞羞短剧·午夜短剧合集
[游戏] 黑神话悟空离线完整版+修改器
[图像处理] 光影魔术手v4.6.0.578绿色版
[影视] 美国内战 4K蓝光原盘下载+高清MKV版/内战/帝国浩劫:美国内战(台)/美帝崩裂(港) 2024 Civil War 63.86G
[影视] 一命 3D 蓝光高清MKV版/切腹 / 切腹:武士之死 / Hara-Kiri: Death of a Samurai / Ichimei 2011 一命 13.6G
[影视] 爱情我你他 蓝光原盘下载+高清MKV版/你、我、他她他 2005 Me and You and Everyone We Know 23.2G
[影视] 穿越美国 蓝光原盘下载+高清MKV版/窈窕老爸 / 寻找他妈…的故事 2005 Transamerica 20.8G
[电影] 《黄飞鸿》全系列合集
[Android] 开罗游戏 ▎像素风格的模拟经营的游戏厂商安卓游戏大合集
[游戏合集] 要战便战 v0.9.107 免安装绿色中文版
[资源] 精整2023年知识星球付费文合集136篇【PDF格式】
[系统]【黑果小兵】macOS Big Sur 11.0.1 20B50 正式版 with Clover 5126 黑苹果系统镜像下载
[美图] 【经典收藏美图集合】1500多张韩国美女高清图片让你的收藏夹更加丰富多彩
- 最新评论
-
有靳东!嘻嘻奥古斯都.凯撒 评论于:10-28 流星花园是F4处女作也是4人集体搭配的唯一一部!奥古斯都.凯撒 评论于:10-28 找了好久的资源,终于在这里找到了。感谢本站的资源和分享。谢谢AAAAA 评论于:10-26 找了好久的资源,终于在这里找到了。感谢本站的资源和分享。谢谢password63 评论于:10-26 找了好久的资源,终于在这里找齐了!!!!blog001 评论于:10-21 找了好久的资源,终于在这里找齐了!!!!blog001 评论于:10-21 找了好久的资源,终于在这里找到了。感谢本站的资源和分享。谢谢WillKwok 评论于:10-09 感谢分享1234123 评论于:10-07 太好了终于找到了谢谢Tom 评论于:10-07 谢谢分享loonghd 评论于:09-30
- 热门tag