[玩软件] Spring Boot 如何优雅的校验参数
作者:CC下载站 日期:2019-12-12 00:00:00 浏览:51 分类:玩软件
前言
做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 [软件应用] 谷歌商店,可以访问了
取消回复欢迎 你 发表评论:
- 精品推荐!
-
- 最新文章
- 热门文章
- 热评文章
[文件传输] 【Android/IOS/Win】互传 EasyShare 3.6.5 零流量、极速、多平台快捷传输工具
[辅助下载] 4K高清壁纸图片批量下载工具2.0版本
[资料教程] 事业单位必刷题库
[技术课程] 【易锦】WEB渗透Hacker技术特训营(直播课第14期)
[课程] 轻松汽车摄影-全能课,最全汽车视频拍摄技巧(32节课)
[资料教程] 辣条制作配方及教程
[音乐] 低音炮车载340首
[课程] 夜鹰10分钟救命课(完结)
[资料] 寻道网道医精品视频课程集合15部
[资料课程] 适合3-7岁学前幼小衔接 《22天搞定拼音》,认、读、拼、写
[资料] [大学期末救急课] 猴博士+高斯课堂+斐多课堂,全集视频合集
[云资源] 价值2万元的老男孩Python教程
[书库] 史上最全摄影书推荐(附700本PDF版打包下载)
[云资源] 花了一千多元买的私人健身教程
[下载工具] Internet Download Manager 6.42.7 (IDM)
[影视] 灌篮高手 WEB-DL版下载/Slam Dunk/スラムダンク/灌篮高手:THE FIRST/灌篮高手电影版 2022 The First Slam Dunk 61.35G
[安卓软件] 酷我音乐APP_v10.7.6.4 去广告破解豪华VIP版
[即时通讯] 微信PC版WeChat 3.9.9.43 多开防撤回绿色版
[安卓软件] Solid Explorer文件管理器APP 2.8.38 破解版
[浏览器] Google Chrome v123.0.6312.59便携增强版
[云资源] 价值2万元的老男孩Python教程
[影视] 灌篮高手 WEB-DL版下载/Slam Dunk/スラムダンク/灌篮高手:THE FIRST/灌篮高手电影版 2022 The First Slam Dunk 61.35G
[云资源] 花了一千多元买的私人健身教程
[书库] 史上最全摄影书推荐(附700本PDF版打包下载)
[动画] 北斗神拳(1984) [两季合集] [MKV]
[资料] 抗战阵亡将士资料+续编
[电视剧] 三体 (2024) 全8集 网飞版本 中文字幕 合集
[纪录片] 河西走廊【10集 国语 中文字幕 1080P 10.8G MP4】
[电影] 2024年喜剧片·热辣滚烫 [mp4]
[影视] 铁爪 WEB-DL版下载 2023 The Iron Claw 23.48G
- 最新评论
-
杂物房内的旧档资源不保证有效CC下载站 评论于:05-14 不能**123 评论于:05-14 我想看看mw2ddyy 评论于:04-26 好东西阿zfy123123 评论于:04-18 谢谢楼主xiaoqi 评论于:04-12 勿在线解压,勿手机解压,请在电脑上用最新款压缩软件解压!推荐360压缩或者好压CC下载站 评论于:04-10 无法解压啊,客服能不能给个解压教程ravengrey 评论于:04-10 谢谢支持!!CC下载站 评论于:03-26 很棒的资源,感谢分享云体风身 评论于:03-26 感谢分享,好东西云体风身 评论于:03-26
- 热门tag