后端数据校验

后台开发需要对传进来的对象进行参数校验, 有专门的校验工具 validation-api. 它是基于 JSR-303 标准开发出来的, 使用注解方式实现, 及其方便, 但这只是一个接口, 没有具体的实现. hibernate-validator 是一个 hibernate 独立的包, 可以直接引用, 它实现了 validation-api, 同时做了扩展, 非常强大.

校验规则

javax.validation.constraints

org.hibernate.validator.constraints

使用方法

直接使用

定义 Bean

@Data
@ToString(of = {"id", "name", "altName"})
public class PoiPlant implements Serializable {
    private static final long serialVersionUID = -354255909978410198L;

    private Integer id;

    @NotBlank(message = "{plant.name}{javax.validation.constraints.NotBlank.message}")
    @Length(min = 5, max = 32, message = "{plant.name}: ${validatedValue}, {org.hibernate.validator.constraints.Length.message}")
    private String name;

    private String altName;

    private String content;
}

自定义校验错误信息, 在 resources 中增加 ValidationMessages.properties 文件, 内容如下:

plant.name=\u690d\u7269\u540d

用单元测试, 进行验证校验

PoiPlant plant = new PoiPlant();
Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
// 校验整个 Bean
validator.validate(plant).forEach(System.out::println);
// 校验类的某个字段
validator.validateValue(PoiPlant.class, "name", "test").forEach(System.out::println);

输出结果

植物名不能为空
植物名: a, 长度需要在5和32之间
植物名: test, 长度需要在5和32之间

在 Spring MVC 中使用

public Result update(@Valid PoiPlant plant, BindingResult bindingResult)

这里一个 @Valid 的参数后必须紧挨着一个 BindingResult 参数, 否则 spring 会在校验不通过时直接抛出异常.

级联验证

对象内部包含另一个对象作为属性, 属性上加 @Valid, 可以验证作为属性的对象内部的验证

@ConstraintComposition 组合校验规则

自定义校验规则

参考文献

• javax.validation.Validation使用方法
• javax.validation的基本使用
• Spring4新特性——集成Bean Validation 1.1(JSR-349)到SpringMVC
• springboot使用hibernate validator校验
• Hibernate Validator 使用介绍
• Hibernate Validator 校验框架的使用经验
• 银行卡号码校验算法（Luhn算法，又叫模10算法）
• 通过银行卡号查询银行类型和银行卡类型