Spring Framework 提供了一套可以方便地對(duì) Controller 層中接收的參數(shù)進(jìn)行校驗(yàn)的框架，其中就包括了 @Validated 注解。在 Spring 項(xiàng)目中使用 @Validated 注解可以讓我們更加方便地進(jìn)行參數(shù)校驗(yàn)，避免了手動(dòng)校驗(yàn)的麻煩，并且使得代碼更加優(yōu)雅和易于維護(hù)。本文將詳細(xì)介紹在 Spring 項(xiàng)目中使用 @Validated 進(jìn)行參數(shù)校驗(yàn)的方法和常見應(yīng)用場景。

一、@Validated 注解簡介

@Validated 注解是 Spring Framework 中提供的一個(gè)參數(shù)校驗(yàn)注解，它可以用來標(biāo)記需要進(jìn)行參數(shù)校驗(yàn)的方法、類、方法參數(shù)和方法返回值等地方。通過使用 @Validated 注解，我們可以非常方便地對(duì)入?yún)⑦M(jìn)行檢查，并且可以自定義校驗(yàn)規(guī)則和錯(cuò)誤提示信息。

引入依賴

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

二、@Validated 注解的使用

2.1 在 Controller 層中使用

在 Controller 層中使用 @Validated 注解是最為常見的使用場景。通過在 Controller 方法的參數(shù)上添加 @Validated 注解，可以對(duì)該參數(shù)進(jìn)行校驗(yàn)。下面是一個(gè)簡單的例子：

@RestController
@RequestMapping("/api/user")
public class UserController {
    @PostMapping
    public User createUser(@RequestBody @Validated User user) {
        // ...
    }
}

在上述代碼中，@Validated 注解標(biāo)記了 User 類型的參數(shù)，表示需要對(duì)該參數(shù)進(jìn)行校驗(yàn)。如果 User 類中存在校驗(yàn)注解，那么這些注解會(huì)自動(dòng)觸發(fā)校驗(yàn)過程。如果校驗(yàn)不通過，則會(huì)拋出 MethodArgumentNotValidException 異常。

2.2 自定義校驗(yàn)規(guī)則

在使用 @Validated 注解進(jìn)行參數(shù)校驗(yàn)時(shí)，我們常常需要自定義校驗(yàn)規(guī)則。Spring Framework 提供了多種自定義校驗(yàn)規(guī)則的方式，包括使用注解實(shí)現(xiàn)、編寫自定義 Validator 等方式。

2.2.1 使用注解實(shí)現(xiàn)

可以通過編寫注解來進(jìn)行自定義校驗(yàn)規(guī)則的實(shí)現(xiàn)。例如，下面是一個(gè)用于校驗(yàn)手機(jī)號(hào)碼格式的注解：

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PhoneValidator.class)
public @interface Phone {
    String message() default "手機(jī)號(hào)碼格式不正確";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

在上述代碼中，@Phone 注解用于標(biāo)記需要進(jìn)行手機(jī)號(hào)碼格式校驗(yàn)的字段，而 @Constraint 注解指定了具體的校驗(yàn)邏輯類 PhoneValidator。PhoneValidator 實(shí)現(xiàn)了 ConstraintValidator 接口，完成對(duì)手機(jī)號(hào)碼格式的校驗(yàn)。

接下來，我們來看一下 PhoneValidator 的實(shí)現(xiàn)：

public class PhoneValidator implements ConstraintValidator<Phone, String> {
    private final static Pattern PHONE_PATTERN = Pattern.compile("^1\\d{10}$");
    @Override
    public void initialize(Phone constraintAnnotation) {
    }
    @Override
    public boolean isValid(String phone, ConstraintValidatorContext context) {
        return StringUtils.isEmpty(phone) || PHONE_PATTERN.matcher(phone).matches();
    }
}

在 PhoneValidator 的 isValid 方法中，我們使用了正則表達(dá)式來判斷手機(jī)號(hào)碼的格式是否正確。如果格式不正確，則返回 false，并且可以通過 context 參數(shù)來設(shè)置錯(cuò)誤提示信息。

使用上述自定義注解實(shí)現(xiàn)的校驗(yàn)規(guī)則，可以和 Spring 自帶的校驗(yàn)注解一樣，方便地被應(yīng)用到 Controller 層中。

2.2.2 編寫自定義 Validator

除了使用注解來實(shí)現(xiàn)自定義校驗(yàn)規(guī)則以外，還可以編寫自定義 Validator 來實(shí)現(xiàn)具體的校驗(yàn)邏輯。

下面是一個(gè)簡單的示例，用于校驗(yàn)兩個(gè)整數(shù)的大小關(guān)系：

public class ComparisonValidator implements ConstraintValidator<Comparison, Object> {
    private Comparison.Operator operator;
    private String valueFieldName;
    @Override
    public void initialize(Comparison constraintAnnotation) {
        operator = constraintAnnotation.operator();
        valueFieldName = constraintAnnotation.valueFieldName();
    }
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if (value == null) {
            return true;
        }
        try {
            Field valueField = value.getClass().getDeclaredField(valueFieldName);
            valueField.setAccessible(true);
            Object otherValue = valueField.get(value);
            if (otherValue == null) {
                return true;
            }
            int result = ((Comparable) value).compareTo(otherValue);
            switch (operator) {
                case GREATER_THAN:
                    return result > 0;
                case LESS_THAN:
                    return result < 0;
                case GREATER_THAN_OR_EQUAL_TO:
                    return result >= 0;
                case LESS_THAN_OR_EQUAL_TO:
                    return result <= 0;
                default:
                    throw new IllegalArgumentException("Unsupported Comparison Operator: " + operator);
            }
        } catch (NoSuchFieldException | IllegalAccessException e) {
            throw new RuntimeException(e);
        }
    }
}

