注解

設(shè)置依賴

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

注解

以下是 validation-api中提供的可用的注解列表

以上大致就是validation-api默認(rèn)提供的參數(shù)驗(yàn)證注解。示例如下：

另外需要注意的是，在每個(gè)注解中基本上都一個(gè)分組屬性：Class<?>[] groups() default { };

其作用就是對(duì)對(duì)象屬性分組，用于在不同的場(chǎng)景下支持不同的參數(shù)驗(yàn)證。我們來(lái)舉一個(gè)列子：

比如我們新增和更新數(shù)據(jù)的操作一般都用同一個(gè)對(duì)象來(lái)接收前端傳入?yún)?shù)。那么新增時(shí)的Id可能為空，而編輯時(shí)的Id不能為空，我們對(duì)參數(shù)的驗(yàn)證規(guī)則是不一樣的。那么怎么實(shí)現(xiàn)呢？這里就需要用到我們的groups()了。代碼如下：

    @RequestMapping("create")
    @ResponseBody
    public String create(@RequestBody @Validated(Create.class) User user) {
        return "create success";
    }

    @RequestMapping("update")
    @ResponseBody
    public String update(@RequestBody @Validated(Update.class) User user) {
        return "update success";
    }

    @Data
    public static class User {
        @NotBlank(message = "id不能為空", groups = {Update.class})
        private String id;

        @NotNull(message = "用戶名不能為空", groups = {Create.class, Update.class})
        private String username;

        @NotNull(message = "密碼不能為空")
        private String password;
    }

    public interface Create {
    }

    public interface Update {
    }

根據(jù)需求，我們?cè)?User 的 id 屬性上標(biāo)記上 groups = {Update.class}，在 username 屬性上標(biāo)記 groups = {Create.class, Update.class}。則表明我們對(duì)id只在 @Validated(Update.class) 時(shí)驗(yàn)證id的值；username 則在 @Validated(Update.class) 或者 @Validated(Create.class) 時(shí)都需要驗(yàn)證。

自定義驗(yàn)證

首先，定義一個(gè)自定義注解，例如 @ValidEnum：

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ValidEnumValidator.class)
public @interface ValidEnum {
    String message() default "無(wú)效的枚舉值";

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

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

    Class<? extends Enum<?>> value();
}

@ValidEnum 注解用于驗(yàn)證一個(gè)枚舉類型的值是否在指定的枚舉類型中，使用 ValidEnumValidator 類對(duì)其進(jìn)行驗(yàn)證。

接下來(lái)，定義一個(gè) ValidEnumValidator 類，實(shí)現(xiàn)對(duì) @ValidEnum 注解的驗(yàn)證邏輯：

public class ValidEnumValidator implements ConstraintValidator<ValidEnum, Object> {
    private Set<String> validValues = new HashSet<>();

    @Override
    public void initialize(ValidEnum constraintAnnotation) {
        Class<? extends Enum<?>> enumClass = constraintAnnotation.value();
        Enum<?>[] enumValues = enumClass.getEnumConstants();
        for (Enum<?> enumValue : enumValues) {
            validValues.add(enumValue.name());
        }
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if (value == null) {
            return true;
        }
        return validValues.contains(value.toString());
    }
}

ValidEnumValidator 類實(shí)現(xiàn)了 ConstraintValidator 接口，并重寫了 initialize() 和 isValid() 兩個(gè)方法。initialize() 方法用于初始化驗(yàn)證器，獲取枚舉類型的所有枚舉值；isValid() 方法用于實(shí)現(xiàn)驗(yàn)證邏輯，判斷枚舉值是否在指定的枚舉類型中。

最后，在使用 @Validated 注解的 Controller 中，對(duì)請(qǐng)求參數(shù)使用自定義的 @ValidEnum 注解進(jìn)行驗(yàn)證

@RestController
@Validated
public class UserController {
    @GetMapping("/user")
    public void getUser(@RequestParam @ValidEnum(value = Gender.class) String gender) {
        // 處理請(qǐng)求
    }
}

@ValidEnum 注解用于驗(yàn)證 gender 參數(shù)是否在 Gender 枚舉類型中。如果 gender 參數(shù)的值不在 Gender 枚舉類型中，則會(huì)拋出 ConstraintViolationException 異常，并帶有指定的錯(cuò)誤消息。

需要注意的是，自定義的 Bean Validation 注解需要使用 @Constraint 注解進(jìn)行標(biāo)注，并指定對(duì)應(yīng)的驗(yàn)證器類。

在驗(yàn)證器類中，需要實(shí)現(xiàn) ConstraintValidator 接口，并實(shí)現(xiàn) initialize() 和 isValid() 方法。在使用自定義注解進(jìn)行參數(shù)驗(yàn)證時(shí)，需要在對(duì)應(yīng)的 Controller 中使用 @Validated 注解進(jìn)行標(biāo)注。

有趣的歷史

大家可以看到spring-boot-starter-validation 中依賴的包是 jakarta.validation-api，其命名空間屬于jakarta。jakarta.validation-api 實(shí)現(xiàn)的規(guī)范依舊是JSR380，熟悉的小伙伴可能知道其實(shí)以前用的是 javax.validation-api。可是為什么現(xiàn)在會(huì)是jakarta.validation-api 呢，而不是 javax.validation-api？這中間其實(shí)涉及到了太多的商業(yè)上的博弈。有興趣的大家可以自己去了解下，有時(shí)間單獨(dú)出一篇介紹。

以上就是springboot實(shí)現(xiàn)請(qǐng)求參數(shù)驗(yàn)證的多種方法的詳細(xì)內(nèi)容，更多關(guān)于springboot校驗(yàn)參數(shù)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論