springboot参数校验常用注解及分组校验

一、使用方式添加@Validated

二、常见注解

@Null

• 被注解的元素必须为null

@NotNull

• 被注解的元素必须不为null

@NotBlank

• 只能作用在接收的 String 类型上，注意是只能，不能为 null，而且调用 trim() 后，长度必须大于 0即：必须有实际字符

@NotEmpty

• 不能为 null，且长度必须大于 0，一般用在集合类上或者数组上

@Min

• 被注解的元素其值必须大于等于最小值，并且类型为int，long，float，double,BigDecimal等

@Max

• 被注解的元素其值必须小于等于最大值，并且类型为int，long，float，double,BigDecimal等

@DecimalMin

• 验证注解的元素值大于等于@DecimalMin指定的value值，并且类型为BigDecimal。

@DecimalMax

• 验证注解的元素值小于等于@DecimalMax指定的value值 ，并且类型为BigDecimal

@NotNull(message = "请输入分数") 
@DecimalMin(value = 0, message = "分数不能小于0") 
@DecimalMax(value = 5, message = "分数不能大于5") 
private BigDecimal score;

@Size

• 被注解的元素的长度必须在指定范围内，并且类型为String，Array，List，Map。

@Pattern

• 被注解的元素必须符合指定的正则表达式，并且类型为String。

@NotBlank(message = "手机号码不能为空") 
@Size(min = 11, max = 11, message = "手机号码不正确") 
@Pattern(regexp = "^(((13[0-9])|(14[579])|(15([0-3]|[5-9]))|(16[6])|(17[0135678])|(18[0-9])|(19[89]))\\d{8})$", message = "账号格式错误") 
private String phone;

@Length

• 验证注解的元素值长度在min和max区间内 ，并且类型为String。

@Length(max = 11, min = 7, message = "长度必须大于等于7或小于等于11")
private String mobile;

@Past

• 限制必须是一个过去的日期,并且类型为java.util.Date

@Future

• 限制必须是一个将来的日期,并且类型为java.util.Date

@Digits

• 验证格式，限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction

@NotNull(groups = {Insert.class,Update.class}, message = "总投资不能为空")
@DecimalMin(value = "0", message = "总投资不能小于0")
@Digits(integer = 14, fraction = 6, message = "资金格式错误")
private BigDecimal planTotalInvestment;

三、对校验注解进行分组如：

//使用
@ApiOperation(value = "新增", notes = "新增")
@PostMapping("save")
public R save(@RequestBody @Validated({Insert.class}) Dto dto) {
    return R.ok();
}


//dto内定义
@NotNull(groups = {Update.class}, message = "修改时id不能为空")
@Null(groups = {Insert.class}, message = "新增时id必须为空")
private Integer id;

四、全局的异常处理

    /**
     * 自定义验证异常
     */
    @ExceptionHandler(BindException.class)
    public AjaxResult handleBindException(BindException e)
    {
        log.error(e.getMessage(), e);
        String message = e.getAllErrors().get(0).getDefaultMessage();
        return AjaxResult.error(message);
    }

    /**
     * 自定义验证异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e)
    {
        log.error(e.getMessage(), e);
        String message = e.getBindingResult().getFieldError().getDefaultMessage();
        return AjaxResult.error(message);
    }