一:背景说明
验证数据是一个常见的任务,它贯穿于所有应用层,从呈现到持久层。通常在每个层中都执行相同的验证逻辑,耗时且容易出错。为了避免这些验证的重复,开发商往往把验证逻辑直接进入的领域模型,在领域类的验证码,这真是对类本身的元数据。
只需要一个domain进行添加注解,然后在想要使用数据的层使用验证即可。
二:Bean的注解说明
1.说明
在Bean验证约束是通过java注释表示。在本节中,您将学习如何使用这些注释增强对象模型。有四种类型的bean约束:
-
field constraints:在使用字段级约束时,字段访问策略用于访问要验证的值。这意味着验证引擎直接访问实例变量和不调用属性访问器方法,即使这样一个访问器的存在。
- 注意点虽然支持private或者public,是不支持static的字段
-
property constraints:如果你的模型类遵循JavaBeans规范,也可以放在领域类的属性上标注,就是get方法上
- 注意点,不包括set方法
container element constraints:容器元素的约束
class constraints:类约束
附件一:bean约束
适用于field/property的约束
@AssertFalse
被注释的元素必须为 false
@AssertTrue
被注释的元素必须为 true
@DecimalMax(value=, inclusive=)
当包含inclusive
= false时,检查带注释的值是否小于指定的最大值。否则值是否小于或等于指定的最大值。
参数值是根据BigDecimal的字符串表示的最大值的字符串表示形式。
@DecimalMin(value=, inclusive=)
当包含inclusive
= false时,检查带注释的值是否大于指定的最小值。
否则值是否大于或等于指定的最小值。
参数值是根据BigDecimal字符串表示的值的字符串表示形式。
@Digits(integer=, fraction=)
检查带注释的值是否是具有整数位数和小数位数的数字
@Email
被注释的元素必须是电子邮箱地址
@Future
被注释的元素必须是一个将来的日期
@FutureOrPresent
被注释的元素必须是一个将来的日期或者现在
@Max(value=)
被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Min(value=)
被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@NotBlank
被注释的字符串的必须非空,同时,长度大于0
@NotEmpty
被注释的字符串的必须非空,非null
@NotNull
被注释的字符串的必须非空
@Negative
检查元素是否严格负。零值被认为是无效的。
@NegativeOrZero
注释的检查元素是负或者零值。
@Null
注释的元素必须是null
@Past
注释的元素时间必须是过去的时间
@PastOrPresent
注释的元素时间必须是过去或者当前
@Pattern(regex=, flags=)
被注释的元素必须符合指定的正则表达式
@Positive
被注释的元素必须是严格的正值,不包括零值
@PositiveOrZero
被注释的元素是正值或者零
@Size(min=, max=)
被注释的元素的大小必须在指定的范围内,包含最大值
附件二:附加的约束
除了由Bean验证API定义的约束,Hibernate Validator提供一些有用的自定义约束条件如下。适用于field/property的约束,只有“scriptassert是class级约束。
@CreditCardNumber(ignoreNonDigitCharacters=)
这个验证旨在检查用户的错误,而不是信用卡的有效性
@Currency(value=)
验证货币单位
@EAN
检查注释字符序列是一个有效的EAN条码
@Length(min=, max=)
被注释的字符串的大小必须在指定的范围内
@Range(min=, max=)
被注释的元素必须在合适的范围内
@SafeHtml(whitelistType= , additionalTags=, additionalTagsWithAttributes=, baseURI=)
classpath中要有jsoup包
@URL(protocol=, host=, port=, regexp=, flags=)
被注释的字符串必须是一个有效的url
@ScriptAssert(lang=, script=, alias=, reportOn=)
要有Java Scripting API
三:案例一(field的验证)
1.pom
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <groupId>com.caojun.it</groupId>
<artifactId>hibernateValidator</artifactId>
<version>1.0-SNAPSHOT</version> <!--hibernate validator-->
<dependencies>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.5.Final</version>
</dependency>
<dependency>
<groupId>org.glassfish</groupId>
<artifactId>javax.el</artifactId>
<version>3.0.1-b08</version>
</dependency>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator-cdi</artifactId>
<version>6.0.5.Final</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
</dependency>
</dependencies> </project>
2.Car.java
package org.hibernate.validator.referenceguide.chapter01; import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size; /**
* 对car的约束条件:
* manufacturer不为空
* licensePlate长度是2,14之间
* seatCount最小值是2
*/
public class Car {
@NotNull
private String manufacturer; @NotNull
@Size(min = 2, max = 14)
private String licensePlate; @Min(2)
private int seatCount; public Car(){} public Car(String manufacturer, String licencePlate, int seatCount) {
this.manufacturer = manufacturer;
this.licensePlate = licencePlate;
this.seatCount = seatCount;
} public String getManufacturer() {
return manufacturer;
} public void setManufacturer(String manufacturer) {
this.manufacturer = manufacturer;
} public String getLicensePlate() {
return licensePlate;
} public void setLicensePlate(String licensePlate) {
this.licensePlate = licensePlate;
} public int getSeatCount() {
return seatCount;
} public void setSeatCount(int seatCount) {
this.seatCount = seatCount;
}
}
3.测试案例
package org.hibernate.validator.referenceguide.chapter01; import org.junit.BeforeClass;
import org.junit.Test; import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.Iterator;
import java.util.Set; import static org.junit.Assert.assertEquals; /**
* 对car的测试类
*/
public class CarTest {
private static Validator validator; /**
* 生成validator校验器
*/
@BeforeClass
public static void setUpValidator() {
ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
validator = factory.getValidator();
} /**
* 验证整个Car
*/
@Test
public void test() {
Car car = new Car( null, "DD-AB-123", 1);
//如果有不符合的在validate后,会将错误信息存放到Set中
Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car );
//如果ite中没有信息,就是正确的
Iterator<ConstraintViolation<Car>> ite = constraintViolations.iterator();
while(ite.hasNext()) {
System.out.println(ite.next().getMessage());
}
} /**
* 单独验证Car对象中的某一个属性,例如licensePlate
*/
@Test
public void licensePlateTooShort() {
Car car = new Car( "Morris", "D", 4 ); Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car ); //这里使用junit中的断言,断言会出现一个exception
assertEquals( 1, constraintViolations.size() ); } }
四:案例二(property的验证)
1.Car.java
package org.hibernate.validator.referenceguide.chapter02.propertylevel; import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.NotNull; public class Car {
private String manufacturer; private boolean isRegistered; public Car(String manufacturer, boolean isRegistered) {
this.manufacturer = manufacturer;
this.isRegistered = isRegistered;
} @NotNull
public String getManufacturer() {
return manufacturer;
} public void setManufacturer(String manufacturer) {
this.manufacturer = manufacturer;
} @AssertTrue
public boolean getIsRegistered() {
return isRegistered;
} public void setRegistered(boolean isRegistered) {
this.isRegistered = isRegistered;
}
public Car(){} }
2.CarTest.java
package org.hibernate.validator.referenceguide.chapter02.propertylevel;
import static org.junit.Assert.assertEquals; import org.junit.BeforeClass;
import org.junit.Test; import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.Iterator;
import java.util.Set; public class CarTest {
private static Validator validator; /**
* 生成validator校验器
*/
@BeforeClass
public static void setUpValidator() {
ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
validator = factory.getValidator();
}
/**
* 验证整个Car
*/
@Test
public void test() {
Car car=new Car("asaas",true);
//如果有不符合的在validate后,会将错误信息存放到Set中
Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car );
//如果ite中没有信息,就是正确的
Iterator<ConstraintViolation<Car>> ite = constraintViolations.iterator();
while(ite.hasNext()) {
System.out.println(ite.next().getMessage());
}
}
}