在上述代碼中，我們定義了一個(gè) ComparisonValidator 類，它實(shí)現(xiàn)了 ConstraintValidator 接口，并且自定義了一個(gè)校驗(yàn)規(guī)則 @Comparison。

該校驗(yàn)規(guī)則需要通過 operator 和 valueFieldName 兩個(gè)屬性來確定具體的比較方式和被比較的屬性名稱。在 isValid 方法中，我們首先獲取到被比較的屬性值 otherValue，然后根據(jù) operator 來判斷 value 是否大于（小于、等于）otherValue。

使用自定義 Validator 需要手動(dòng)創(chuàng)建校驗(yàn)邏輯類，并將其與注解進(jìn)行關(guān)聯(lián)。在 Controller 層使用時(shí)，我們可以像使用 Spring 自帶的校驗(yàn)注解一樣來使用自定義的校驗(yàn)注解。

2.3 組合注解

有時(shí)候，我們需要對(duì)同一個(gè)參數(shù)進(jìn)行多種校驗(yàn)，這時(shí)候可以使用組合注解的方式來實(shí)現(xiàn)。例如，下面是一個(gè)用于校驗(yàn)密碼格式的組合注解示例：

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {})
@Pattern(regexp = "^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[@#$%^&+=])(?=\\S+$).{8,}$", message = "密碼必須包含大小寫字母、數(shù)字和特殊字符，長度至少為 8 位")
@NotNull(message = "密碼不能為空")
public @interface Password {
    String message() default "密碼格式不正確";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

在上述代碼中，@Password 注解通過組合 @Pattern 和 @NotNull 注解來實(shí)現(xiàn)了密碼的格式校驗(yàn)。如果密碼格式不正確或者為空，則會(huì)拋出校驗(yàn)異常。
在使用組合注解時(shí)，需要注意被組合的注解是否已經(jīng)使用了 @Constraint 注解，并且不要忘記設(shè)置 message、groups 和 payload 等屬性。

2.4 統(tǒng)一異常處理

在使用 @Validated 進(jìn)行參數(shù)校驗(yàn)時(shí)，如果校驗(yàn)失敗，會(huì)拋出 MethodArgumentNotValidException 異常。為了提高代碼的可維護(hù)性，我們可以通過在 Controller 層添加 @ExceptionHandler 注解并捕獲該異常，來統(tǒng)一處理校驗(yàn)失敗的情況。

例如，下面是一個(gè)簡單的異常處理示例：

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Map<String, Object> handleValidationException(MethodArgumentNotValidException ex) {
        BindingResult bindingResult = ex.getBindingResult();
        List<String> errorList = bindingResult.getAllErrors().stream()
                .map(DefaultMessageSourceResolvable::getDefaultMessage)
                .collect(Collectors.toList());
        return Collections.singletonMap("message", errorList);
    }
}

