如何自定义hibernate validation注解示例代码

2023-09-13 13:59:06 53

BeanValidation中内置的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(regex=,flag=)被注释的元素必须符合指定的正则表达式

HibernateValidator附加的constraint
@NotBlank(message=)验证字符串非null，且长度必须大于0
@Email被注释的元素必须是电子邮箱地址
@Length(min=,max=)被注释的字符串的大小必须在指定的范围内
@NotEmpty被注释的字符串的必须非空
@Range(min=,max=,message=)被注释的元素必须在合适的范围内

效果和优点

先看最后效果：

publicclassUserEntity{
@Password
privateStringpassword;
@Email
privateStringemail;
}

上面使用了两个自定义的注解来验证password和email，这样做的好处是：一处定义，处处使用，要修改验证规则时，也只要修改注解就可以了。而如果自定义，使用hibernate提供的标签的话：

@Pattern(regexp="...")
privateStringemail;

如果写了很多个类之后，突然要修改验证规则regexp，此时工作量将要大得多。

实现

首先，引入hibernatevalidation依赖，添加：




org.hibernate
hibernate-validator
5.2.2.Final

hibernatevalidation是JSR的参考实现，所以，用它做bean验证。

自定义一个验证注解分为三步：

创建注解（Createaconstraintannotation）
创建验证类（Implementavalidator）
定义默认错误信息（Defineadefaulterrormessage）

第一步，创建注解：

@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy={EmailValidator.class})
public@interfaceEmail{
Stringmessage()default"这不是有效的电子邮件格式";
/**
*@returntheregularexpressiontomatch
*/
Stringregexp()default"[a-zA-Z0-9._%+-]+@[a-zA-Z0-9]+\\.[a-zA-Z]{2,4}";
Class[]groups()default{};
Class[]payload()default{};
/**
*Definesseveral{@linkSize}annotationsonthesameelement.
*
*@seeSize
*/
@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER})
@Retention(RUNTIME)
@Documented
@interfaceList{

Email[]value();
}
}

通过@interface关键字来创建注解，而每一个方法就是注解的一个参数。比如上面的代码，就可以这样使用@Email(regexp="...",message="...")。其它可以不用去管，直接复制就可以了，要注意的是@Constraint(validatedBy={EmailValidator.class})，这里指定注解的验证类，根据实际替换类名。

第二步，创建验证类：

publicclassEmailValidatorimplementsConstraintValidator{
privateStringregexp;
@Override
publicvoidinitialize(EmailconstraintAnnotation){
this.regexp=constraintAnnotation.regexp();
}

@Override
publicbooleanisValid(Stringvalue,ConstraintValidatorContextcontext){
if(value==null){returntrue;}
if(value.matches(regexp)){
returntrue;
}
returnfalse;
}
}

这里只要实现ConstraintValidator接口就创建了一个验证器。initialize方法得到注解的regexp值，在isValid方法中进行验证，符合正则表达式就返回true，否则返回false。

需要注意的是，当value为空，也就是验证的对象没有初始化的时候，要编写相应的验证规则，不然会报错的。在上面代码中编写的是：

if(value==null){returntrue;}

也即是，当验证对象为空时，返回成功。

第三步是编写默认错误信息。其实这一步在第一步已经做了，通过default，所以这步不用做。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对毛票票的支持。

如何自定义hibernate validation注解示例代码

热门推荐

随机推荐