快捷導(dǎo)航

javax.validation.constraints如何校驗(yàn)參數(shù)合法性

更新時(shí)間：2024年07月04日 08:40:11 作者：xindoo

本文將深入探討javax.validation.constraints的基本用法和高級(jí)應(yīng)用,幫助讀者更好地理解和運(yùn)用這個(gè)強(qiáng)大的校驗(yàn)框架,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

javax.validation.constraints校驗(yàn)參數(shù)合法性

在Java開(kāi)發(fā)過(guò)程中，數(shù)據(jù)校驗(yàn)是一項(xiàng)至關(guān)重要的任務(wù)。

為了確保數(shù)據(jù)的完整性和正確性，我們通常需要對(duì)輸入的數(shù)據(jù)進(jìn)行一系列的校驗(yàn)。

javax.validation.constraints提供了一套基于注解的校驗(yàn)框架，能夠讓我們簡(jiǎn)潔、高效地完成數(shù)據(jù)校驗(yàn)工作。

基本用法：常用注解

javax.validation.constraints包含了一組基礎(chǔ)的校驗(yàn)注解，覆蓋了大多數(shù)常見(jiàn)的數(shù)據(jù)校驗(yàn)場(chǎng)景。

下面我們逐一介紹這些基本注解：

@NotNull: 用于檢查值是否為null。
@NotEmpty: 用于檢查字符串、集合、數(shù)組等類(lèi)型是否為空或null。
@Size: 用于檢查字符串、集合、數(shù)組等類(lèi)型的元素個(gè)數(shù)是否在指定的范圍內(nèi)。
@Min: 用于檢查數(shù)值是否大于等于指定的最小值。
@Max: 用于檢查數(shù)值是否小于等于指定的最大值。
@DecimalMin: 用于檢查數(shù)值是否大于等于指定的最小值（可以是浮點(diǎn)數(shù)）。
@DecimalMax: 用于檢查數(shù)值是否小于等于指定的最大值（可以是浮點(diǎn)數(shù)）。
@Digits: 用于檢查數(shù)值是否符合指定的整數(shù)位數(shù)和小數(shù)位數(shù)要求。
@Email: 用于檢查字符串是否符合電子郵件格式。
@Pattern: 用于檢查字符串是否符合指定的正則表達(dá)式。

以下是一個(gè)簡(jiǎn)單的示例，展示了如何使用這些基本注解對(duì)一個(gè)用戶實(shí)體類(lèi)進(jìn)行校驗(yàn)：

import javax.validation.constraints.*;

public class User {

    @NotNull(message = "ID 不能為空")
    private Long id;

    @NotEmpty(message = "用戶名不能為空")
    @Size(min = 2, max = 20, message = "用戶名長(zhǎng)度必須在 2 到 20 個(gè)字符之間")
    private String username;

    @Min(value = 18, message = "年齡必須大于等于 18 歲")
    @Max(value = 100, message = "年齡必須小于等于 100 歲")
    private int age;

    @Email(message = "電子郵件格式不正確")
    private String email;

    // Getter and Setter ...
}

高級(jí)應(yīng)用：自定義注解和校驗(yàn)器

盡管javax.validation.constraints提供了豐富的基礎(chǔ)注解，但有時(shí)我們還需要進(jìn)行一些特定的校驗(yàn)操作。這時(shí)，我們可以通過(guò)自定義注解和校驗(yàn)器來(lái)實(shí)現(xiàn)這些需求。

以下是一個(gè)示例，展示了如何創(chuàng)建一個(gè)自定義注解@Password，用于檢查密碼是否符合強(qiáng)度要求（至少包含一個(gè)大寫(xiě)字母、一個(gè)小寫(xiě)字母和一個(gè)數(shù)字）：

首先，創(chuàng)建自定義注解@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 "密碼必須包含至少一個(gè)大寫(xiě)字母、一個(gè)小寫(xiě)字母和一個(gè)數(shù)字";

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

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

然后，創(chuàng)建自定義校驗(yàn)器PasswordValidator：

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

public class PasswordValidator implements ConstraintValidator<Password, String> {

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

    @Override
    public void initialize(Password constraintAnnotation) {
    }

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

最后，在需要校驗(yàn)的字段上添加自定義注解@Password：

public class User {

    // ... 其他字段

    @Password
    private String password;

    // Getter and Setter ...
}

整合Spring Boot

在Spring Boot項(xiàng)目中，我們可以很方便地整合javax.validation.constraints進(jìn)行數(shù)據(jù)校驗(yàn)。

首先，需要在項(xiàng)目的pom.xml文件中添加以下依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

然后，在Controller方法的參數(shù)前添加@Valid注解，即可觸發(fā)數(shù)據(jù)校驗(yàn)。

當(dāng)校驗(yàn)失敗時(shí)，Spring Boot會(huì)拋出MethodArgumentNotValidException異常。

我們可以通過(guò)定義全局異常處理器來(lái)捕獲該異常，并將校驗(yàn)失敗的信息返回給客戶端：

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<String> handleValidationException(MethodArgumentNotValidException exception) {
        StringBuilder message = new StringBuilder();
        exception.getBindingResult().getFieldErrors().forEach(fieldError ->
                message.append(fieldError.getField()).append(": ").append(fieldError.getDefaultMessage()).append("; ")
        );
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(message.toString());
    }
}