优雅的在Controller层做参数校验：使用@Valid+BindingResult

使用@Valid+BindingResult在Controller做校验使用案例

1.引入pom依赖              

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

2.创建需要校验参数的bean类

   * 在bean类中每个字段上面都可以加注解校验，例：@NotBlank(message = "ID 不能为空")

   * 加注解时需要判断合适的注解，注解类型看文章末

   * 该bean需要交给Spring容器管理，bean加@Conmponent注解或者在serviceImpl层加@Service注解

   * 每个字段可以加多个注解

3.编写Controller层代码

   * 在入参的请求体前加@Validated注解，该注解为@Valid注解加强版，可支持同一请求体不同校验规则，可自行探索

   * 请求体后加 BindingResult bindingResult 此类为bean校验捕获到的异常储存

   * 在代码里判断有无异常后抛出即可

  Controller层代码示例：

@PostMapping("/db/login_info/sync")

    public CommonResponseBody syncRDS(@RequestBody @Validated DbLoginInfoSyncReqDto dbLoginInfoSyncReqDto, BindingResult bindingResult) {

        //在这里，我们判断参数是否通过校验

        if (bindingResult.hasErrors()) {

            String defaultMessage = bindingResult.getFieldErrors().get(0).getDefaultMessage();

            //将错误信息返回

            return new CommonResponseBody(400, defaultMessage, null);

        }

        return dbLoginInfoService.syncRDS(dbLoginInfoSyncReqDto);

    }

bean类中不同注解使用方式：

附件
限制注解	说明	限制类型	样例
@Null	限制只能为null	全部	@Null(message="")
@NotNull	限制必须不为null	全部	@NotNull(message="")
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future	限制必须是一个将来的日期
@Max(value)	限制必须为一个不大于指定值的数字	int	@Max(value=100,message="")
@Min(value)	限制必须为一个不小于指定值的数字	int	@Min(value=100,message="")
@Past	限制必须是一个过去的日期
@Pattern(value)	限制必须符合指定的正则表达式	String	@Pattern(regexp="",message="")
@Size(max,min)	限制字符长度必须在min到max之间
@NotEmpty	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）	String	@NotEmpty(message = "")
@NotBlank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格	String	@NotBlank(message = "")
@Email	验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式	String

 

注意：
前4步缺一不可，之前我是缺少了第三步，没有自己配置自己的validator。搞了半天没成功。
另外网上都是配置一个validator类，然后主动在controller去validator，这点肯定不如使用spring提供给我们的aop来的好。

示例:
1.验证用户名的格式

@NotBlank(message = "用户名不能为空")  
@Length(min=5, max=20, message="用户名长度必须在5-20之间")  
@Pattern(regexp = "^[a-zA-Z_]\\w{4,19}$", message = "用户名必须以字母下划线开头，可由字母数字下划线组成")  
private String username;  
2.验证必须为int且范围在 A-B之间

@Range(min=0, max=4)
private int scale;//基础规格
3.验证List不为空

@NotEmpty
private List<UserInfo> userList; 
4.对象内包含List<对象>的校验

@Valid
@NotEmpty
private List<UserInfo> userList; 
这样即可以实现对list里面的对象的校验了

规则：
@AssertFalse    Boolean,boolean    验证注解的元素值是false
@AssertTrue    Boolean,boolean    验证注解的元素值是true
@NotNull    任意类型    验证注解的元素值不是null
@Null    任意类型    验证注解的元素值是null
@Min(value=值)    BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型    验证注解的元素值大于等于@Min指定的value值
@Max（value=值）    和@Min要求一样    验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值)    和@Min要求一样    验证注解的元素值大于等于@ DecimalMin指定的value值
@DecimalMax(value=值)    和@Min要求一样    验证注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整数位数, fraction=小数位数)    和@Min要求一样    验证注解的元素值的整数位数和小数位数上限
@Size(min=下限, max=上限)    字符串、Collection、Map、数组等    验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past    java.util.Date,java.util.Calendar;Joda Time类库的日期类型    验证注解的元素值（日期类型）比当前时间早
@Future    与@Past要求一样    验证注解的元素值（日期类型）比当前时间晚
@NotBlank    CharSequence子类型    验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@Length(min=下限, max=上限)    CharSequence子类型    验证注解的元素值长度在min和max区间内
@NotEmpty    CharSequence子类型、Collection、Map、数组    验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@Range(min=最小值, max=最大值)    BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型    验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)    CharSequence子类型（如String）    验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)    String，任何CharSequence的子类型    验证注解的元素值与指定的正则表达式匹配
@Valid    任何非原子类型    指定递归验证关联的对象；如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证