Spring Boot 校验

概述

• Spring Validator
• Apache commons-validator

Spring Validator

Spring Framework 提供了用于校验对象的Validator 接口，在校验过程中，与 Errors 对象配合。校验器可以通过Errors 对象报告校验失败的信息。

public interface Validator {

    boolean supports(Class<?> clazz);

    void validate(Object target, Errors errors);

}

Validation Spring Boot 整合

校验器的作用是，数据符合规范了才能执行相应的逻辑

1、加入maven支持

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

2、 实现 org.springframework.validation.Validator接口

public class OrderRequestValidator implements Validator {

    @Override
    public boolean supports(Class<?> aClass) {
        //实现 supports 方法判断是否需要支持校验
        return OrderRequest.class.equals(aClass);
    }

    @Override
    public void validate(Object o, Errors errors) {

        ValidationUtils.rejectIfEmpty(errors, "name", "name.empty");
        ValidationUtils.rejectIfEmpty(errors, "invoiceRequest.name","invoiceRequest name 不能为空");
        OrderRequest p = (OrderRequest) o;
        if (p.getId() < 0) {
            errors.rejectValue("id", "ID 不能小于0 ");
        } 
    }
}

3、controller做绑定(也可以用Java 实现，我这里用了kotlin)

    @InitBinder
    fun initBinder(binder: WebDataBinder) {
        binder.addValidators(OrderRequestValidator())
    }
    @RequestMapping("/order")
    fun order(@RequestBody @Validated orderRequest: OrderRequest): Any {
        // do work
        return "OK"
    }

java实现

    @InitBinder
    public void initBinder(WebDataBinder webDataBinder) {
        webDataBinder.addValidators(new OrderRequestValidator());
    }

实现模式
当方法返回 false时，视作不予校验
实现 validate 方法，判断 target 参数是否校验合法
当校验非法时，通过Errors 对象返回
实现 MessageCodesResolver 或重用框架实现，完成错误信息编码化

辅助
使用工具类 ValidationUtils ， 辅助通用校验逻辑

Apache commons-validator

验证器类型

Date 与 Time 校验器
数值校验器
正则表达式校验器
ISBN校验器
IP 地址校验器
邮件地址校验器
URL 校验器
域名校验器

其他校验器

API

org.apache.commons.validator.routines.RegexValidator
org.apache.commons.validator.routines.CodeValidator
org.apache.commons.validator.routines.ISBNValidator
org.apache.commons.validator.routines.InetAddressValidator
org.apache.commons.validator.routines.EmailValidator
org.apache.commons.validator.routines.UrlValidator
org.apache.commons.validator.routines.DomainNameValidator

常用注解

@Valid
@NotNull
@Null
@Size
@Min
@Max

参考文档

https://docs.spring.io/spring-boot/docs/2.0.0.RELEASE/reference/htmlsingle/#boot-features-validation