这么写参数校验(validator)就不会被劝退了~
来源:http://uee.me/bvwtp
很痛苦遇到大量的参数进行校验,在业务中还要抛出异常或者不断的返回异常时的校验信息,在代码中相当冗长, 充满了if-else这种校验代码,今天我们就来学习spring的javax.validation 注解式参数校验.
为什么要用validator
1.javax.validation的一系列注解可以帮我们完成参数校验,免去繁琐的串行校验
不然我们的代码就像下面这样:
这被大佬看见,一定说,都9102了还这么写,然后被劝退了…..
2.什么是javax.validation
JSR303 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代),就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本:
3.注解说明
@NotNull:不能为null,但可以为empty(""," "," ")
@NotEmpty:不能为null,而且长度必须大于0 (" "," ")
@NotBlank:只能作用在String上,不能为null,而且调用trim()后,长度必须大于0("test") 即:必须有实际字符
此处只列出Hibernate Validator提供的大部分验证约束注解,请参考hibernate validator官方文档了解其他验证约束注解和进行自定义的验证约束注解定义。
实战演练
话不多说,直接走实践路线,同样使用的是SpringBoot的快速框架
详细代码见:
https://github.com/leaJone/mybot
1. @Validated 声明要检查的参数
这里我们在控制器层进行注解声明
2. 对参数的字段进行注解标注
3. 在全局校验中增加校验异常
MethodArgumentNotValidException是springBoot中进行绑定参数校验时的异常,需要在springBoot中处理,其他需要处理ConstraintViolationException异常进行处理.
为了优雅一点,我们将参数异常,业务异常,统一做了一个全局异常,将控制层的异常包装到我们自定义的异常中.
为了优雅一点,我们还做了一个统一的结构体,将请求的code,和msg,data一起统一封装到结构体中,增加了代码的复用性.
4. 测试
如下文:确实做到了参数校验时返回异常信息和对应的code,方便了我们不再繁琐的处理参数校验
在ValidationMessages.properties 就是校验的message,有着已经写好的默认的message,且是支持i18n的,大家可以阅读源码赏析
自定义参数注解
1. 比如我们来个 自定义身份证校验 注解
这个注解是作用在Field字段上,运行时生效,触发的是IdentityCardNumber这个验证类。
message 定制化的提示信息,主要是从ValidationMessages.properties里提取,也可以依据实际情况进行定制
groups 这里主要进行将validator进行分类,不同的类group中会执行不同的validator操作
payload 主要是针对bean的,使用不多。
2. 然后自定义Validator
这个是真正进行验证的逻辑代码:
IdCardValidatorUtils在项目源码中,可自行查看
3. 使用自定义的注解
4.使用groups的校验
有的宝宝说同一个对象要复用,比如UserDTO在更新时候要校验userId,在保存的时候不需要校验userId,在两种情况下都要校验username,那就用上groups了:
先定义groups的分组接口Create和Update
再在需要校验的地方@Validated声明校验组
在DTO中的字段上定义好groups = {}的分组类型
注意:在声明分组的时候尽量加上 extend javax.validation.groups.Default 否则,在你声明@Validated(Update.class)的时候,就会出现你在默认没添加groups = {}的时候的校验组@Email(message = "邮箱格式不对"),会不去校验,因为默认的校验组是groups = {Default.class}.
5.restful风格用法
在多个参数校验,或者@RequestParam 形式时候,需要在controller上加注@Validated
总结
用起来很简单,soEasy,重点参与的统一结构体返回,统一参数校验,是减少我们代码大量的try catch 的法宝,我觉得在项目中,将异常处理好,并将异常做好日志管理,才是很好的升华,文章浅显,只是一个菜鸟的进阶笔记….
本文转载自微信公众号【朱小厮的博客】
- 点赞
- 收藏
- 关注作者
评论(0)