在上述代碼中，我們通過在 GlobalExceptionHandler 類中添加 @RestControllerAdvice 和 @ExceptionHandler 注解來統(tǒng)一處理 MethodArgumentNotValidException 異常。在 handleValidationException 方法中，我們首先獲取到 BindingResult 對(duì)象，并通過遍歷所有錯(cuò)誤信息來收集錯(cuò)誤提示信息。最終返回一個(gè)包含錯(cuò)誤提示信息的 Map 對(duì)象。

三、@Validated 注解的常見應(yīng)用場景

@Validated 注解作為 Spring Framework 中的一個(gè)參數(shù)校驗(yàn)注解，廣泛應(yīng)用于 Controller 層的參數(shù)校驗(yàn)、DTO 類的參數(shù)校驗(yàn)和業(yè)務(wù)類的參數(shù)校驗(yàn)等方面。下面列舉了幾個(gè)常見的應(yīng)用場景：

1.數(shù)據(jù)庫操作時(shí)的參數(shù)校驗(yàn)：數(shù)據(jù)庫操作一般需要對(duì)參數(shù)進(jìn)行校驗(yàn)，避免因?yàn)闊o效參數(shù)導(dǎo)致的 SQL 注入等安全問題。

2.DTO 類的參數(shù)校驗(yàn)：在使用 DTO（Data Transfer Object）類進(jìn)行數(shù)據(jù)傳輸時(shí)，往往需要對(duì)傳輸?shù)淖侄芜M(jìn)行校驗(yàn)，保證數(shù)據(jù)的有效性和完整性。

3.業(yè)務(wù)類的參數(shù)校驗(yàn)：業(yè)務(wù)類中的方法通常也需要對(duì)參數(shù)進(jìn)行校驗(yàn)，以確保業(yè)務(wù)邏輯的正確性和可靠性。

四、常用的驗(yàn)證注解

1.@NotNull 注解

@NotNull 表示被注解的參數(shù)不能為 null。

例如：

public void testNotNull(@NotNull String str) {}

2.@Size 注解

@Size 表示被注解的參數(shù)的大小必須在指定的范圍內(nèi)（包括最小值和最大值）。

例如：

public void testSize(@Size(min = 1, max = 10) String str) {}

3.@Min 和 @Max 注解

@Min 和 @Max 分別表示被注解的參數(shù)的最小值和最大值。

例如：

public void testMin(@Min(18) int age) {}
public void testMax(@Max(100) int score) {}

4.@DecimalMin 和 @DecimalMax 注解

@DecimalMin 和 @DecimalMax 分別表示被注解的參數(shù)的最小值和最大值，適用于浮點(diǎn)數(shù)、BigDecimal 或 BigInteger 類型的參數(shù)。

例如：

public void testDecimalMin(@DecimalMin("0.00") BigDecimal price) {}
public void testDecimalMax(@DecimalMax("100.00") BigDecimal score) {}

5.@Digits 注解

@Digits 表示被注解的參數(shù)必須是一個(gè)數(shù)字，并且整數(shù)位和小數(shù)位的位數(shù)不能超過指定的值（默認(rèn)整數(shù)位 2 位，小數(shù)位 0 位）。

例如：

public void testDigits(@Digits(integer = 2, fraction = 1) BigDecimal num) {}

6.@Email 注解

@Email 表示被注解的參數(shù)必須是一個(gè)合法的電子郵件地址。

例如：

public void testEmail(@Email String email) {}

7.@Pattern 注解

@Pattern 表示被注解的參數(shù)必須符合指定的正則表達(dá)式模式。

例如：

public void testPattern(@Pattern(regexp = "^\\d{4}-\\d{1,2}-\\d{1,2}$") String date) {}

除了使用單個(gè)注解外，也可以使用組合注解來完成更為復(fù)雜的校驗(yàn)邏輯。

例如：

@NotNull(message = "用戶名不能為空")
@Size(min = 5, max = 20, message = "用戶名長度必須在 5 到 20 之間")
public String getUsername() {
    return this.username;
}

上述代碼表示要求用戶名不能為空，并且在長度范圍內(nèi)。如果不符合要求，則會(huì)拋出相應(yīng)的異常，如 MethodArgumentNotValidException 等。

到此這篇關(guān)于Spring利用@Validated注解實(shí)現(xiàn)參數(shù)校驗(yàn)詳解的文章就介紹到這了,更多相關(guān)Spring Validated內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論