背景

在使用springboot進(jìn)行后端開(kāi)發(fā)的時(shí)候，經(jīng)常會(huì)遇到數(shù)據(jù)校驗(yàn)的問(wèn)題， 有時(shí)候可能默認(rèn)的校驗(yàn)器不足以滿足自己的需求， 這個(gè)時(shí)候就需要開(kāi)發(fā)一個(gè)自己的校驗(yàn)器

在 Spring Boot 中自定義參數(shù)校驗(yàn)器通常涉及以下幾個(gè)步驟：

1. 定義注解

首先需要定義一個(gè)自定義的注解，該注解將用于標(biāo)記需要校驗(yàn)的字段。

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;@Documented
// 實(shí)現(xiàn)真正校驗(yàn)邏輯的驗(yàn)證器
@Constraint(validatedBy = NotAllEmptyValidator.class)
// 注解放置于類上方
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotAllEmpty {String message() default "不允許所有參數(shù)為空";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};String[] fields default {};
}

在這個(gè)例子中，我們定義了一個(gè)名為 NotAllEmpty 的注解，并指定了它使用 NotAllEmptyValidator 類進(jìn)行驗(yàn)證。同時(shí)定義了默認(rèn)的錯(cuò)誤消息。

2. 創(chuàng)建校驗(yàn)器

接下來(lái)需要?jiǎng)?chuàng)建一個(gè)實(shí)現(xiàn) ConstraintValidator 接口的類來(lái)實(shí)現(xiàn)具體的校驗(yàn)邏輯。

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Collection;public class NotAllEmptyValidator implements ConstraintValidator<NotAllEmpty, Object> {@Overridepublic void initialize(NotAllEmpty constraintAnnotation) {// 可以在這里初始化一些配置項(xiàng)}@Overridepublic boolean isValid(Object value, ConstraintValidatorContext context) {// 加入自己的驗(yàn)證邏輯return false;}
}

這個(gè) NotAllEmptyValidator 類實(shí)現(xiàn)了 ConstraintValidator<NotAllEmpty, Object> 接口，其中 isValid 方法負(fù)責(zé)檢查傳入的集合是否為空。

3. 使用自定義注解

最后可以在需要校驗(yàn)的實(shí)體類或方法上使用這個(gè)自定義注解。

import javax.validation.constraints.NotNull;
import java.util.List;@NotAllEmpty(fields={"name", "age"})
public class MyEntity {private String name;private Integer age;// Getter and Setter
}

或者在控制器的方法參數(shù)上使用：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;@RestController
public class MyController {@PostMapping("/save")public String save(@RequestBody @NotAllEmpty MyEntity reqBody) {// ...}
}

4. 配置 Bean Validation

確保 Spring Boot 應(yīng)用已經(jīng)啟用了 Bean Validation，這通常是通過(guò)添加 spring-boot-starter-validation 依賴自動(dòng)完成的。

如果使用 Maven，可以添加如下依賴：

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

如果使用 Gradle，則添加：

implementation 'org.springframework.boot:spring-boot-starter-validation'

以上就是如何在 Spring Boot 中創(chuàng)建和使用自定義參數(shù)校驗(yàn)器的基本流程。你可以根據(jù)自己的需求調(diào)整注解和校驗(yàn)器的具體實(shí)現(xiàn)細(xì)節(jié)。

5. 參考文檔

Spring MVC Custom Validation
jboss相關(guān)章節(jié)