@Constraint注解配合自定义验证类型注解的开发

Myth丶恋晨 2022-04-16 05:43 205阅读 0赞

## 前言:虽然现在有很多很有用的验证注解，如@not null,@not blank,@not empty.@Email等等。但是我们可能有时候根据项目的拓展这些验证注解不够用，那怎么办,解决的办法就是自定义验证注解 ##

### 1，@Constraint注解 ###

说到自定义验证类型的注解，那就要说说@Constraint这个官方注解了，我们既然自定义了注解，那么注解的逻辑在哪里处理呢？没错，就是这个@Constraint帮我们处理。

### 2,代码讲解: ###

/**
     * uid是否属于当前上下文租户
     * 注：当被校验对象为空时，校验为通过，所以如果需要校验对象必填，请自行结合相关校验注解
     * Created by Zhang JinLong(150429) on 2016-09-18.
     */
    @Target({ElementType.FIELD, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Constraint(validatedBy = {SameTenant.StringChecker.class, SameTenant.LongChecker.class})
    @Documented
    public @interface SameTenant {
    
        String message() default "用户不存在或者不属于当前组织";
    
        Class<?>[] groups() default {};
    
        Class<? extends Payload>[] payload() default {};
    
        class StringChecker implements ConstraintValidator<SameTenant, String> {
    
            @Override
            public void initialize(SameTenant arg0) {
            }
    
            @Override
            public boolean isValid(String uid, ConstraintValidatorContext context) {
    
                System.out.print("到注解里面了"+uid);
                if (StringUtils.isBlank(uid)) {
    
                    return true;
                }
                return false;
            }
        }
    
        class LongChecker implements ConstraintValidator<SameTenant, Long> {
    
            @Override
            public void initialize(SameTenant arg0) {
            }
    
            @Override
            public boolean isValid(Long uid, ConstraintValidatorContext context) {
                if (null == uid) {
                    return true;
                }
                return false;
            }
        }
    }

在上面的这个自定义验证注解中，

@Constraint(validatedBy = \{SameTenant.StringChecker.class, SameTenant.LongChecker.class\})

这段代表注解的处理逻辑是SameTenant.StringChecker.class和SameTenant.LongChecker.class这两个类，也可以只定义一个，多个用逗号分开。

(本代码中这两个类一个处理传递string类型和传递long类型时分别调用不同的处理逻辑)

而从上面代码可以看出，我们类的内部定义了两个类，也可以在外部定义，这里为了方便。这两个类就是分别处理两种数据类型的逻辑方法。那么它是怎么区分的呢?

class StringChecker implements ConstraintValidator<SameTenant, String> \{   和     class LongChecker implements ConstraintValidator<SameTenant, Long> \{    看出有什么不同吗？没错，在最后面一个是String,一个是Long。而这两个都要实现

ConstraintValidator接口，它有两个泛型，第一个是自定义的注解类，第二个就是要验证的数据的类型(例如写了String类型的数据，那么这个注解就要放在String类型的字段上才会起作用，也可以向我上面那样写两个，自动识别String和Long, 最简便的写成Object，那么它可以接收任何数据类型的数据)。而这两个类里面都有两个方法，initialize和isValid，第一个是初始化方法，第二个是验证的逻辑方法，返回true,则验证通过，否则则不通过。

### 3,赠言(很重要): ###

这个自定义注解逻辑处理类由于实现了ConstraintValidator接口，所以它默认被spring管理成bean,所以可以在这个逻辑处理类里面用@Autowiredu或者@Resources注入别的服务，而且不用在类上面用@Compent注解成spring的bean.

自定义验证类型注解类里面由于是用于验证数据，一般在里面加上

String message() default "用户不存在或者不属于当前组织";

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

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

如上面代码也加上了。你也可以查看官方验证注解，也有这三行。