java后端数据校验技术-JSR303

java后端数据校验技术-JSR303

为什么需要后端数据校验

在开发中，用户在页面操作时，为了防止频繁与后台接口交互，采用了前端数据校验技术，即检查用户输入的数据是否合法，如果数据不合法，则不会向后端发送网络请求，即前端校验便于用户纠正（快速反馈），并且减少服务器压力、节省流量（减少无意义的请求），主要对用户友好。那么为什么还需要后端数据校验呢？
后端数据校验是防止接口被私自调用导致破坏数据库结构；避免有人模拟浏览器行为直接给服务器发请求。

JSR303

JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准

下面我们直接看在springboot项目中的使用：

<!--springboot-web 2.3之后不再默认集成validation 需要自己引入依赖 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
  <version>2.3.3.RELEASE</version>
</dependency>

实体类注解

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

请求时在发送的数据前加开启验证

@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand){...}

异常处理 返回错误信息

@RequestMapping("/save")
// 这个BindingResult必须紧跟着需要检验的实体bean
public R save(@Valid @RequestBody BrandEntity brand, BindingResult result) {
    if (result.hasErrors()) {
        HashMap<String, String> map = new HashMap<>();
        result.getFieldErrors().forEach(item -> {
            String msg = item.getDefaultMessage();
            String field = item.getField();
            map.put(field, msg);
        });
        return R.error(400, "提交数据不合法").put("data", map);
    } else {
        brandService.save(brand);
    }
    return R.ok();
}

利用SpringMVC提供的 @controllerAdvice 封装统一处理

/**
 * 描述: 统一异常处理
 *
 * @author cm_fighting
 * @create 2020-09-15 2:10 下午
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.itcm.skymail.product.controller")
public class SkymailExceptionControllerAdvice {

    // 精确异常处理
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e) {
        log.error("数据校验出现异常：{}", e.getMessage());
        BindingResult bindingResult = e.getBindingResult();

        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        HashMap<String, String> map = new HashMap<>();
        fieldErrors.forEach(item -> {
            String field = item.getField();
            String message = item.getDefaultMessage();
            map.put(field, message);
        });
        return R.error(BizCodeEnum.VALID_EXCEPTION.getCode(), BizCodeEnum.VALID_EXCEPTION.getMsg()).put("data", map);

    }

    // 通用异常处理， 如果有精确异常处理 会先找精确异常处理
    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable e) {
        log.error(e.getMessage());
        return R.error(BizCodeEnum.UNKNOW_EXCEPTION.getCode(), BizCodeEnum.UNKNOW_EXCEPTION.getMsg());
    }
}

分组校验

业务场景，当新增时和修改式 对提交数据的校验规则是不同的，如修改时候，不需要更新的字段数据时不需要提交的，或者新增时不需要id,修改时需要id。这时候就可以采用分组校验。

// 这里的规则仅为了测试设置 不需要考虑真实场景
// 如果使用了分组校验 则校验规则上必须指定分组 否则规则不生效（即@validated中没有指定分组时生效）
// 这里分组指定的AddGroup和UpdataGroup仅仅起到标记作用，自己创建两个空接口即可，和Controller中校验使用的分组对应
@Null(message = "新增时不能传id", groups = {AddGroup.class})
@NotNull(message = "修改数据时id不能为空", groups = {UpdateGroup.class})
@TableId
private Long brandId;

// 因为定义了通用异常处理，所以不需要再通过BindingResult接收异常信息，不处理会抛异常正好被通用异常处理捕获
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand) {
	...
}

自定义校验

• 编写自定义校验注解 (可以参考已有的校验注解来写)
• 编写自定义校验器
• 关联两者

自定义校验注解@ListValue，用来校验传入的Integer值是否为指定的值，并指定默认返回的message,和默认int[]

这里需要引入validation-api依赖

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

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})
public @interface ListValue {
    String message() default "{com.itcm.common.valid.ListValue.message}";

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

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

    int[] value() default {};
}

自定义校验器 ListValueConstraintValidator 并在自定义校验注解中指定使用这个校验器，此处可以指定多个校验器

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {

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

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

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

自定义消息配置 resource/ValidationMessages.properties

com.itcm.common.valid.ListValue.message=必须为指定的值

使用自定义注解

@ListValue(value = {0, 1}, groups = {AddGroup.class}) // 新增时只能传 0 或者 1
private Integer showStatus;