效果和优点
先看最后效果:
public class UserEntity {
@Password
private String password;
@Email
private String email;
}
上面使用了两个自定义的注解来验证password和email,这样做的好处是:一处定义,处处使用,要修改验证规则时,也只要修改注解就可以了。而如果自定义,使用hibernate提供的标签的话:
@Pattern(regexp="...")
private String email;
如果写了很多个类之后,突然要修改验证规则regexp,此时工作量将要大得多。
实现
首先,引入hibernate validation依赖,添加:
<!-- hibernate validator -->
<!-- hibernate 验证框架 -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.2.Final</version>
</dependency>
hibernate validation是JSR的参考实现,所以,用它做bean验证。
自定义一个验证注解分为三步:
- 创建注解(Create a constraint annotation)
- 创建验证类(Implement a validator)
-
定义默认错误信息(Define a default error message)
第一步,创建注解:
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = { EmailValidator.class })
public @interface Email {
String message() default "这不是有效的电子邮件格式";
/**
* @return the regular expression to match
*/
String regexp() default "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9]+\\.[a-zA-Z]{2,4}";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
/**
* Defines several {@link Size} annotations on the same element.
*
* @see Size
*/
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@interface List {
Email[] value();
}
}
通过@interface关键字来创建注解,而每一个方法就是注解的一个参数。比如上面的代码,就可以这样使用@Email(regexp="...",message="...")
。其它可以不用去管,直接复制就可以了,要注意的是@Constraint(validatedBy = { EmailValidator.class })
,这里指定注解的验证类,根据实际替换类名。
第二步,创建验证类:
public class EmailValidator implements ConstraintValidator<Email, String>{
private String regexp;
@Override
public void initialize(Email constraintAnnotation) {
this.regexp = constraintAnnotation.regexp();
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if(value==null){return true;}
if( value.matches(regexp)){
return true;
}
return false;
}
}
这里只要实现ConstraintValidator<Email, String>
接口就创建了一个验证器。initialize
方法得到注解的regexp值,在isValid
方法中进行验证,符合正则表达式就返回true,否则返回false。
需要注意的是,当value为空,也就是验证的对象没有初始化的时候,要编写相应的验证规则,不然会报错的。在上面代码中编写的是:
if(value==null){return true;}
也即是,当验证对象为空时,返回成功。
第三步是编写默认错误信息。其实这一步在第一步已经做了,通过default,所以这步不用做。
1、hibernate validation的文档说得更详细:
Creating a simple constraint.html
2、这篇博客及其下一篇讲得也挺好:
深入理解Java:注解(Annotation)自定义注解入门
3、常见错误:
HV000030: No validator could be found for type
原因一般是没有设置@Constraint(validatedBy = { EmailValidator.class })
HV000028: Unexpected exception during isValid call
原因一般是没有设置
if(value==null){return true;}
4、JSR文献:
JSR 303: Bean Validation
相关推荐
Hibernate Validator 是 Bean ... Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现,下面这篇文章主要给大家介绍了关于如何自定义hibernate validation注解的相关资料,需要的朋友可以参考下
文档列举了引用 Hibernate Validation各注解的用法,完成对实体约束验证的配置。
主要介绍了Hibernate Validation自定义注解校验的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
NULL 博文链接:https://gqsunrise.iteye.com/blog/2367006
Hibernate对Bean Validation规范的实现文档
约束注解定义的目标元素可以是字段、属性或者类型等; 可以在类或者接口上使用约束验证,它将对该类或实现该接口的实例进行状态验证; 字段和属性均可以使用约束验证,但是不能将相同的约束重复声明在字段和相关属性...
resin 支持spring mvc 5.0以上版本 支持Hibernate validation 下载使用即可版本为 resin-4.0.61
主要介绍了Java Validation Api如何实现自定义注解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
与springmvc4完美兼容的validation jar包集合,让程序员更加轻松的进行编程
springMVC整合hibernate的校验Validation, 简单明了。
主要介绍了JAVA中通过Hibernate-Validation进行参数验证,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
在使用jpa时,比如我使用hibernate作为实现,默认情况下如果classpath下有bean validation实现会自动开启JSR-303验证。其通过Listener实现,即可以在如insert、update之前执行验证,如果验证失败会直接抛出验证失败...
ssm框架validator应用jia包3个 hibernate-validator-5.0.1 jboss-logging-3.3.0 validation-api-1.0.0
里面含有hibernate-validator 进行校验的jar包,包括了基础hibernate-validator-5.0.0.CR2.jar hibernate-validator-annotation-processor-5.0.0.CR2.jar
2020年最新Spring Boot Validation讲透讲全,别找其他的了。包括了平时用到的所有用法以及代码实例。
springmvc,hibernate的校验框架validation所需要的jar包,hibernate-validator-5.0.0.CR2.jar
验证框架文档 博文链接:https://yaojialing.iteye.com/blog/723137
spring注解-validation所用到的jar包
jquery-validation 支持 自定义错误样式 ,包括如下 自定义错误样式 统一存放错误 定义 错误位置 定义 验证通过的样式 jquery validation- 错误样式概述 在 验证出现错误 后,jquery-validation会做如下操作 如果 ...