spring注解方式完成参数校验

悠悠 2022-10-13 05:20 185阅读 0赞

spring中给我们提供了一系列参数校验的注解，让我们告别繁琐的代码逻辑校验。

@Valid

@Validated

开启校验的第一道大门，只有加上此属性，spring才会开始进行校验

区别：

1.  @Valid 不支持 group属性，@Validated支持，group属性可以对同一个对象的属性，在不同的情况下决定是否进行校验，比如我们要操作一个Po类，在新增时，要求所有属性都不为空，但是在修改时，可以要求部分属性为空，这样@Validated可以支持这种需求，@Valid则不支持
2.  @Validated不能用在成员属性上，@Valid可以用在成员属性上

校验注解：

//必须为null
    @Null
    //不能为null
    @NotNull
    
    //必须为true
    @AssertTrue
    //必须为false
    @AssertFalse
    
    // 必须为数字,其最小值必须大于等于指定的值
    @Min(value)  eg: @Min(100) or @Min(value = 100, message = "最小值为100")
    // 必须为数字，其最大值必须小于等于指定的值
    @Max(value)
    // 支持Decimal， 其最小值必须大于等于指定的值
    @DecimalMin(value)
    // 支持Decimal， 其最大值必须小于等于指定的值
    @DecimalMax(value)
    // 数字必须在范围内
    @Range  eg:@Range(min =1 ,max = 100, message = "范围为1-100")
    
    // 大小必须在范围内
    @Size eg ： @Size(min=5, max=10, message="字符串或数组的长度必须在5-10之间")
       
    // 校验小数，小数点前支持多少位，小数点后支持多少位
    @Digits(integer=6,fraction=2, message="小数点前支持6位，小数点后支持2位")
        
    // 必须是一个过去的日期
    @Past
    // 必须是一个将来的日期
    @Future
    
    // 必须符合指定的政策表达式
    @Pattern(value)
    // 必须是电子邮件地址
    @Email
    // 字符创长度必须在规定范围内
    @Length
    // 字符串非空
    @NotEmpty

代码实战

### 案例一：校验name在任何时候都不能为null ###

实体类Po

@Data
    public class People { 
    
        private Long id;
    
        @NotNull(message = "name不能为空")
        private String name;
    
        private Integer age;
    }

Controller

@RestController
    @RequestMapping()
    public class TestController { 
    
        @PostMapping(value = "/insert")
        public void insert(@RequestBody @Valid People people) { 
            // dosomething
        }
    
        @PostMapping(value = "/update")
        public void update(@RequestBody @Valid People people) { 
            // dosomething
        }
    }

### 案例二： 校验id在插入时可以为Null，在修改时不能为null ###

这个时候不能用@Valid,得用@Validated

定义两个接口分类

public interface Insert { }

public interface update { }

实体类

@Data
    public class People { 
    
        @NotNull(message = "更新时不能为空", groups = { Update.class})
        private Long id;
    
        @NotNull(message = "name不能为空")
        private String name;
    
        private Integer age;
    }

Controller

@RestController
    @RequestMapping()
    public class TestController { 
    
        @PostMapping(value = "/insert")
        public void insert(@RequestBody @Validated(value = { Insert.class}) People people) { 
            // dosomething
        }
    
        @PostMapping(value = "/update")
        public void update(@RequestBody @Validated(value = { Update.class}) People people) { 
            // dosomething
        }
    }

### 进阶版 ###

当我们定义message后，如果校验不通过，则会抛出org.springframework.web.bind.MethodArgumentNotValidException异常，所以我们可以做一个统一处理，将异常包装，然后取到我们定义的自定义message做返回

@ControllerAdvice
    public class CustomExceptionHandler { 
    
        @ResponseBody
        @ExceptionHandler(value = MethodArgumentNotValidException.class)
        public String errorHandler(MethodArgumentNotValidException exception) { 
            return exception.getBindingResult().getFieldError().getDefaultMessage();
        }
    }