栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

validator自定义校验注解及使用

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

validator自定义校验注解及使用

validator自定义校验注解及使用

官方文档:https://docs.jboss.org/hibernate/validator/8.0/reference/en-US/html_single/#validator-customconstraints

用到依赖:



    org.hibernate.validator
    hibernate-validator
    8.0.0.Alpha3


    cn.hutool
    hutool-all
    5.3.1


可以分为四种使用方式: 1简单自定义注解约束: 校验手机号注解
@Target({ FIELD, METHOD, PARAMETER, ANNOTATION_TYPE, TYPE_USE })
@Retention(RUNTIME)
@Constraint(validatedBy = CheckPhoneValidator.class)
@Documented
@Repeatable(List.class)
public @interface CheckPhone {

    
    String message() default "默认的提示!!";

    
    Class[] groups() default { };

    
    Class[] payload() default { };

    
    PhoneModeEnum value();

    @Target({ FIELD, METHOD, PARAMETER, ANNOTATION_TYPE })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        CheckPhone[] value();
    }
}
调用校验手机号逻辑

public class CheckPhoneValidator implements ConstraintValidator {

    private PhoneModeEnum phoneMode;

    
    @Override
    public void initialize(CheckPhone constraintAnnotation) {
        this.phoneMode = constraintAnnotation.value();
    }

    
    @Override
    public boolean isValid(String mobile, ConstraintValidatorContext constraintContext) {
       if (ObjectUtil.isNull(mobile)) {
            return true;
        }
        if (ObjectUtil.equal(phoneMode ,PhoneModeEnum.IS_MOBILE_HK)) {
            return PhoneUtil.isMobileHk(mobile);
        } else if ((ObjectUtil.equal(phoneMode ,PhoneModeEnum.IS_MOBILE_TW))){
            return PhoneUtil.isMobileTw(mobile);
        } else if ((ObjectUtil.equal(phoneMode ,PhoneModeEnum.IS_MOBILE_MO))){
            return PhoneUtil.isMobileMo(mobile);
        } else if ((ObjectUtil.equal(phoneMode ,PhoneModeEnum.IS_MOBILE))){
            return PhoneUtil.isMobile(mobile);
        } else {
            return PhoneUtil.isPhone(mobile);
        }

    }
}
指定使用什么逻辑校验手机号

public enum PhoneModeEnum {
    
    IS_MOBILE_HK,
    
    IS_MOBILE_TW,
    
    IS_MOBILE_MO,
    
    IS_MOBILE,
    
    IS_PHONE;
}
手机号校验逻辑


public class PhoneUtil {

    
    public final static Pattern MOBILE = Pattern.compile("(?:0|86|\+86)?1[3456789]\d{9}");

    
    public final static Pattern MOBILE_HK = Pattern.compile("(?:0|852|\+852)?\d{8}");

    
    public final static Pattern MOBILE_TW = Pattern.compile("(?:0|886|\+886)?(?:|-)09\d{8}");

    
    public final static Pattern MOBILE_MO = Pattern.compile("(?:0|853|\+853)?(?:|-)6\d{7}");

    
    public static boolean isMobile(CharSequence value) {
        return isMatchRegex(MOBILE, value);
    }

    
    public static boolean isMobileHk(CharSequence value) {
        return isMatchRegex(MOBILE_HK, value);
    }

    
    public static boolean isMobileTw(CharSequence value) {
        return isMatchRegex(MOBILE_TW, value);
    }

    
    public static boolean isMobileMo(CharSequence value) {
        return isMatchRegex(MOBILE_MO, value);
    }

    
    public static boolean isPhone(CharSequence value) {
        return isMobile(value) || isMobileHk(value) || isMobileTw(value) || isMobileMo(value);
    }


    
    public static boolean isMatchRegex(Pattern pattern, CharSequence value) {
        return isMatch(pattern, value);
    }

    
    public static boolean isMatch(Pattern pattern, CharSequence content) {
        if (content == null || pattern == null) {
            // 提供null的字符串为不匹配
            return false;
        }
        return pattern.matcher(content).matches();
    }
}
使用案例
public class UserInfo  implements Serializable {
    
    @CheckPhone(value = PhoneModeEnum.IS_PHONE,message = "${validatedValue}"+"手机号码格式异常!")
    private String mobile;

}
使用main方法测试校验

@Slf4j
public class TestValidationPhone {
    public static void main(String[] args) {

        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        UserInfo userInfo = new UserInfo();
        userInfo.setMobile("123123");
        Set> checkInfo = validator.validate(userInfo);
	    System.out.println(checkInfo);
    }

}

