这么写参数校验(validator)就不会被劝退了~
原文链接：https://mp.weixin.qq.com/s/KphcNU4W54L20uluPLEgQA
很痛苦遇到大量的参数进行校验, 在业务中还要抛出异常或者不断的返回异常时的校验信息, 在代码中相当冗长, 充满了 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