校验_JSR303

JSR303基本使用

1. 引入依赖

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

hibernate-validator常用注解

hibernate-validator提供的校验方式为在类的属性上加入相应的注解来达到校验的目的。hibernate-validator提供的用于校验的注解如下：

注解	说明
@AssertTrue	用于boolean字段，该字段只能为true
@AssertFalse	用于boolean字段，该字段只能为false
@CreditCardNumber	对信用卡号进行一个大致的验证
@DecimalMax	只能小于或等于该值
@DecimalMin	只能大于或等于该值
@Email	检查是否是一个有效的email地址
@Future	检查该字段的日期是否是属于将来的日期
@Length(min=,max=)	检查所属的字段的长度是否在min和max之间,只能用于字符串
@Max	该字段的值只能小于或等于该值
@Min	该字段的值只能大于或等于该值
@NotNull	不能为null
@NotBlank	不能为空，检查时会将空格忽略
@NotEmpty	不能为空，这里的空是指空字符串
@Pattern(regex=)	被注释的元素必须符合指定的正则表达式
@URL(protocol=,host,port)	检查是否是一个有效的URL，如果提供了protocol，host等，则该URL还需满足提供的条件

2. 给校验字段标注校验注解 javax.validation.constraints

• 比如 @NotBlank() 表示被注释的元素不能为空并且必须包含至少一个不为空白的字符
  • @NotBlank(message = “品牌名必须提交”) 自定义出错后提示
  • @NotNull 可以接收任何类型
  • @NotEmpty 字符串 集合 map 数组
• 开启校验功能
  • 在需要校验的Bean上添加@Valid
    • 效果：校验错误后会有默认的响应
  • 给校验的Bean后紧跟一个BindingResult,就可以获取到检验的结果

• result.hasErrors() 校验是否有错误
• result.getFieldErrors() 获取校验结果
• getDefaultMessage() 获取错误提示消息
• getField() 获取出错的属性字段

    @RequestMapping("/save")
    public R save(@Valid @RequestBody BrandEntity brand, BindingResult result){

        //如果校验出错
        if(result.hasErrors()){
            Map<String,String> map=new HashMap<>();
            //获取校验的结果
            result.getFieldErrors().forEach(item->{
                //FieldError 错误提示消息
                String message=item.getDefaultMessage();
                //获取错误的属性的名字
                String field=item.getField();
                map.put(field,message);
            });

            return R.error(400,"提交的数据不合法").put("data",map);
        }else {
            brandService.save(brand);
            return R.ok();
        }

    }

@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 品牌id
	 */
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名必须提交")
	private String name;
	/**
	 * 品牌logo地址
	 */
	@URL(message = "logo必须是一个合法的url地址")
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */

	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotEmpty		
	@Pattern(regexp = "/^[a-zA-Z]$/",message = "检索首字母必须是一个字母")
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull
	@Min(value = 0,message = "排序必须大于等于0")
	private Integer sort;

}

分组校验

• 由于业务需求，新增和修改校验可能不同(比如添加ID 必须为空 修改 需要指定品牌ID)
  • @NotBlank(message = “品牌名必须提交”,groups = {AddGroup.class,UpdateGroup.class})
    给校验标注什么情况需要进行校验

接口作用是标识
public interface UpdateGroup(){}
public interface AddGroup(){}



@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 品牌id
	 */
	@NotNull(message = "修改必须指定品牌ID",groups = {UpdateGroup.class})
	@Null(message = "新增不能指定ID",groups = {AddGroup.class})
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名必须提交",groups = {AddGroup.class,UpdateGroup.class})
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank(groups = {AddGroup.class})
	@URL(message = "logo必须是一个合法的url地址",groups = {AddGroup.class,UpdateGroup.class})
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */

	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotEmpty(groups = {AddGroup.class})
	@Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups = {AddGroup.class,UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull(groups = {AddGroup.class})
	@Min(value = 0,message = "排序必须大于等于0",groups = {AddGroup.class,UpdateGroup.class})
	private Integer sort;
}

• @Validated 给校验注解标注什么情况需要校验
  创建分组接口
  AddGroup.interface
  UpdateGroup.interface

在Controller中标注 @Validated({AddGroup.class})

  	/**
     * 保存
     */
 @RequestMapping("/save")
   // @RequiresPermissions("product:brand:save")
    public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand/*, BindingResult result*/){

        brandService.save(brand);
        return R.ok();
    }

    /**
     * 修改
     */
    @RequestMapping("/update")
   // @RequiresPermissions("product:brand:update")
    public R update(@Validated({UpdateGroup.class})@RequestBody BrandEntity brand){
		brandService.updateById(brand);

        return R.ok();
    }

• 默认没有指定分组的校验注解@NotBlank，在分组校验情况下不生效，只会在@Validated生效（Controller中没有分组）

