好得很程序员自学网

<tfoot draggable='sEl'></tfoot>

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

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

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

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

代码示例

校验注解

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

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" ;

}

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

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

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 ;

   }

}

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

原文链接:https://blog.csdn.net/cccmercy/article/details/79105624

查看更多关于Hibernate Validation自定义注解校验的实现的详细内容...

  阅读:27次