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/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容