使用javax.validation.constraints校验参数合法性

xindoo

发布于 2024-08-07 10:15:28

1690

发布于 2024-08-07 10:15:28

文章被收录于专栏：XINDOO的专栏

在Java开发过程中，数据校验是一项至关重要的任务。为了确保数据的完整性和正确性，我们通常需要对输入的数据进行一系列的校验。javax.validation.constraints提供了一套基于注解的校验框架，能够让我们简洁、高效地完成数据校验工作。本文将深入探讨javax.validation.constraints的基本用法和高级应用，帮助读者更好地理解和运用这个强大的校验框架。

基本用法：常用注解

javax.validation.constraints包含了一组基础的校验注解，覆盖了大多数常见的数据校验场景。下面我们逐一介绍这些基本注解：

@NotNull: 用于检查值是否为null。
@NotEmpty: 用于检查字符串、集合、数组等类型是否为空或null。
@Size: 用于检查字符串、集合、数组等类型的元素个数是否在指定的范围内。
@Min: 用于检查数值是否大于等于指定的最小值。
@Max: 用于检查数值是否小于等于指定的最大值。
@DecimalMin: 用于检查数值是否大于等于指定的最小值（可以是浮点数）。
@DecimalMax: 用于检查数值是否小于等于指定的最大值（可以是浮点数）。
@Digits: 用于检查数值是否符合指定的整数位数和小数位数要求。
@Email: 用于检查字符串是否符合电子邮件格式。
@Pattern: 用于检查字符串是否符合指定的正则表达式。

以下是一个简单的示例，展示了如何使用这些基本注解对一个用户实体类进行校验：

import javax.validation.constraints.*;

public class User {

    @NotNull(message = &quot;ID 不能为空&quot;)
    private Long id;

    @NotEmpty(message = &quot;用户名不能为空&quot;)
    @Size(min = 2, max = 20, message = &quot;用户名长度必须在 2 到 20 个字符之间&quot;)
    private String username;

    @Min(value = 18, message = &quot;年龄必须大于等于 18 岁&quot;)
    @Max(value = 100, message = &quot;年龄必须小于等于 100 岁&quot;)
    private int age;

    @Email(message = &quot;电子邮件格式不正确&quot;)
    private String email;

    // Getter and Setter ...
}

高级应用：自定义注解和校验器

尽管javax.validation.constraints提供了丰富的基础注解，但有时我们还需要进行一些特定的校验操作。这时，我们可以通过自定义注解和校验器来实现这些需求。

以下是一个示例，展示了如何创建一个自定义注解@Password，用于检查密码是否符合强度要求（至少包含一个大写字母、一个小写字母和一个数字）：

首先，创建自定义注解@Password：

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Constraint(validatedBy = PasswordValidator.class)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface Password {

    String message() default &quot;密码必须包含至少一个大写字母、一个小写字母和一个数字&quot;;

    Class&lt;?&gt;[] groups() default {};

    Class&lt;? extends Payload&gt;[] payload() default {};
}

然后，创建自定义校验器PasswordValidator：

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class PasswordValidator implements ConstraintValidator&lt;Password, String&gt; {

    private static final String PASSWORD_PATTERN = &quot;^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d]{8,}$&quot;;

    @Override
    public void initialize(Password constraintAnnotation) {
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return false;
        }
        return value.matches(PASSWORD_PATTERN);
    }
}

最后，在需要校验的字段上添加自定义注解@Password：

public class User {

    // ... 其他字段

    @Password
    private String password;

    // Getter and Setter ...
}

整合Spring Boot

在Spring Boot项目中，我们可以很方便地整合javax.validation.constraints进行数据校验。首先，需要在项目的pom.xml文件中添加以下依赖：

&lt;dependency&gt;
    &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
    &lt;artifactId&gt;spring-boot-starter-validation&lt;/artifactId&gt;
&lt;/dependency&gt;

然后，在Controller方法的参数前添加@Valid注解，即可触发数据校验。当校验失败时，Spring Boot会抛出MethodArgumentNotValidException异常。我们可以通过定义全局异常处理器来捕获该异常，并将校验失败的信息返回给客户端：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity&lt;String&gt; handleValidationException(MethodArgumentNotValidException exception) {
        StringBuilder message = new StringBuilder();
        exception.getBindingResult().getFieldErrors().forEach(fieldError -&gt;
                message.append(fieldError.getField()).append(&quot;: &quot;).append(fieldError.getDefaultMessage()).append(&quot;; &quot;)
        );
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(message.toString());
    }
}

以上就是javax.validation.constraints的基本用法和高级应用。通过掌握这个强大的校验框架，我们可以轻松地为Java项目实现数据校验功能，从而提高代码的健壮性和可维护性。

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2023-07-16 ，如有侵权请联系 cloudcommunity@tencent.com 删除

字符串