数据校验JSR303、异常统一处理

一、前端防君子、后端防小人。

        通过在前端验证数据外、可以有效的防止数据不符合规则。但是除了可以在浏览器前端页面发送数据外，还可以通过postman等一系列工具向后端发送请求。

        因此后端进行数据校验也是非常有必要的。通常的项目，前后端都要进行数据校验。

二、JSR303

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

三、入门操作

 3.1 给实体类的字段添加响应的校验注解

message为可以自定义的错误信息，有默认值，可以进入源码查看

        校验注解有很多：

 3.2、给controller方法参数添加注解，开启校验

 3.3、使用bindingResult查看结果并处理。

四、验证注解

例如：

 除此还有很多、需要根据情况选择。

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

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

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

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

数值检查
建议使用在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=)
 

五、统一异常处理

        使用BindingResult，在每个方法上处理错误是很低效的。

5.1 建一个异常处理的切面

5.2 处理的controller包

 5.3 使用没有BindingResult参数的方法，出现异常抛出给异常切面处理

 5.4 编写异常处理方法

@Slf4j
//@ControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")   //统一处理Controller
@RestControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {

    // 处理的异常类型
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e) {
        log.error("数据校验出现问题{},异常类型：{}",e.getMessage(),e.getClass());
        BindingResult bindingResult = e.getBindingResult();
        Map errorMap = new HashMap<>();
        bindingResult.getFieldErrors().forEach(fieldError -> {
            errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
        });
        //参数校验异常
        return R.error(BizCodeEnum.VAILD_EXCEPTION.getCode(), BizCodeEnum.VAILD_EXCEPTION.getMsg()).put("data",errorMap);
    }

    /**
     * 其余异常
     * @param throwable
     * @return
     */
    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable) {
        //系统未知异常
        log.error("系统未知异常：msg:{}",throwable.getMessage());
        return R.error(BizCodeEnum.UNKNOW_EXCEPTION.getCode(), BizCodeEnum.UNKNOW_EXCEPTION.getMsg());
    }
}

5.5 自定义错误码，供处理方法使用

 5.6 分组校验（修改和新增时，校验的字段是不一致的，要求也是不一致的）

        先编写接口作为分组标识，无实际内容，只作为标识使用。

，

        在实体类校验注解上标注分组类型。

        在controller方法上标注该方法处理的是哪一组。

六、自定义校验注解

6.1、编写（根据其他官方注解编写）

package com.atguigu.common.valid;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Constraint(
        validatedBy = {ListValueConstrainValidator.class}
)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ListValue {

    //自定义校验注解， 默认的信息在资源文件就中存放，模拟其他类似注解
    String message() default "{com.atguigu.common.valid.ListValue.message}";

    Class[] groups() default {};

    Class[] payload() default {};

    int[] vals() default {};

}

 自定义校验器（在自定义的校验注解类的注解中使用）

package com.atguigu.common.valid;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;

/**
 * 校验器，将注解上的值存放到set中，判断请求参数是否符合set中的默认值。
 */
public class ListValueConstrainValidator implements ConstraintValidator {

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

    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }

    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
        return set.contains(value);
    }
}

使用

参考：

JSR 303 进行后台数据校验 - 累成一条狗 - 博客园