springboot：validator之自定义注解校验

电玩女神 2024-03-31 15:09 146阅读 0赞

文章目录

  • springboot：validator之自定义注解校验
    • 一、依赖
    • 二、自定义注解
      • 1、校验字符串类型的枚举类
      • 2、校验数字类型的枚举类
      • 3、校验不为必填的字符串
      • 4、校验不为必填的数字
      • 5、校验Integer 类型的集合

springboot：validator之自定义注解校验

validator的基本使用请查看文章：SpringBoot：参数校验的使用（validator）

一、依赖

  1. <dependency>
  2.             <groupId>javax.validation</groupId>
  3.             <artifactId>validation-api</artifactId>
  4.             <version>2.0.1.Final</version>
  5.         </dependency>
  6.         <dependency>
  7.             <groupId>org.hibernate.validator</groupId>
  8.             <artifactId>hibernate-validator</artifactId>
  9.             <version>6.0.16.Final</version>
  10.             <scope>compile</scope>
  11.         </dependency>

二、自定义注解

1、校验字符串类型的枚举类

加入到需要校验的字段上

  1. /**
  2.      *     信号属性(AI,DI,Other,DO)
  3.      *     AI:普通数据
  4.      *     DI:输入开关
  5.      *     DO:输出开关
  6.      */
  7.     @NotBlank(message = "信号属性不可以为空")
  8.     @ContainsDataValid(message = "信号属性不正确",values = {
  9.     "AI","DI","Other","DO"})
  10.     private String propertyType;

