Hibernate Validation自定义注解校验的实现

 更新时间:2019年04月16日 09:11:20   作者:xcmercy  
这篇文章主要介绍了Hibernate Validation自定义注解校验的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

情景:需要对String类型的属性比如description进行验证,验证规则是当description为空时不进行正则校验,description不为空时进行正则校验。上述需求Hibernate Validation没有可用于上述需求的注解,故自定义一个注解并自定义校验规则。

自定义注解进行校验的步骤

  • 写一个校验注解,在注解中指定校验器类,校验注解与校验器一般一一对应。
  • 写一个校验器类并在校验器类中写校验逻辑,校验器必须实现ConstraintValidator<?, ?>接口,第一个参数是对应的注解,第二个参数是要校验的属性的类型

代码示例

校验注解

package com.kunlun.validation.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

import com.kunlun.validation.validator.KlPatternValidator;

/**
 * 自定义的校验注解
 * 规则:
 * 1.如果字符串为空串或者为null,则不进行正则校验
 * 2.如果字符串不为空串,则必须进行正则校验
 * @author xc
 * @date 2018年1月19日上午11:38:02
 */
@Documented
// 指定该注解可以使用的地方
@Target(value= {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
// 指定实际进行校验的校验器,该校验器是自己写的且必须实现ConstraintValidator接口
@Constraint(validatedBy=KlPatternValidator.class)
public @interface KlPattern {
  /*
   * 用于验证的注解下列这三个方法必须要,这是Hibernate Validation框架要求的,否则程序再在调用的时候会报错
   * default用于对属性给定默认值
   * 如果不给定默认值,则在使用注解的时候必须给属性指定属性值,否则报错
   * 给定默认值时,在使用注解的时候可以不用指定属性值
   */
  String message() default "不符合正则!";

  Class<?>[] groups() default {};

  Class<? extends Payload>[] payload() default {};

  // 没加default给定默认值,使用注解的时候该属性必须赋值,否则报错
  String regex();
  // value属性,加上了default "mercy" 使得该属性在使用注解的时候可以不用输入也不会报错
  String value() default "mercy";
}

与上面校验注解对应的校验器类

package com.kunlun.validation.validator;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import com.kunlun.validation.annotation.KlPattern;

/**
 * KlPatternValidator是KlPattern注解实际调用的验证器
 * 在KlPatternValidator中完成校验逻辑
 * 
 * @author xc
 * @date 2018年1月19日上午11:44:38
 */
public class KlPatternValidator implements ConstraintValidator<KlPattern, String> {

  private String regex;

  /**
   * 通过initialize()可以获取注解里的属性值
   */
  @Override
  public void initialize(KlPattern constraintAnnotation) {
    ConstraintValidator.super.initialize(constraintAnnotation);
    regex = constraintAnnotation.regex();
  }

  /**
   * 实际验证逻辑
   * 返回值为true表示验证通过,
   * 返回值为false表示验证未通过
   */
  @Override
  public boolean isValid(String s, ConstraintValidatorContext ctx) {

    // 当前前端传过来的请求参数是空串,或者没传的时候,不进行后续正则校验
    if ("".equals(s) || s == null) {
      return true;
    }

    // 进行正则校验
    if(s.matches(regex)) {
      return true;
    }

    return false;
  }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • java使用Validation进行数据校验的方式总结

    java使用Validation进行数据校验的方式总结

    在Java中提供了一系列的校验方式,下面这篇文章主要给大家介绍了关于java使用Validation进行数据校验的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-06-06
  • SpringBoot集成drools的实现示例

    SpringBoot集成drools的实现示例

    本文主要介绍了SpringBoot集成drools的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-05-05
  • 浅谈JSP与Servlet传值及对比(总结)

    浅谈JSP与Servlet传值及对比(总结)

    下面小编就为大家带来一篇浅谈JSP与Servlet传值及对比(总结)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • 基于Java写minio客户端实现上传下载文件

    基于Java写minio客户端实现上传下载文件

    这篇文章主要介绍了基于Java写minio客户端实现上传下载文件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-05-05
  • Java上传文件FTP服务器代码实例

    Java上传文件FTP服务器代码实例

    这篇文章主要介绍了Java上传文件FTP服务器代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-12-12
  • Java File类的简单使用教程(创建、删除、遍历与判断是否存在等)

    Java File类的简单使用教程(创建、删除、遍历与判断是否存在等)

    这篇文章主要给大家介绍了关于Java File类的简单使用(创建、删除、遍历与判断是否存在等)的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • java文件的重命名与移动操作实例代码

    java文件的重命名与移动操作实例代码

    这篇文章主要介绍了java文件的重命名与移动操作实例代码,具有一定借鉴价值,需要的朋友可以参考下
    2017-12-12
  • Java 实现贪吃蛇游戏的示例

    Java 实现贪吃蛇游戏的示例

    这篇文章主要介绍了Java 如何实现贪吃蛇游戏,帮助大家更好的理解和学习使用Java,感兴趣的朋友可以了解下
    2021-03-03
  • JAVA中Object的常用方法

    JAVA中Object的常用方法

    JAVA中Object是所有对象的顶级父类,存在于java.lang包中,这个包不需要我们手动导包,本文通过实例代码介绍JAVA中Object的常用方法,感兴趣的朋友一起看看吧
    2023-11-11
  • 自定义对象作为HashMap的Key问题

    自定义对象作为HashMap的Key问题

    这篇文章主要介绍了自定义对象作为HashMap的Key问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01

最新评论