JSR 303 Bean Validation 学习笔记

一. 定义

是一个数据验证的规范,2009 年 11 月确定最终方案。2009 年 12 月 Java EE 6 发布,Bean Validation 作为一个重要特性被包含其中。

二. 使用场景

处理一个应用程序的业务逻辑,数据校验是你必须要考虑和面对的事情。应用程序必须通过某种手段来确保输入进来的数据是符合业务含义的。同时,为了统一管理和防冗余。

constraint 可以附加到字段,getter 方法,类或者接口上面。对于一些特定的需求,用户可以很容易的开发定制化的 constraint。Bean Validation 是一个运行时的数据验证框架,在验证之后验证的错误信息会被马上返回。

理解:类似校验工具类,且使用场景更广泛,使用更方便。无需冗余的业务校验,且可以统一规范。

三.  类似技术 以及区别与联系

Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现,除此之外还有一些附加的 constraint。

四. 技术要点

Bean Validation 的种类

(1) Bean Validation 中内置的 constraint

Constraint详细信息

@Null被注释的元素必须为 null

@NotNull被注释的元素必须不为 null

@AssertTrue被注释的元素必须为 true

@AssertFalse被注释的元素必须为 false

@Min(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值

@Max(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值

@DecimalMin(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值

@DecimalMax(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值

@Size(max, min)被注释的元素的大小必须在指定的范围内

@Digits (integer, fraction)被注释的元素必须是一个数字,其值必须在可接受的范围内

@Past被注释的元素必须是一个过去的日期

@Future被注释的元素必须是一个将来的日期

@Pattern(value)被注释的元素必须符合指定的正则表达式

(2) Hibernate Validator 附加的 constraint

Constraint详细信息

@Email被注释的元素必须是电子邮箱地址

@Length被注释的字符串的大小必须在指定的范围内

@NotEmpty被注释的字符串的必须非空

@Range被注释的元素必须在合适的范围内

五. 使用思路:

(1)一个 constraint 通常由 annotation 和相应的 constraint validator 组成,它们是一对多的关系。也就是说可以有多个 constraint validator 对应一个 annotation。

(2)在运行时,Bean Validation 框架本身会根据被注释元素的类型来选择合适的 constraint validator 对数据进行验证。

(3)有些时候,在用户的应用中需要一些更复杂的 constraint。Bean Validation 提供扩展 constraint 的机制。可以通过两种方法去实现,一种是组合现有的 constraint 来生成一个更复杂的 constraint,另外一种是开发一个全新的 constraint。

理解:(1) 一个annotation可以由多个constraint validator 进行逻辑校验,以便丰富功能及功能的清晰。

(2)根据constraint validator的类型参数对应被注解元素的参数来进行验证。根据注解元素的类型来决定验证类。

六. 简单例子

组合现有constraint来生成一个负责的constraint

(1)组合的 constraint.,只需要开发注解,内部组合其他constraint即可

// @Max 和 @Min 都是内置的 constraint@Max(10000)//组合其他constraint进行校验@Min(8000)//组合其他constraint进行校验

@Constraint(validatedBy = {})//无validator进行校验

@Documented

@Target( { ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD })

@Retention(RetentionPolicy.RUNTIME)

public @interface Price {

String message() default "错误的价格";  //错误提示信息

Class[] groups() default {};

Class[] payload() default {};

}

(2) 调用组合constraint即可

public class Product {

// 必须非空

@NotEmpty

private String productName;

// 必须在 8000 至 10000 的范围内

// @Price 是一个定制化的 constraint@Priceprivate float price;

Getter 和 setter}

新开发的 constraint.,需要constraint和constraint validator

(1) 新开发constraint,同时,指向校验类

@Constraint(validatedBy = {StatusValidator.class})//指向校验类

@Documented

@Target( { ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD })

@Retention(RetentionPolicy.RUNTIME)

public @interface Status {

String message() default "不正确的状态 , 应该是 'created', 'paid', shipped', closed'其中之一";

Class[] groups() default {};

Class[] payload() default {};

}

(2)  开发 constraint validator类

public class StatusValidator implementsConstraintValidator{ //String是status注解的参数类型private final String[] ALL_STATUS = {"created", "paid", "shipped", "closed"};

public void initialize(Status status) {

}

public boolean isValid(String value, ConstraintValidatorContext context) {//value为注解参数的实际值

if(Arrays.asList(ALL_STATUS).contains(value))

return true;

return false;

}

}

七. 使用 Bean Validation API进行校验

ValidatorFactory factory = Validation.buildDefaultValidatorFactory();

Validator validator = factory.getValidator();

Set> violations = validator.validate(order);

if(violations.size() == 0) {

session.setAttribute("order", null);

session.setAttribute("errorMsg", null);

resp.sendRedirect("creatSuccessful.jsp");


参考: https://www.ibm.com/developerworks/cn/java/j-lo-jsr303/

推荐阅读更多精彩内容