关于数据校验的那些事

关于数据校验的那些事

在编写代码的时候，不仅前端项目需要进行校验，后端项目更需要进行校验。

JSR303你值得拥有！

什么是JSR303？

JSR 是 Java Specification Requests 的缩写，即 Java 规范提案。简单的理解为 JSR 是一种 Java 标准。JSR 303 就是数据检验的一个标准
参考：https://www.jianshu.com/p/554533f88370

java提供的注解

java：提供了很多关于字段验证的注解，我们先来了解一下这些注解

注解	作用
@Null	验证对象是否为null
@NotNull	验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank	检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty	检查约束元素是否为NULL或者是EMPTY.
@AssertTrue	验证 Boolean 对象是否为 true
@AssertFalse	验证 Boolean 对象是否为 false
@Size(min=, max=)	验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=)	验证字符串长度是否在min 和 max之间
@Past	验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期
@Future	验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期
@Pattern	验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。
@Min	验证 Number 和 String 对象是否大等于指定的值
@Max	验证 Number 和 String 对象是否小等于指定的值
@DecimalMax	被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin	被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits	验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=)	验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=)	被指定的元素必须在合适的范围内
@Valid	递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber	信用卡验证
@Email	验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@URL(protocol=,host=, port=,regexp=, flags=)	是否是一个url，支持正则表达式

同样在org.hibernate.validator.constraints中还有很多实现了JSR303标准的注解

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.16.Final</version>
</dependency>

上个小案例

首先需要在实体类上标注，对应字段需要使用的注解，这里需要注意字段的类型

@Data
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	@Null(message = "id不能为空")
	@TableId
	private Long brandId;

	@NotBlank(message = "品牌名不能为空")
	private String name;

	@NotBlank
	@URL(message = "logo必须是一个合法的url地址")
	private String logo;

	private String descript;

	@NotEmpty
	@Pattern(regexp="^[a-zA-Z]$",message = "检索首字母必须是一个字母")
	private String keyWords;

	@NotNull
	@Min(value = 0,message = "排序必须大于等于0")
	private Integer sort;
}

同时，我们需要在接口上添加注解@Valid,不加上这个注解，我们在实体类上的判断也不会生效哟

@RequestMapping("/delete")
public R delete( @Valid @RequestBody Long[] ids){
    brandService.removeByIds(Arrays.asList(ids));
    return R.ok();
}

上个复杂的案例

如果我们在不同场景下，需要对不同的字段进行验证而且不想创建过多的类，这时候咋办？

来个分组解决问题：

场景1：我们在新增的时候，是不用传递brandId的，那么如果传递了brandId，我们需要验证，同时新增的时候，必填name、logo、descript、keyWords这些字段

场景2：在更新的时候，我们对于brandId是必要的，其余的可以不传递

针对场景1和2，我们需要创建如下两个接口，这两个接口并不需要实现，仅仅是用来分组

添加的分组接口：

public interface AddGroup {}

修改的分组接口：

public interface UpdateGroup {}

实体类的注解：

@Data
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	@NotNull(message = "id不能为空",groups = {UpdateGroup.class})
	@Null(message = "新增不能指定id",groups = {AddGroup.class})
	private Long brandId;

	@NotBlank(message = "品牌名不能为空",groups = {AddGroup.class,UpdateGroup.class})
	private String name;

	@NotBlank(groups = {AddGroup.class})
	@URL(message = "logo必须是一个合法的url地址",groups={AddGroup.class,UpdateGroup.class})
	private String logo;

	private String descript;

	@NotEmpty(groups={AddGroup.class})
	@Pattern(regexp="^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups={AddGroup.class,UpdateGroup.class})
	private String keyWords;

	@NotNull(groups={AddGroup.class})
	@Min(value = 0,message = "排序必须大于等于0",groups={AddGroup.class,UpdateGroup.class})
	private Integer sort;
}

此时我们怎么才能知道什么时候使用什么场景呢？

我们需要在controller中使用@Validated注解

@RequestMapping("/update/status")
public R updateStatus(@Validated(UpdateGroup.class) @RequestBody BrandEntity brand){
    brandService.updateById(brand);
    return R.ok();
}
@RequestMapping("/save")
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){
    brandService.save(brand);
    return R.ok();
}

接着我们要进行全局的异常提示，因为这些注解会产生异常，这时候我们要全局处理这些异常

@Slf4j
@RestControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
public class BrandExceptionControllerAdvice {
	// 指定异常
    @ExceptionHandler(value= MethodArgumentNotValidException.class)
    public R handleVaildException(MethodArgumentNotValidException e){
        BindingResult bindingResult = e.getBindingResult();
        Map<String,String> errorMap = new HashMap<>();
        bindingResult.getFieldErrors().forEach((fieldError)->{
            errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
        });
        return R.error(400,"错误信息").put("data",errorMap);
    }
	// 其他异常
    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable){
        return R.error(400,"错误信息");
    }
}

上个复杂又复杂的案例

当我们需要自定义校验规则，但正则表达式已经满足不了我们的时候，自定义校验器它来了！

首先创建自定义校验注解：

@Documented
//指定注解的处理器
@Constraint(validatedBy = { SpecifiedValueConstraintValidator.class })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface SpecifiedValue {
    String message() default "{com.springboot.common.valid.SpecifiedValue.message}";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };

    int[] vals() default { };
}

注解处理器代码：

注意几点：注解处理器需要实现ConstraintValidator传入的参数是注解，还有这个字段的类型

需要实现两个方法，初始化方法和判断是否校验成功方法

public class SpecifiedValueConstraintValidator implements ConstraintValidator<SpecifiedValue,Integer> {
    private Set<Integer> set = new HashSet<>();
    //初始化方法
    @Override
    public void initialize(ListValue constraintAnnotation) {
        // balabala
    }
    /**
    * 判断校验是否成功
    */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        // balabala
        return set.contains(value);
    }
}