分组校验 - 爱码网

JSR303校验

一、环境准备

这个pom坐标在自定义注解的时候有用

 <dependency>
      <groupId>javax.validation</groupId>
      <artifactId>validation-api</artifactId>
      <version>2.0.1.Final</version>
  </dependency>

二、JSR 303 基本的校验规则

1、空检查

 @Null 验证对象是否为null 
 @NotNull 验证对象是否不为null, 无法查检长度为0的字符串 
 @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格. 
 @NotEmpty 检查约束元素是否为NULL或者是EMPTY.

2、Booelan检查

 @AssertTrue 验证 Boolean 对象是否为 true 
 @AssertFalse 验证 Boolean 对象是否为 false

3、长度检查

 @Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内 
 @Length(min=, max=) Validates that the annotated string is between min and max included.

4、日期检查

 @Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期 
 @Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期 
 @Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。

5、数值检查

建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null

 @Min 验证 Number 和 String 对象是否大等于指定的值 
 @Max 验证 Number 和 String 对象是否小等于指定的值 
 @DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度 
 @DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度 
 @Digits 验证 Number 和 String 的构成是否合法 
 @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。 
 @Range(min=, max=) 被指定的元素必须在合适的范围内 
 @Range(min=10000,max=50000,message=”range.bean.wage”) 
 @Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证) 
 @CreditCardNumber信用卡验证 
 @Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。 
 @ScriptAssert(lang= ,script=, alias=) 
 @URL(protocol=,host=, port=,regexp=, flags=)

三、案例

1、写一个java bean

 @Data
 public class User {
 
     @NotNull(message = "更新时必须携带ID",groups = {UpdateGroup.class})
     @Null(message = "插入时不能携带id",groups = {InsertGroup.class})
     private Integer id;
 
     @NotEmpty(message = "名字不能为空")
     private String name;
 
     @Email(message = "邮箱不能为空")
     private String email;
 
 
     private String phone;
 }

2、在controller的参数上加上注解@Valid

controller

 @RestController
 @Slf4j
 public class UserController {
 
     @PostMapping("/jsr303")
     public R jsr303Test(@Valid @RequestBody User user){
         log.info("参数user:{}",user);
         return R.ok() ;
     }
 
 }

3、异常处理类

@Slf4j
 @RestControllerAdvice(basePackages = "com.ybl.test.controller")
 public class MyExceptionControllerAdvice {
 
 
     /**
      * @ExceptionHandler 是为了告诉RestControllerAdvice能处理哪些异常
      * @param e
      * @return
      */
     @ExceptionHandler(value= MethodArgumentNotValidException.class)
     public R handleVaildException(MethodArgumentNotValidException e){
         log.error("数据校验出现问题{}，异常类型：{}",e.getMessage(),e.getClass());
         //获取数据校验的结果
         BindingResult bindingResult = e.getBindingResult();
 
         Map<String,String> errorMap = new HashMap<>();
         /**
          * 获取所有的错误消息
          * key 存错误字段
          * value 存message
          */
         bindingResult.getFieldErrors().forEach((fieldError)->{
             errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
         });
         return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errorMap);
     }
 
     @ExceptionHandler(value = Throwable.class)
     public R handleException(Throwable throwable){
 
         log.error("错误：",throwable);
         return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
     }
 }

View Code