返回参数如下 使用postman测试校验
@Slf4j
@RestController
@RequestMapping("/demo")
public class TestValidationController {
    
    @PostMapping("/test/phone")
    public void TestValidationPhone (@Valid @RequestBody UserInfo userInfo){
        return;
    }

}

postman校验返回请求参数和返回参数 2简单自定义类注解约束:(作用到类上面的注解) 校验汽车超载的注解:
@Target({ TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = { ValidPassengerCountValidator.class })
@Documented
public @interface ValidPassengerCount {

    
    String message() default "默认提醒信息";

    
    Class[] groups() default { };

    
    Class[] payload() default { };
}
校验逻辑:
public class ValidPassengerCountValidator implements ConstraintValidator {

    @Override
    public void initialize(ValidPassengerCount constraintAnnotation) {
    }

    @Override
    public boolean isValid(Car car, ConstraintValidatorContext context) {
        if (car == null) {
            return true;
        }

        return car.getPassengers().size() <= car.getSeatCount();
    }
}
乘客类
public class Person {

   private String name;

   public Person(String name) {
      this.name = name;
   }

}
汽车类:
@ValidPassengerCount(message = "乘客数不得超过座位数.")
public class Car {

    private int seatCount;

    private List passengers;

    public Car(int seatCount, List passengers) {
        this.seatCount = seatCount;
        this.passengers = passengers;
    }

    public int getSeatCount() {
        return seatCount;
    }

    public List getPassengers() {
        return passengers;
    }
}

main方法测试类:

@Slf4j
public class TestValidationCar {
    public static void main(String[] args) {

        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        Person person1 = new Person("小明");
        Person person2 = new Person("小红");
        Person person3 = new Person("小李");
        Person person4 = new Person("小王");
        Person person5 = new Person("小爱");
        ArrayList people = new ArrayList<>();
        people.add(person1);
        people.add(person2);
        people.add(person3);
        people.add(person4);
        people.add(person5);
        Car car = new Car(4,people);
        Set> validate = validator.validate(car);

        System.out.println(validate);

    }

}
3跨参数约束:

跨参数约束适用于方法的参数数组或构造函数,可用于表达依赖于多个参数值的验证逻辑。

校验两个时间字段是否第一个时间是在后一个时间之前的注解:

@Constraint(validatedBy = ConsistentDateParametersValidator.class)
@Target({ METHOD, CONSTRUCTOR, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Documented
public @interface ConsistentDateParameters {

    String message() default "多参数校验!!!";

    Class[] groups() default { };

    Class[] payload() default { };
}

@SupportedValidationTarget(ValidationTarget.PARAMETERS)
public class ConsistentDateParametersValidator implements ConstraintValidator {

    @Override
    public void initialize(ConsistentDateParameters constraintAnnotation) {
    }

    @Override
    public boolean isValid(Object[] value, ConstraintValidatorContext context) {
        if (value.length != 2) {
            throw new IllegalArgumentException("Illegal method signature");
        }

        //leave null-checking to @NotNull on individual parameters
        if (value[0] == null || value[1] == null) {
            return true;
        }

        if (!(value[0] instanceof Date) || !(value[1] instanceof Date)) {
            throw new IllegalArgumentException(
                    "Illegal method signature, expected two " +
                            "parameters of type Date."
            );
        }

        return ((Date) value[0]).before((Date) value[1]);
    }
}
多参数校验main方法
public class TestValidationParams {
    public static void main(String[] args) {

        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
     	//使用多参数校验的类
        ExecutableValidator executableValidator = factory.getValidator().forExecutables();

        CalendarService object = new CalendarService();
        Method method = null;
        try {
            method = CalendarService.class.getMethod( "createCalendarEvent", Date.class, Date.class );
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }
        Calendar start = Calendar.getInstance();
        start.set( 2013, 5, 10 );
        Calendar end = Calendar.getInstance();
        end.set( 2013, 5, 9 );
        Object[] parameterValues = new Object[] { start.getTime(), end.getTime() };

        Set> constraintViolations = executableValidator.validateParameters(object, method, parameterValues);
        System.out.println(constraintViolations);
    }

    private static class CalendarService {

        @ConsistentDateParameters(message = "开始时间比结束时间大")
        public void createCalendarEvent(@NotNull Date start, @NotNull Date end) {
            //.......
        }
    }

}
4约束组合

当一个字段要进行多种校验的时候可以将多种校验组合到一个注解上 进行校验 ;

汽车类:

@ValidPassengerCount(message = "乘客数不得超过座位数.")
public class Car {

    
    private int seatCount;

    
    @NotNull
    @Size(min = 2, max = 14)
    @CheckCase(value = CaseMode.UPPER,message = "牌照字母不是大写的!!")
    private String licensePlate;

    
    private List passengers;

    public Car(int seatCount, List passengers) {
        this.seatCount = seatCount;
        this.passengers = passengers;
    }

    public Car(int seatCount, String licensePlate, List passengers) {

        this.seatCount = seatCount;
        this.licensePlate = licensePlate;
        this.passengers = passengers;
    }

    public int getSeatCount() {
        return seatCount;
    }

    public List getPassengers() {
        return passengers;
    }

    public String getLicensePlate() {
        return licensePlate;
    }

    public void setLicensePlate(String licensePlate) {
        this.licensePlate = licensePlate;
    }
}

乘客类

public class Person {

   private String name;

   public Person(String name) {
      this.name = name;
   }

}

校验字母格式注解

@Target({ METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = CheckCaseValidator.class)
@Documented
public @interface CheckCase {
   String message() default "";

   Class[] groups() default { };

   Class[] payload() default { };

   CaseMode value();
}

枚举类:

public enum CaseMode {

   
   UPPER,

   
   LOWER;

}

校验逻辑:

public class CheckCaseValidator implements ConstraintValidator {
   private CaseMode caseMode;

   @Override
   public void initialize(CheckCase constraintAnnotation) {
      this.caseMode = constraintAnnotation.value();
   }

   @Override
   public boolean isValid(String object, ConstraintValidatorContext constraintContext) {
      if ( object == null ) {
         return true;
      }

      if ( caseMode == CaseMode.UPPER ) {
         return object.equals( object.toUpperCase() );
      }
      else {
         return object.equals( object.toLowerCase() );
      }
   }
}

校验测试类

public class TestValidationCar {
    public static void main(String[] args) {

        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        Person person1 = new Person("小明");
        Person person2 = new Person("小红");
        Person person3 = new Person("小李");
        Person person4 = new Person("小王");
        Person person5 = new Person("小爱");
        ArrayList people = new ArrayList<>();
        people.add(person1);
        people.add(person2);
        people.add(person3);
        people.add(person4);
        people.add(person5);
        Car car = new Car(4,"123asd",people);
        Set> validate = validator.validate(car);

        System.out.println(validate);

    }

}

校验结果:

组合约束:

@NotNull
@Size(min = 2, max = 14)
@CheckCase(value = CaseMode.UPPER,message = "车牌字母必须全部是大写")
@Target({ METHOD, FIELD, ANNOTATION_TYPE, TYPE_USE })
@Retention(RUNTIME)
@Constraint(validatedBy = { })
@Documented
public @interface ValidLicensePlate {

	String message() default "{org.hibernate.validator.referenceguide.chapter06." +
			"constraintcomposition.ValidLicensePlate.message}";

	Class[] groups() default { };

	Class[] payload() default { };
}

使用:

@ValidPassengerCount(message = "乘客数不得超过座位数.")
public class Car {

    
    private int seatCount;

    
    @ValidLicensePlate
    private String licensePlate;

    
    private List passengers;

    public Car(int seatCount, List passengers) {
        this.seatCount = seatCount;
        this.passengers = passengers;
    }

    public Car(int seatCount, String licensePlate, List passengers) {

        this.seatCount = seatCount;
        this.licensePlate = licensePlate;
        this.passengers = passengers;
    }

    public int getSeatCount() {
        return seatCount;
    }

    public List getPassengers() {
        return passengers;
    }

    public String getLicensePlate() {
        return licensePlate;
    }

    public void setLicensePlate(String licensePlate) {
        this.licensePlate = licensePlate;
    }
}

main方法校验:

public class TestValidationCar {
    public static void main(String[] args) {

        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        Person person1 = new Person("小明");
        Person person2 = new Person("小红");
        Person person3 = new Person("小李");
        Person person4 = new Person("小王");
        Person person5 = new Person("小爱");
        ArrayList people = new ArrayList<>();
        people.add(person1);
        people.add(person2);
        people.add(person3);
        people.add(person4);
        people.add(person5);
        Car car = new Car(4,"123asd",people);
        Set> validate = validator.validate(car);

        System.out.println(validate);

    }

}
组合约束结果:

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/949465.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号