Springboot-- 注解字段校验，并统一设置返回值

傷城~ 2023-10-12 20:51 67阅读 0赞

## Springboot-- 注解字段校验，并统一设置返回值 ##

引包：`import org.springframework.validation.annotation.Validated;`

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

*  **规则**

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

*  **在需要校验的bean对象属性上加上需要对应使用校验的注解**

@Data
    public class BirdsInfoReq {
        
     
        @NotBlank(message = "名称不能为空")
        private String birdName;
     
        @NotBlank(message = "分类不能为空")
        private String birdClassifyKey;
     
        @NotBlank(message = "保护等级不能为空")
        private String protectKey;
     
        @NotBlank(message = "IUCN等级不能为空")
        private String iucnKey;
        
        @Null(message = "街道必须为null")
        private String street;
     
        /**
         * 请求对象中包含有对象，需要再该对象上也加入@Valid 注解
         */
        @Valid
        private Test test;
    }

*  **在定义自定义处理器，来处理报错返回**

@ControllerAdvice
    public class ValidationExceptionHandler extends ResponseEntityExceptionHandler {
        
        @Override
        protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        
            return new ResponseEntity<>(R.error().message(ex.getBindingResult().getAllErrors().get(0).getDefaultMessage()),status);
        }
    }

*  **在需要使用的controller上加`@Validated`，来启动注解校验**

@RestController
    @RequestMapping("keeping")
    public class BookKeepingController  {
        
        @PostMapping("save")
        public R addSave(@RequestBody @Validated BookKeeping bookKeeping) {
        
          //  这样就可以快乐的玩耍了   
        }
    }

*  **效果**  
    ![在这里插入图片描述][60239394b2ee4da2b629c9b0352c9775.png]

[60239394b2ee4da2b629c9b0352c9775.png]: https://img-blog.csdnimg.cn/60239394b2ee4da2b629c9b0352c9775.png