在这篇快速文章中,我们将介绍使用标准框架 - JSR 380(也称为Bean Validation 2.0)来验证Java bean的基础知识。
当然,在大多数应用程序中验证用户输入是超常见的需求,而Java Bean验证框架已成为处理这种逻辑的事实上的标准。
JSR 380是用于Bean验证,JavaEE的和的JavaSE的一部分,这确保了一个bean的属性符合特定条件,使用注释如Java API的说明书中@NotNull,@Min,和 @Max。
该版本需要Java 8或更高版本,并利用Java 8中添加的新功能(例如类型注释),并支持新类型(如Optional和LocalDate)。
有关规格的完整信息,请继续阅读JSR 380。
我们将使用Maven示例来显示所需的依赖关系,但当然,可以使用各种方式添加这些jar。
根据JSR 380规范,validation-api依赖包含标准验证API:
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.0.Final</version>
</dependency>
Hibernate Validator是验证API的参考实现。
要使用它,我们必须添加以下依赖项:
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.2.Final</version>
</dependency>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator-annotation-processor</artifactId>
<version>6.0.2.Final</version>
</dependency>
这里的一个快速提示:hibernate-validator完全独立于Hibernate的持久化方面功能模块,并且通过添加它作为依赖项,我们不会将这些持久性方面功能模块添加到项目中。JSR 380提供了对变量插值的支持,允许违规消息中的表达式。
要解析这些表达式,我们必须添加对表达式语言API和该API实现的依赖关系。GlassFish提供了参考实现:
<dependency>
<groupId>javax.el</groupId>
<artifactId>javax.el-api</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>org.glassfish.web</groupId>
<artifactId>javax.el</artifactId>
<version>2.2.6</version>
</dependency>
如果未添加这些JAR,则会在运行时收到错误消息,如下所示:
HV000183: Unable to load ‘javax.el.ExpressionFactory’. Check that you have the EL dependencies on the classpath, or use ParameterMessageInterpolator instead
我们将在这里使用一个用户 bean作为主要的例子,并且为它添加一些简单的验证:
import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import javax.validation.constraints.Email;
public class User {
@NotNull(message = "Name cannot be null")
private String name;
@AssertTrue
private boolean working;
@Size(min = 10, max = 200, message = "About Me must be between 10 and 200 characters")
private String aboutMe;
@Min(value = 18, message = "Age should not be less than 18")
@Max(value = 150, message = "Age should not be greater than 150")
private int age;
@Email(message = "Email should be valid")
private String email;
// standard setters and getters
}
示例中使用的所有注释都是标准的JSR注释:
一些注释接受附加属性,但是消息属性对所有属性都是通用的。这是当相应属性的值未通过验证时通常会显示的消息。
JSR中可以找到的一些附加注释是:
验证注释也可以应用于集合的元素:
List<@NotBlank String> preferences;
在这种情况下,任何添加到首选项列表的值都将被验证。
规范还支持 Java 8中的新的可选类型:
private LocalDate dateOfBirth;
public Optional<@Past LocalDate> getDateOfBirth() {
return Optional.of(dateOfBirth);
}
在这里,验证框架将自动解包LocalDate 值并对其进行验证。
一些框架 - 比如Spring--通过使用注释可以简单地触发验证过程。这主要是因为我们不必与编程验证API进行交互。
现在让我们开始手动路线并以编程方式设置:
ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
Validator validator = factory.getValidator();
为了验证一个bean,我们必须首先有一个Validator对象,它是使用ValidatorFactory构造的 。
我们现在要设置这个无效的用户 - 具有空名称值:
User user = new User();
user.setWorking(true);
user.setAboutMe("Its all about me!");
user.setAge(50);
现在我们有了一个Validator,我们可以通过将它传递给validate方法来验证我们的bean 。任何违反用户对象中定义的约束条件 都将作为一个Set返回。
Set<ConstraintViolation<User>> violations = validator.validate(user);
通过遍历违规,我们可以通过使用getMessage 方法来获取所有违规消息。
for (ConstraintViolation<User> violation : violations) {
log.error(violation.getMessage());
}
在我们的示例(ifNameIsNull_nameValidationFails)中,该集合将包含一个 ConstraintViolation,其中消息“ Name不能为null ”。
本教程重点介绍了通过标准Java验证API的简单传递,并说明了使用javax.validation注释和API 进行bean验证的基础知识。
本文中的概念的实现可以在GitHub项目中找到。我们将在即将发布的文章中介绍JSR 380和Hibernate Validator的更多功能。
https://www.leftso.com/article/389.html