JSR303数据校验

JSR303数据校验

1、给Bean添加校验注解

在javax.validation.constraints包下，并定义自己的message提示

@NotBlank(message = "品牌名必须提交")
private String name;

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

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

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

2、开启校验功能@Valid

效果：校验错误以后会有默认的响应

public R save(@Valid @RequestBody BrandEntity brand){
}

3、给校验的bean后紧跟一个BindingResult，就可以获取到校验的结果

public R save(@Valid @RequestBody BrandEntity brand,BindingResult result){
    if(result.hasErrors()){
        Map<String,String> map = new HashMap<>();
        //1、获取校验的错误结果
        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();
}

4、统一的异常处理

1）、编写异常处理类，使用@ControllerAdvice。

2）、使用@ExceptionHandler标注方法可以处理的异常。

/**
 * 集中处理所有异常
 */
@Slf4j
//@ResponseBody
//@ControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
@RestControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {

    @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<>();
        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());
    }


}

5、错误码规范

/**
 * 错误码和错误信息定义类
 * 1. 错误码定义规则为5为数字
 * 2. 前两位表示业务场景，最后三位表示错误码。例如：100001。10:通用 001:系统未知异常
 * 3. 维护错误码后需要维护错误描述，将他们定义为枚举形式
 * 错误码列表：
 *  10: 通用
 *      001：参数格式校验
 *      002：短信验证码频率太高
 *  11: 商品
 *  12: 订单
 *  13: 购物车
 *  14: 物流
 *  15：用户
 *  21：库存
 *
 *
 */
public enum BizCodeEnume {
    UNKNOW_EXCEPTION(10000,"系统未知异常"),
    VAILD_EXCEPTION(10001,"参数格式校验失败"),
    SMS_CODE_EXCEPTION(10002,"验证码获取频率太高，请稍后再试！"),
    TO_MANY_REQUEST(10003,"请求流量过大，请稍后再试！"),

    PRODUCT_UP_EXCEPTION(11000,"商品上架失败"),
    PHONE_EXIST_EXCEPTION(15001,"手机号重复"),
    USERNAME_EXIST_EXCEPTION(15002,"用户名重复"),
    USE_LOGIN_EXCEPTION(15002,"用户登录异常"),
    NO_STOCK_EXCEPTION(21000,"商品库存不足"),
    ;

    private int code;
    private String msg;
    BizCodeEnume(int code,String msg){
        this.code = code;
        this.msg = msg;
    }

    public int getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

6、分组校验

由于添加时id是自增，所以提交时不需要带id。但是修改却必须要带，会冲突，所以需要分组校验

1)、定义分组接口

public interface AddGroup {
}

public interface UpdateGroup {
}

2)、给校验注解标注什么情况需要进行分组

@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;

3)、开启分组校验功能@Validated

public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){
}

4)、默认没有指定分组的校验注解比如@NotBlank，在分组校验情况@Validated({AddGroup.class})下不生效，只会在@Validated生效；

7、自定义校验

1)、导入依赖

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

2)、编写一个自定义的校验注解

@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class }) //自定义的校验器
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
    String message() default "{com.atguigu.common.valid.ListValue.message}"; //默认的错误消息

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

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

    int[] vals() default { };
}

3)、编写一个默认错误消息的配置文件 ValidationMessages.properties

com.atguigu.common.valid.ListValue.message=必须提交指定的值

4)、编写一个自定义的校验器

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {

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

    /**
     * 初始化方法
     *
     * @param constraintAnnotation
     */
    @Override
    public void initialize(ListValue constraintAnnotation) {

        int[] vals = constraintAnnotation.vals();
        if (vals.length > 0) {
            for (int val : vals) {
                set.add(val);
            }
        }

    }

    /**
     * 判断是否校验成功
     *
     * @param value   需要校验的值
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {

        return set.contains(value);
    }
}

5)、关联自定义的校验器和自定义的校验注解

@Constraint(validatedBy = { ListValueConstraintValidator.class【可以指定多个不同的校验器，适配不同类型的校验】 })