自定义注解

  1. package com.mye.cloudboxdcim.framework.engine.validator.anno;
  3. import com.mye.cloudboxdcim.framework.engine.validator.method.ContainsDataValidator;
  5. import javax.validation.Constraint;
  6. import javax.validation.Payload;
  7. import java.lang.annotation.Documented;
  8. import java.lang.annotation.Retention;
  9. import java.lang.annotation.Target;
  11. import static java.lang.annotation.ElementType.*;
  12. import static java.lang.annotation.RetentionPolicy.RUNTIME;
  14. /**
  15.  * @ClassName ContainsValidata
  16.  * @Description 自定义注解，判断枚举是否包含
  17.  * @Author hl
  18.  * @Date 2022/11/3 15:52
  19.  * @Version 1.0
  20.  */
  21. @Target({
  22.     METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
  23. @Retention(RUNTIME)
  24. @Documented
  25. @Constraint(validatedBy = {
  26.     ContainsDataValidator.class})// 标明由哪个类执行校验逻辑
  27. public @interface ContainsDataValid {
  30.     // 校验出错时默认返回的消息
  31.     String message() default "字段值不正确";
  33.     Class<?>[] groups() default {
  34.      };
  36.     Class<? extends Payload>[] payload() default {
  37.      };
  39.     String[] values() default {
  40.     }; // 指定值
  42.     /**
  43.      * 同一个元素上指定多个该注解时使用
  44.      */
  45.     @Target({
  46.      METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
  47.     @Retention(RUNTIME)
  48.     @Documented
  49.     public @interface List {
  51.         ContainsDataValid[] value();
  52.     }
  54. }

具体实现类

  1. package com.mye.cloudboxdcim.framework.engine.validator.method;
  3. import cn.hutool.core.util.StrUtil;
  4. import com.mye.cloudboxdcim.framework.engine.validator.anno.ContainsDataValid;
  6. import javax.validation.ConstraintValidator;
  7. import javax.validation.ConstraintValidatorContext;
  8. import java.util.ArrayList;
  9. import java.util.Arrays;
  10. import java.util.List;
  11. import java.util.stream.Collectors;
  13. public class ContainsDataValidator implements ConstraintValidator<ContainsDataValid,String> {
  15.     // 全局变量存放值集合
  16.     private List<String> values = new ArrayList<>();
  18.     // 注解初始化时执行
  19.     @Override
  20.     public void initialize(ContainsDataValid constraintAnnotation) {
  22.         // 获取注解中的值
  23.         String[] strList = constraintAnnotation.values();
  24.         // 赋值给全局变量
  25.         values = Arrays.stream(strList).collect(Collectors.toList());
  26.     }
  28.     // 自定义的校验规则
  29.     @Override
  30.     public boolean isValid(String o, ConstraintValidatorContext constraintValidatorContext) {
  32.         // o 为实体属性的值
  33.         // 判断值是否属于集合中的元素，true 检验通过，false校验不通过
  34.         if (StrUtil.isBlank(o)){
  36.             return true;
  37.         }
  38.         return values.contains(o.trim());
  39.     }
  40. }

2、校验数字类型的枚举类

加入到需要校验的字段上

  1. /**
  2.      * 优先级(最高2,高1,中0 -1低,-2最低)
  3.      */
  4.     @NotNull(message = "优先级不能为空")
  5.     @ContainsIntegerDataValid(message = "优先级不合法",values = {
  6.     -2,-1,0,1,2})
  7.     private Integer priority;

自定义注解

  1. package com.mye.cloudboxdcim.framework.engine.validator.anno;
  3. import com.mye.cloudboxdcim.framework.engine.validator.method.ContainsIntegerDataValidator;
  4. import javax.validation.Constraint;
  5. import javax.validation.Payload;
  6. import java.lang.annotation.Documented;
  7. import java.lang.annotation.Retention;
  8. import java.lang.annotation.Target;
  9. import static java.lang.annotation.ElementType.*;
  10. import static java.lang.annotation.ElementType.TYPE_USE;
  11. import static java.lang.annotation.RetentionPolicy.RUNTIME;
  13. /**
  14.  * @ClassName ContainsIntegerDataValid
  15.  * @Description 校验数字类型的枚举类
  16.  * @Author hl
  17.  * @Date 2022/11/7 16:58
  18.  * @Version 1.0
  19.  */
  20. @Target({
  21.     METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
  22. @Retention(RUNTIME)
  23. @Documented
  24. @Constraint(validatedBy = {
  25.     ContainsIntegerDataValidator.class})// 标明由哪个类执行校验逻辑
  26. public @interface ContainsIntegerDataValid {
  29.     // 校验出错时默认返回的消息
  30.     String message() default "字段值不正确";
  32.     Class<?>[] groups() default {
  33.      };
  35.     Class<? extends Payload>[] payload() default {
  36.      };
  38.     int[] values() default {
  39.     }; // 指定值
  41.     /**
  42.      * 同一个元素上指定多个该注解时使用
  43.      */
  44.     @Target({
  45.      METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
  46.     @Retention(RUNTIME)
  47.     @Documented
  48.     public @interface List {
  50.         ContainsIntegerDataValid[] value();
  51.     }
  52. }

具体实现类

  1. package com.mye.cloudboxdcim.framework.engine.validator.method;
  4. import cn.hutool.core.util.ObjectUtil;
  5. import com.mye.cloudboxdcim.framework.engine.validator.anno.ContainsIntegerDataValid;
  7. import javax.validation.ConstraintValidator;
  8. import javax.validation.ConstraintValidatorContext;
  9. import java.util.ArrayList;
  10. import java.util.Arrays;
  11. import java.util.List;
  12. import java.util.stream.Collectors;
  14. /**
  15.  * @ClassName ContainsIntegerDataValidator
  16.  * @Description 自定义校验类
  17.  * @Author hl
  18.  * @Date 2022/11/7 16:59
  19.  * @Version 1.0
  20.  */
  21. public class ContainsIntegerDataValidator implements ConstraintValidator<ContainsIntegerDataValid,Integer> {
  24.     private List<Integer> list = new ArrayList<>();
  26.     @Override
  27.     public void initialize(ContainsIntegerDataValid constraintAnnotation) {
  29.         // 获取注解中的值
  30.         int[] values= constraintAnnotation.values();
  31.         // 赋值给全局变量
  32.         list = Arrays.stream(values).boxed().collect(Collectors.toList());
  33.     }
  35.     @Override
  36.     public boolean isValid(Integer s, ConstraintValidatorContext constraintValidatorContext) {
  38.         if (ObjectUtil.isNull(s)){
  40.             return true;
  41.         }
  42.         return list.contains(s);
  43.     }
  44. }

3、校验不为必填的字符串

加入到需要校验的字段上

  1. /**
  2.      *     描述信息
  3.      */
  4.     @HaveNoBlankValid(message = "描述长度最大为200",value = "description")
  5.     private String description;

自定义注解

  1. package com.mye.cloudboxdcim.framework.engine.validator.anno;
  3. import com.mye.cloudboxdcim.framework.engine.validator.method.HaveNoBlankValidator;
  5. import javax.validation.Constraint;
  6. import javax.validation.Payload;
  7. import javax.validation.constraints.NotBlank;
  8. import java.lang.annotation.Documented;
  9. import java.lang.annotation.Retention;
  10. import java.lang.annotation.Target;
  12. import static java.lang.annotation.ElementType.*;
  13. import static java.lang.annotation.RetentionPolicy.RUNTIME;
  15. /**
  16.  * @ClassName HaveNoNullValid
  17.  * @Description 自定义注解校验 String 类型的值
  18.  * @Author hl
  19.  * @Date 2022/11/7 14:39
  20.  * @Version 1.0
  21.  */
  22. @Target({
  23.     METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
  24. @Retention(RUNTIME)
  25. @Documented
  26. @Constraint(validatedBy = {
  27.     HaveNoBlankValidator.class})// 标明由哪个类执行校验逻辑
  28. public @interface HaveNoBlankValid {
  31.     // 校验出错时默认返回的消息
  32.     String message() default "字符串不合法";
  34.     Class<?>[] groups() default {
  35.      };
  37.     Class<? extends Payload>[] payload() default {
  38.      };
  40.     String value() default ""; // 指定值
  42.     /**
  43.      * 同一个元素上指定多个该注解时使用
  44.      */
  45.     @Target({
  46.      METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
  47.     @Retention(RUNTIME)
  48.     @Documented
  49.     public @interface List {
  51.         NotBlank[] value();
  52.     }
  53. }

具体实现类

  1. package com.mye.cloudboxdcim.framework.engine.validator.method;
  3. import cn.hutool.core.util.StrUtil;
  4. import com.mye.cloudboxdcim.framework.engine.validator.anno.HaveNoBlankValid;
  5. import com.mye.cloudboxdcim.util.StringUtil;
  7. import javax.validation.ConstraintValidator;
  8. import javax.validation.ConstraintValidatorContext;
  9. import java.util.HashMap;
  10. import java.util.Map;
  13. public class HaveNoBlankValidator implements ConstraintValidator<HaveNoBlankValid, String> {
  16.     private String initValue = "";
  18.     /**
  19.        * @MethodName initialize
  20.        * @Description  注解初始化时执行
  21.        * @param haveNoBlankValid  自定义注解
  22.        * @Author hl
  23.        * @Date 17:05 17:05
  24.        */
  25.     @Override
  26.     public void initialize(HaveNoBlankValid haveNoBlankValid) {
  28.         // 获取注解中的值
  29.         initValue = haveNoBlankValid.value();
  30.     }
  32.     /**
  33.        * @MethodName isValid
  34.        * @Description  自定义校验规则
  35.        * @param value 具体值
  36.        * @param context
  37.        * @return: boolean true 通过校验 false 没有通过校验
  38.        * @Author hl
  39.        * @Date 17:04 17:04
  40.        */
  41.     @Override
  42.     public boolean isValid(String value, ConstraintValidatorContext context) {
  44.         // null 不做检验
  45.         if (StrUtil.isBlank(value)) {
  47.             //true 通过校验
  48.             return true;
  49.         }
  51.         if (StrUtil.isNotBlank(initValue)){
  53.             switch (initValue) {
  55.                 case "description":
  56.                     //检查描述长度
  57.                     return checkDescription(value);
  58.                 case "unit":
  59.                     //检查信号单位长度
  60.                     return checkUnit(value);
  61.                 case "enumConstant":
  62.                     //检查信号枚举值
  63.                     return checkEnumConstant(value);
  64.                 case "place":
  65.                     return checkCloudBoxPlace(value);
  66.             }
  67.         }
  69.         return true;
  70.     }
  72.     private boolean checkCloudBoxPlace(String value) {
  74.         return value.length() <= 50;
  75.     }
  77.     /**
  78.        * @MethodName checkEnumConstant
  79.        * @Description  检查信号枚举值
  80.        * @param value 具体值
  81.        * @return: boolean
  82.        * @Author hl
  83.        * @Date 17:31 17:31
  84.        */
  85.     private boolean checkEnumConstant(String value) {
  87.         String[] enumConstants = value.split(",");
  88.         if (enumConstants.length < 1 ) {
  90.             return false;
  91.         }
  92.         Map<Integer, String> hashMap = new HashMap<>();
  93.         for (String data : enumConstants) {
  95.             if (!data.contains(":")) {
  97.                 return false;
  98.             }
  99.             String[] map = data.split(":");
  100.             if (map.length != 2) {
  102.                 return false;
  103.             }
  104.             try {
  106.                 Integer key = Integer.valueOf(map[0]);
  107.                 if (hashMap.containsKey(key)) {
  109.                     return false;
  110.                 }
  111.                 hashMap.put(key, map[1]);
  112.             } catch (Exception e) {
  114.                 return false;
  115.             }
  116.             if (StringUtil.isBlank(map[1])) {
  118.                 return false;
  119.             }
  120.         }
  121.         return true;
  122.     }
  124.     /**
  125.        * @MethodName checkUnit
  126.        * @Description  检查单位长度
  127.        * @param value 具体值
  128.        * @return: boolean
  129.        * @Author hl
  130.        * @Date 17:09 17:09
  131.        */
  132.     private boolean checkUnit(String value) {
  134.         return value.length() <= 10;
  135.     }
  137.     /**
  138.        * @MethodName checkDescription
  139.        * @Description  检查描述长度
  140.        * @param value 具体值
  141.        * @return: java.lang.Boolean
  142.        * @Author hl
  143.        * @Date 16:51 16:51
  144.        */
  145.     private Boolean checkDescription(String value) {
  147.         return value.length() <= 200;
  148.     }
  149. }

4、校验不为必填的数字

加入到需要校验的字段上

  1. /**
  2.      * 闪断周期（单位秒）
  3.      */
  4.     @HaveNoNullValid(message = "闪断周期是 1~3600",value = "period")
  5.     private Integer flashPeriod;

自定义注解

  1. package com.mye.cloudboxdcim.framework.engine.validator.anno;
  3. import com.mye.cloudboxdcim.framework.engine.validator.method.HaveNoNullValidator;
  5. import javax.validation.Constraint;
  6. import javax.validation.Payload;
  7. import javax.validation.constraints.NotBlank;
  8. import javax.validation.constraints.NotNull;
  9. import java.lang.annotation.Documented;
  10. import java.lang.annotation.Retention;
  11. import java.lang.annotation.Target;
  13. import static java.lang.annotation.ElementType.*;
  14. import static java.lang.annotation.RetentionPolicy.RUNTIME;
  16. /**
  17.  * @ClassName HaveNoNullValid
  18.  * @Description 自定义注解校验 Integer 类型的值
  19.  * @Author hl
  20.  * @Date 2022/11/7 14:39
  21.  * @Version 1.0
  22.  */
  23. @Target({
  24.     METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
  25. @Retention(RUNTIME)
  26. @Documented
  27. @Constraint(validatedBy = {
  28.     HaveNoNullValidator.class})// 标明由哪个类执行校验逻辑
  29. public @interface HaveNoNullValid {
  32.     // 校验出错时默认返回的消息
  33.     String message() default "数据不合法";
  35.     Class<?>[] groups() default {
  36.      };
  38.     Class<? extends Payload>[] payload() default {
  39.      };
  41.     String value() default ""; // 指定值
  43.     /**
  44.      * 同一个元素上指定多个该注解时使用
  45.      */
  46.     @Target({
  47.      METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
  48.     @Retention(RUNTIME)
  49.     @Documented
  50.     public @interface List {
  52.         NotNull value();
  53.     }
  54. }

具体实现类

  1. package com.mye.cloudboxdcim.framework.engine.validator.method;
  4. import cn.hutool.core.util.ObjectUtil;
  5. import cn.hutool.core.util.StrUtil;
  6. import com.mye.cloudboxdcim.framework.engine.validator.anno.HaveNoNullValid;
  8. import javax.validation.ConstraintValidator;
  9. import javax.validation.ConstraintValidatorContext;
  11. /**
  12.  * @ClassName HaveNoNullValidator
  13.  * @Description 实现注解 HaveNoNullValid 的具体实现逻辑
  14.  * @Author hl
  15.  * @Date 2022/11/7 14:41
  16.  * @Version 1.0
  17.  */
  18. public class HaveNoNullValidator implements ConstraintValidator<HaveNoNullValid, Integer> {
  21.     private String initValue = "";
  23.     @Override
  24.     public void initialize(HaveNoNullValid haveNoNullValid) {
  26.         // 获取注解中的值
  27.         initValue = haveNoNullValid.value();
  28.     }
  30.     @Override
  31.     public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
  33.         // null 不做检验
  34.         if (ObjectUtil.isNull(value)) {
  36.             //true 通过校验
  37.             return true;
  38.         }
  40.         if (StrUtil.isNotBlank(initValue)){
  42.             switch (initValue) {
  44.                 case "state":
  45.                     return checkFlashState(value);
  46.                 case "period":
  47.                     return checkPeriod(value);
  48.             }
  49.         }
  51.         return true;
  52.     }
  54.     private boolean checkPeriod(Integer value) {
  56.         return value >= 1 && value <= 3600;
  57.     }
  59.     private boolean checkFlashState(Integer value) {
  61.         return value == 0 || value == 1;
  62.     }
  63. }

5、校验Integer 类型的集合

加入到需要校验的字段上

  1. /**
  2.      * 告警级别（默认0提示,1次要,2重要,3紧急）
  3.      */
  4.     @NotEmpty(message = "告警级别集合不能为空")
  5.     @VerifyIntegerCollectionDataValid(message = "告警级别不合法",values = {
  6.     0,1,2,3})
  7.     private List<Integer> levelList;

自定义注解

  1. package com.mye.cloudboxdcim.framework.engine.validator.anno;
  3. import com.mye.cloudboxdcim.framework.engine.validator.method.VerifyIntegerCollectionDataValidator;
  4. import javax.validation.Constraint;
  5. import javax.validation.Payload;
  6. import java.lang.annotation.Documented;
  7. import java.lang.annotation.Retention;
  8. import java.lang.annotation.Target;
  10. import static java.lang.annotation.ElementType.*;
  11. import static java.lang.annotation.RetentionPolicy.RUNTIME;
  13. /**
  14.  * @ClassName VerifyCollectionDataValid
  15.  * @Description 自定义注解校验 Integer 类型的集合数据是否合法
  16.  * @Author hl
  17.  * @Date 2022/11/8 10:25
  18.  * @Version 1.0
  19.  */
  20. @Target({
  21.     METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
  22. @Retention(RUNTIME)
  23. @Documented
  24. @Constraint(validatedBy = {
  25.     VerifyIntegerCollectionDataValidator.class})// 标明由哪个类执行校验逻辑
  26. public @interface VerifyIntegerCollectionDataValid {
  29.     // 校验出错时默认返回的消息
  30.     String message() default "字段值不正确";
  32.     Class<?>[] groups() default {
  33.      };
  35.     Class<? extends Payload>[] payload() default {
  36.      };
  38.     int[] values() default {
  39.     }; // 指定值
  41.     /**
  42.      * 同一个元素上指定多个该注解时使用
  43.      */
  44.     @Target({
  45.      METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
  46.     @Retention(RUNTIME)
  47.     @Documented
  48.     public @interface List {
  50.         VerifyIntegerCollectionDataValid[] value();
  51.     }
  52. }

具体实现类

  1. package com.mye.cloudboxdcim.framework.engine.validator.method;
  3. import cn.hutool.core.util.ObjectUtil;
  4. import com.mye.cloudboxdcim.framework.engine.validator.anno.ContainsIntegerDataValid;
  5. import com.mye.cloudboxdcim.framework.engine.validator.anno.VerifyIntegerCollectionDataValid;
  7. import javax.validation.ConstraintValidator;
  8. import javax.validation.ConstraintValidatorContext;
  9. import java.util.ArrayList;
  10. import java.util.Arrays;
  11. import java.util.List;
  12. import java.util.Objects;
  13. import java.util.stream.Collectors;
  15. /**
  16.  * @ClassName VerifyIntegerCollectionDataValidator
  17.  * @Description 自定义校验类，校验List<Integer> 数据是否合法
  18.  * @Author hl
  19.  * @Date 2022/11/8 10:27
  20.  * @Version 1.0
  21.  */
  22. public class VerifyIntegerCollectionDataValidator implements ConstraintValidator<VerifyIntegerCollectionDataValid, List<Integer>> {
  25.     private List<Integer> list = new ArrayList<>();
  27.     @Override
  28.     public void initialize(VerifyIntegerCollectionDataValid verifyIntegerCollectionDataValid) {
  30.         // 获取注解中的值
  31.         int[] values= verifyIntegerCollectionDataValid.values();
  32.         // 赋值给全局变量
  33.         list = Arrays.stream(values).boxed().collect(Collectors.toList());
  34.     }
  36.     @Override
  37.     public boolean isValid(List<Integer> integers, ConstraintValidatorContext constraintValidatorContext) {
  39.         if (ObjectUtil.isNull(integers)){
  41.             return true;
  42.         }
  44.         Integer level = integers.stream().filter(Objects::nonNull).filter(s -> !list.contains(s)).findAny().orElse(null);
  45.         return ObjectUtil.isNull(level);
  46.     }
  47. }

发表评论

表情：
评论列表 （有 0 条评论，146人围观）

还没有评论，来说两句吧...

相关阅读

    相关 自定义校验注解框架

    自定义校验注解框架 经过[上一篇文章][Link 1]的学习大家对校验注解有了初步认识，如果没有了解[上一篇文章][Link 1]或对注解了解不深的小朋友请`认真`学习！

    水深无声水深无声/ 0 赞/ 84 阅读

    相关 java自定义校验注解

    随着业务的日趋复杂。我们对客户端传来的参数校验也越来越多。这么多的校验如果都写在业务逻辑中，业务代码看起来会很乱。 找时间学习了一下java的注解。特在此记录一下学习过程。

    ゞ 浴缸里的玫瑰ゞ 浴缸里的玫瑰/ 0 赞/ 766 阅读

    相关 JSR303自定义校验注解

     一 点睛 1 编写一个自定校验注解 2 编写一个自定义的校验器 3 关联自定义校验器和自定义的校验注解 二 实战 1 导入依赖 <!-- 自定义校

    怼烎@怼烎@/ 0 赞/ 601 阅读