Spring Boot 中自定義數(shù)據(jù)校驗(yàn)注解

在 Spring Boot 中，我們可以使用 JSR-303 數(shù)據(jù)校驗(yàn)規(guī)范來(lái)校驗(yàn)表單數(shù)據(jù)的合法性。JSR-303 提供了一些常用的數(shù)據(jù)校驗(yàn)注解，例如 @NotNull、@NotBlank、@Size 等。但是，在實(shí)際開發(fā)中，我們可能需要自定義數(shù)據(jù)校驗(yàn)注解來(lái)滿足特定的需求。本文將介紹如何在 Spring Boot 中自定義數(shù)據(jù)校驗(yàn)注解，并提供示例代碼來(lái)演示它的用法。

自定義校驗(yàn)注解

在 Spring Boot 中，我們可以通過(guò)定義注解并使用 @Constraint 注解來(lái)自定義數(shù)據(jù)校驗(yàn)注解。下面是一個(gè)自定義的注解 @ZipCode，用于校驗(yàn)郵政編碼是否合法：

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ZipCodeValidator.class)
public @interface ZipCode {

    String message() default "Invalid zip code";

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

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

    @Target({ElementType.FIELD})
    @Retention(RetentionPolicy.RUNTIME)
    @interface List {
        ZipCode[] value();
    }
}

在上面的代碼中，我們使用了 @Constraint 注解來(lái)指示該注解需要使用 ZipCodeValidator 類進(jìn)行校驗(yàn)。@Constraint 注解中的參數(shù)含義如下：

• validatedBy：指示使用哪個(gè)類進(jìn)行校驗(yàn)。
• message：校驗(yàn)失敗時(shí)返回的消息。
• groups：校驗(yàn)分組。
• payload：校驗(yàn)負(fù)載。

在注解中，我們定義了一個(gè) ZipCodeValidator.List 內(nèi)部注解，用于支持多個(gè) @ZipCode 注解的使用。

自定義校驗(yàn)器

在自定義校驗(yàn)注解后，我們還需要實(shí)現(xiàn)校驗(yàn)器。下面是一個(gè) ZipCodeValidator 校驗(yàn)器的示例代碼：

public class ZipCodeValidator implements ConstraintValidator<ZipCode, String> {

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return true;
        }
        Pattern pattern = Pattern.compile("\\d{5}");
        Matcher matcher = pattern.matcher(value);
        return matcher.matches();
    }
}

在上面的代碼中，我們實(shí)現(xiàn)了 ConstraintValidator<ZipCode, String> 接口，并重寫了 isValid 方法。isValid 方法用于實(shí)際校驗(yàn)邏輯。在本例中，我們使用正則表達(dá)式驗(yàn)證郵政編碼是否符合 5 位數(shù)字的格式。

使用自定義校驗(yàn)注解

在定義自定義校驗(yàn)注解和校驗(yàn)器后，我們可以在 Java 對(duì)象中使用自定義校驗(yàn)注解。下面是一個(gè)示例代碼：

public class Address {

    @ZipCode
    private String zipCode;

    // 省略 getter 和 setter 方法
}

在上面的代碼中，我們?cè)?Address 類的 zipCode 屬性上使用了 @ZipCode 注解。在使用時(shí)，我們不需要指定 message 參數(shù)，因?yàn)樵搮?shù)已經(jīng)在 @ZipCode 注解中指定。

在控制器中，我們可以使用 @Valid 注解來(lái)指示需要校驗(yàn)的對(duì)象。例如：

@RestController
@RequestMapping("/addresses")
public class AddressController {

    @PostMapping
    public ResponseEntity<?> createAddress(@Valid @RequestBody Address address) {
        // 創(chuàng)建地址
        return ResponseEntity.ok().build();
    }
}

在上面的示例代碼中，我們使用了 @Valid 注解來(lái)指示需要校驗(yàn) RequestBody 中的 Address 對(duì)象。如果校驗(yàn)失敗，Spring Boot 將自動(dòng)返回一個(gè)包含錯(cuò)誤信息的響應(yīng)。

總結(jié)

在本文中，我們介紹了在 Spring Boot 中自定義數(shù)據(jù)校驗(yàn)注解的方法，并提供了示例代碼來(lái)演示它的用法。使用自定義校驗(yàn)注解可以幫助我們滿足特定的數(shù)據(jù)校驗(yàn)需求，從而提高 Web 應(yīng)用的安全性和可靠性。如果您在開發(fā) Web 應(yīng)用程序時(shí)需要進(jìn)行數(shù)據(jù)校驗(yàn)，并且默認(rèn)的數(shù)據(jù)校驗(yàn)注解無(wú)法滿足您的需求，請(qǐng)務(wù)必考慮使用自定義校驗(yàn)注解的方法。文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-495538.html

到了這里，關(guān)于Spring Boot 中自定義數(shù)據(jù)校驗(yàn)注解的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！