自定义校验

• 编写一个自定义校验注解
  参照 @NotBlank注解编写
• 关联自定义校验器和自定义校验注解

	/**
	 * 显示状态[0-不显示；1-显示]	自定义注解
	 */
	@ListValue(values={0,1},groups = {AddGroup.class})
	private Integer showStatus;

/**
 * 自定义校验
 */
@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})      //校验器  可以指定多个不同的校验器 适配不同类型的校验
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {

    String message() default "{com.valid.ListValue.message}";		必须要有 错误信息去哪里取
    //去resources创建 ValidationMessages.properties 配置:com.valid.ListValue.message=必须提交指定的值	

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

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

    int[] values() default { };

}

//@Constraint
//----> Class<? extends ConstraintValidator<?, ?>>[] validatedBy();	第一个泛型 自定义的注解 第二个：注解类型

• 编写一个自定义校验器

ConstraintValidator<校验注解,标注在什么类型上>
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {

    private Set<Integer> set =new HashSet<>();

    //初始化方法
    @Override
    public void initialize(ListValue constraintAnnotation) {
        //包含注解详细信息
        int[] values = constraintAnnotation.values();
        
        for (int v:values) {
            set.add(v);
        }
    }

    /**
     *
     * @param value 需要校验的值
     * @param context   整个校验的上下文环境信息
     * @return
     */
     //判断是否校验成功
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
    //如果传进来的值在标注的注解规则存在就返回true 否则
        //value 外部传进来的值
        return this.set.contains(value);
    }
}

可以指定多个不同的校验器 适配不同类型的校验

业务太多后太麻烦

统一异常处理

/**
* 集中处理所有异常
 * @ControllerAdvice
 * @ResponseBody
* */
@Slf4j
@RestControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
//@ControllerAdvice(annotations = {RestController.class, Controller.class})  或则扫描加了这几种注解的
public class GulimallExceptionControllerAdvice {
    
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e){
        log.error("数据检验出现问题：{}异常类型：{}",e.getMessage(),e.getClass());
        BindingResult result = e.getBindingResult();

        Map<String,String> errorMap=new HashMap<>();
        //获取校验的结果
        result.getFieldErrors().forEach(item->{
            //FieldError 错误提示消息 item.getDefaultMessage();  获取错误的属性的名字    item.getField();
            errorMap.put(item.getDefaultMessage(),item.getField());
        });
        return R.error(400,"提交的数据不合法").put("data",errorMap);
    }
	//处理所有异常
    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable){
        return R.error();
    }
}

    @RequestMapping("/save")
   // @RequiresPermissions("product:brand:save")
    public R save(@Valid @RequestBody BrandEntity brand/*, BindingResult result*/){

        brandService.save(brand);
        return R.ok();
    }

响应数据

//自定义属性
	@JsonInclude(JsonInclude.Include.NON_EMPTY)	//响应回的JSON串中，字段不为空才返回（为空的字段不返回）
	@TableField(exist = false)
	private List<CategoryEntity> children;

快速失败返回模式

默认会对我们的每个属性都进行校验,
通过控制台的输出可以看到，校验框架将我们的多个属性都进行了数据校验（默认行为），如果我们希望只要有一个属性校验失败就直接返回提示信息，后面的属性不再进行校验了该如何实现呢？

public class ValidatorConfiguration {
    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = 
            Validation.byProvider(HibernateValidator.class)
                .configure()
                //快速失败返回模式
                .addProperty("hibernate.validator.fail_fast", "true")
                .buildValidatorFactory();
        return validatorFactory.getValidator();
    }

    /**
     * 开启快速返回
     * 如果参数校验有异常，直接抛异常，不会进入到 controller，使用全局异常拦截进行拦截
     */
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor postProcessor = 
            new MethodValidationPostProcessor();
        /**设置validator模式为快速失败返回*/
        postProcessor.setValidator(validator());
        return postProcessor;
    }
}

注意：上面创建的类并不是配置类，所以到目前为止快速失败返回模式并不会生效，为了使其生效需要创建一个注解用于控制此模式的开启

第八步：创建注解EnableFormValidator用于控制快速失败返回模式的开启

/**
 * 在启动类上添加该注解来启动表单验证功能---快速失败返回模式
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(ValidatorConfiguration.class)
public @interface EnableFormValidator {
}

在启动类上加入EnableFormValidator注解，开启快速失败返回模式

@SpringBootApplication
@EnableFormValidator
public class HibernateValidatorApp {
    public static void main(String[] args) {
        SpringApplication.run(HibernateValidatorApp.class,args);
    }
}

通过控制台的输出可以看到，虽然我们输入的数据有多个都不符合校验规则，但是只有一个校验失败异常信息，这说明已经开启了快速失败返回模式。