javaBean验证框架(1)—概述

时间:2022-06-04 19:03:32

javaBean验证框架(1)

javaBean验证是基于注解的对象验证框架。
可以在字段、方法或构造函数的参数或返回值、javaBean组件对应的类上添加注解,然后使用javax.validation.Validator类实例的validate(...)方法触发bean的验证。
在框架中验证注解也被称为约束(constraints)。验证器是主要接口实施验证验证过程并发现验证错误。验证规范在JSR349和JSR303中定义。

验证实现

Hibernate验证引擎是规范的参考实现,所以我们可以通过gradle引入相应jar。

 compile group: 'org.hibernate.validator', name: 'hibernate-validator', version: '6.0.2.Final'

示例说明

下面通过示例说明字段和属性验证的区别。

字段验证bean:

package com.dataz.entity;

import javax.validation.constraints.NotNull;

public class FieldBean {
@NotNull
private String str;

public String getStr () {
return str;
}

public void setStr (String str) {
this.str = str;
}
}

属性验证bean:

package com.dataz.entity;

import javax.validation.constraints.NotNull;

public class PropertyBean {
private String str;

@NotNull
public String getStr () {
return str;
}

public void setStr (String str) {
this.str = str;
}
}

验证代码:

import com.dataz.entity.FieldBean;
import com.dataz.entity.PropertyBean;

import javax.validation.*;

public class ValidationDemo1 {
private static final Validator validator;

//获得验证器实例
static {
Configuration<?> config = Validation.byDefaultProvider().configure();
ValidatorFactory factory = config.buildValidatorFactory();
validator = factory.getValidator();
factory.close();
}

public static void main(String[] args) {
FieldBean fieldBean = new FieldBean();

PropertyBean propertyBean = new PropertyBean();

//验证字段Bean
System.out.println("开始验证字段...");
validator.validate(fieldBean).stream()
.forEach(ValidationDemo1::printError);

//验证属性
System.out.println("开始验证属性...");
validator.validate(propertyBean).stream()
.forEach(ValidationDemo1::printError);

}

private static void printError(ConstraintViolation violation) {
System.out.println(violation.getPropertyPath()
+ " " + violation.getMessage());
}
}

上面代码首先启动并获得javax.validation.Validator类的实例,然后依次执行验证,并打印验证结果。

我们在字段级别使用@NotNull注解,也可以在getter上使用,因为我们看@NotNull接口中已经定义了如下代码:

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })

有方法和字段等。

运行结果为:

开始验证字段...
str 不能为null
开始验证属性...
str 不能为null

你可能会惊讶,怎么出现中文了。这时Hibernate实现中提供的国际化资源,如下图:

javaBean验证框架(1)—概述

总结

本文介绍了javaBean验证框架及Hibernate的参考实现,通过示例演示了验证过程及错误信息展示。