Java自定义校验注解

Java 参数校验框架 java.validation，自定义校验注解

背景：

​ 在开发中很多时候需要对前端传来的参数进行校验，如果把校验写在业务代码中会造成代码十分冗余，充满了 if-else 的校验代码。即使把校验逻辑写成工具类也需要在业务逻辑中调用校验方法。学会了spring的javax.validation 注解式参数校验就可以用注解进行参数校验。

什么是java.validation？

​ JSR303 是一套JavaBean参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代)，就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本

<dependency>
      <groupId>jakarta.validation</groupId>
      <artifactId>jakarta.validation-api</artifactId>
      <version>2.0.2</version>
</dependency>
      <!--springboot 新版本需要validation启动器-->
      <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

校验框架自带的注解

校验注解	校验的数据类型	说明
@NotNull	任意类型	校验注解的元素值不为null
@Null	任意类型	校验注解的元素值是null
@NotBlank	CharSequence子类型	验证注解的元素值不为空（不为null、去除首位空格后长度不为0），不同与@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格。
@NotEmpty	CharSequence子类型、Collection、Map、数组	验证注解的元素值不为null且不为空（字符串长度不为0，集合大小不为0）
@Valid	任何非原子类型，级联验证。比如验证User对象的属性Address对象	指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象，在地址对象上加@Valid注解即可级联验证。
@AssertFalse	Boolean，boolean	验证注解的元素值是false
@AssertTrue	Boolean，boolean	验证注解的元素值是true
@Min(value=xxx)	BigDecimal，BigInteger，byte，short，int，long，等任何Number或CharSequence（存储的是数字）子类型，，	验证注解的元素值大于等于@Min指定的value值
@Max(value=xxx)	和@Min要求一样	验证注解的元素值小于等于@Max指定的value值
@DecimalMax(value=xxx)	和@Min要求一样	验证注解的元素值大于等于@DecimalMin指定的value值
@DecimalMin(value=xxx)	和@Min要求一样	验证注解的元素值小于等于@DecimalMax指定的value值
@Digits(integer=整数位数，fraction=小数位数)	和@Min要求一样	验证注解的元素值的整数位数和小数位数的上限
@Size(min=下限，max=上限)	字符串、Collection、Map、数组等	验证注解的元素值在min和max（包含）指定区间之内，如字符长度、集合大小
@Past	java.util.Date，java.util.Calendar，Joda Time类库的日期类型	验证注解的元素值（日期类型）比当前时间早
@Future	与@Past要求一样	验证注解的元素值（日期类型）比当前时间晚
@Length(min=下限，max=上限)	CharSequence子类型	验证注解的元素值长度在min和max区间内
@Range(min=最下值，max=最大值)	BigDecimal，BigInteger，CharSequence，byte，short，int，long等原子类型和包装类型	验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式，flag=标志的模式)	CharSequence子类型（如String）	验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式，flag=标志的模式)	String，任何CharSequence的子类型	验证注解的元素值与指定的正则表达式匹配

这里只是validation的一部分注解，完整内容可以看官方文档。

如何使用？

@Data
public class TestPojo {
    @NotNull(message = "密码不能为空")
    private String password;
}

在需要校验的属性上加上相应的注解即可。

注意：在接收参数前需要加上@Valid或者@Validated注解，否则校验不会生效。

 @PostMapping("/regex")
    public void testAnnotation(@Valid @RequestBody TestPojo pojo){
        System.out.println(pojo);
    }

自定义注解

当框架提供的注解无法满足我们的需求时，我们就可以自定义注解进行校验。

1. 自定义注解

@Documented
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = RegexVerifyContent.class) //指定校验逻辑类
public @interface RegexVerify {

    String message() default "不符合的正则表达式";

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

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

• message定制化的提示信息，主要是从ValidationMessages.properties里提取，也可以依据实际情况进行定制。

• groups这里主要进行将validator进行分类，不同的类group中会执行不同的validator操作。

• payload主要是针对bean的，使用不多。

2. 定义校验逻辑

public class RegexVerifyContent implements ConstraintValidator<RegexVerify, String> {
	//需要实现ConstraintValidator接口的isValid方法
    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if (s.startsWith("|") || s.endsWith("|") || s.contains("||")) {
            System.out.println("格式错误");
            return false;
        }
        try {
            Pattern.compile(s);
        } catch (PatternSyntaxException e) {
            System.out.println("格式错误");
            return false;
        }
        return true;
    }
}

也可以把校验逻辑的类写成注解的内部类，如下：

import javax.validation.Constraint;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import javax.validation.Payload;
import java.lang.annotation.*;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

/**
 * @author 王荣毅
 */
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = RegexVerify.RegexVerifyContent.class)
@Documented
public @interface RegexVerify {
    String message() default "不符合的正则表达式";

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

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

    /**
     * 校验逻辑
     */
    class RegexVerifyContent implements ConstraintValidator<RegexVerify, String> {
        @Override
        public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
            if (s.startsWith("|") || s.endsWith("|") || s.contains("||")) {
                System.out.println("格式错误");
                return false;
            }
            try {
                Pattern.compile(s);
            } catch (PatternSyntaxException e) {
                System.out.println("格式错误");
                return false;
            }
            return true;
        }
    }
}

定义好后像使用原生注解一样直接在参数上加注解就可以校验了，注意一定要加@Valid或@Validated注解才能生效哦。