Spring Bean参数校验Validator

Spring Bean参数校验Validator

以下2种方式可以用于所有的 Spring bean 不仅仅是 Controller 控制器。

一、原始类型参数

在控制器（或者其他Bean）上使用@Validated注解。

控制器类
@RestController
@RequestMapping("account")
@Validated
public class AccountController {
    // ......
}

在参数前添加校验注解

参数校验
@GetMapping("account")
public Result<AccountVO> getAccount(@NotNull Long accountId) {
    // ......
}

二、表单对象参数

参数 AddressForm，添加 @Valid 注解。

表单校验
@PostMapping("/address/save")
public Object saveAddress(@Valid AddressForm addressForm) {
   // ......
}

AddressForm 中添加注解：

表单校验
@Data
public class AddressForm {
   private Integer id;
   @NotBlank
   private String name;
   @NotBlank(message = "{mobile.not.blank}")
   @Pattern(regexp = "^1[34578]\\d{9}$")
   private String mobile;
   /**
    * list 集合需要添加 @Valid 注解
    */
   @Valid
   private List<Xxx> list;
    
   // ......
 
}

注意： 示例中 {name.not.blank} 为国际化配置。国际化需要在配置文件下自定义 org/hibernate/validator/ValidationMessages.properties 配置文件。

三、Bean Validation 中常用注解

@Null       被注释的元素必须为 null
@NotNull    被注释的元素必须不为 null
@NotBlank   
@NotBlank(message =)   验证字符串非null，且长度必须大于0
@NotEmpty   被注释的字符串、集合的必须非空
@AssertTrue     被注释的元素必须为 true
@AssertFalse    被注释的元素必须为 false
@Min(value)     被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)     被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value)  被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value)  被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=)   被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction)     被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past   被注释的元素必须是一个过去的日期
@Future     被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=)  被注释的元素必须符合指定的正则表达式
四、Hibernate Validator 常用注解
@Email  被注释的元素必须是电子邮箱地址
@Length(min=,max=)  被注释的字符串的大小必须在指定的范围内
@Range(min=,max=,message=)  被注释的元素必须在合适的范围内

五、Validator 分组

分组名          描述
QueryGroup  查询使用的分组
CreateGroup 创建使用的分组
UpdateGroup 更新使用的分组
DeleteGroup 删除使用的分组

5.1 模型中添加 Validator 分组

模型示例
public class SysConfig implements Serializable {
 
    /**
     * 主键ID
     */
    @TableId(value = "id", type = IdType.AUTO)
    @Null(groups = CreateGroup.class)
    @NotNull(groups = UpdateGroup.class)
    private Long id;
 
    // 省略
 
}

5.2 控制器方法中指定使用的校验分组

控制器示例
@ApiOperation("修改参数配置")
@PostMapping
public void edit(@Validated(UpdateGroup.class) @RequestBody SysConfig entity) {
    // 省略
}

参考链接:
https://blog.csdn.net/qq_31001665/article/details/71075743
https://www.cnblogs.com/NeverCtrl-C/p/8185576.html
https://segmentfault.com/q/1010000008384686