Java参数校验详解之使用@Valid注解和自定义注解进行参数验证_Java

很多时候我们需要使用不少if、else等等逻辑判断及验证，这样在进行一些重复的参数校验会很麻烦，且以后要维护也会吃力。

而这样就可以使用javax.validation。验证（validation）常见的验证操作包括验证数据的类型、格式、长度、范围、唯一性等

javax.validation 包：java se 6+ 中引入了 javax.validation 包，作为 bean validation 规范的一部分。这个包提供了一组注解和接口，可以方便地进行数据验证。

<!--        validation组件依赖-->
<dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter-validation</artifactid>
</dependency>

而对于一般写在业务逻辑类中的参数校验语句，可以省略。如将@valid注解填写在登录接口的方法参数中：

@postmapping("/login")
public respbean login(@valid @requestbody user user) {
    log.info("{}", user);
    return userservice.login(user);
}

@valid 注解对入参进行相应的校验：

注解使用在方法参数上，然后对于参数的校验要求可去参数的实体类进行校验条件的填写。

/**
 * @author z
 * @date 2023/9/27 21:25
 */
@data
public class user {
    @notnull //账号非空
    //这个@mobile是自定义判断注解，下面有对其的创建进行详细的讲解
    @mobile(required = true) 
    private string mobile;

    @notnull //密码非空
    @length(min = 32)  //长度的限制
    private string password;
}

以及如： @size(min=1, max=12) 代表：长度在 1 ~ 12 字符之间。其他一些判断的注解可以去该导入的外部库查看。

也可以自定判断条件注解：如@mobile这个自定义的注解：

1.创建软件包：validation

2.创建需要的注解：mobile

3.而对于这个注解的写法，直接去拷贝javax.validation 包中已经写好的注解，如：@notnull注解进行修改：（有报错的地方就删除不用即可）

@notnull注解如下：

@target({elementtype.method, elementtype.field, elementtype.annotation_type, elementtype.constructor, elementtype.parameter, elementtype.type_use})
@retention(retentionpolicy.runtime)
@repeatable(notnull.list.class)  //爆红了删除
@documented
@constraint(validatedby = {}) //校验规则的定义
public @interface notnull {
    string message() default "{javax.validation.constraints.notnull.message}";
    //修改校验的消息

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

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

}

而在这里在添加一条属性：（代表必填）

 boolean required() default true;

自定义的@mobile如下：

/**
 * @author z
 * @date 2023/9/28 8:53
 */
@target({elementtype.method, elementtype.field, elementtype.annotation_type, elementtype.constructor, elementtype.parameter, elementtype.type_use})
@retention(retentionpolicy.runtime)
@documented
//自己定义校验规则的一个类：mobilevalidator.class （手机号码校验规则类）
//将自定义规则类放进@constraint(validatedby={}) 中
@constraint(validatedby = {mobilevalidator.class})
public @interface mobile {

    boolean required() default true;

    //信息，抛出的是bindexception，前端页面接收的话，我们要进行异常的捕获
    string message() default "手机号码格式错误";

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

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

而我们需要进行自己定义检验规则，创建一个校验规则类，并将其放进@constraint(validatedby={}) 中

自定义校验规则类：

/**
 * 手机号码校验规则
 *
 * @author z
 * @date 2023/9/28 8:56
 */
public class mobilevalidator implements constraintvalidator<mobile, string> {

    private boolean required = false;

    //初始化：获取是否需要是必填的
    @override
    public void initialize(mobile constraintannotation) {
        //获取到填的值:true或者false
        required = constraintannotation.required();
    }

    @override
    public boolean isvalid(string value, constraintvalidatorcontext context) {
        //必填：则使用手机号码校验工具类去校验
        if (required){
            return validatorutil.mobile(value);
        //非必填：
        }else {
            if (stringutils.isempty(value)){ //传的号码为空
                return true;
            }else {
                //传的号码非空，则使用手机号码校验工具类去校验
                return validatorutil.ismobile(value);
            }
        }
    }
}

而对于手机号码的校验工具类：

添加依赖：

<dependency>
    <groupid>org.apache.commons</groupid>
    <artifactid>commons-lang3</artifactid>
</dependency>

使用正则表达进行手机号码的校验：

import org.apache.commons.lang3.stringutils;
import java.util.regex.matcher;
import java.util.regex.pattern;

/**
 * 手机号码校验类 (使用正则表达式)
 *
 * @author z
 * @date 2023/9/27 21:45
 */
public class validatorutil {

    private static final pattern mobile_pattern = pattern.compile("[1]([3-9])[0-9]{9}$");

    public static boolean mobile(string mobile) {
        if (stringutils.isempty(mobile)){
            return false;
        }
        matcher matcher = mobile_pattern.matcher(mobile);
        return matcher.matches();
    }
}