如何優雅構建自定義 Spring Boot 驗證器，讓你的代碼更加絲滑！
介紹
作為一名開發人員，你應該知道確保應用程序中流動的數據的準確性和完整性是多么重要。Spring Boot提供了強大的驗證功能，但有時我們需要額外的驗證，創建適合特定需求的自定義驗證器。
接下來，我們來介紹下如何完整的創建一個自定義驗證器。
步驟1：準備Spring Boot應用程序
首先，確保你已經設置了一個Spring Boot項目。可以選擇使用Maven或Gradle作為構建工具。在項目的配置文件（pom.xml或build.gradle）中包含必要的依賴項，如spring-boot-starter-web和
spring-boot-starter-validation。
步驟2：創建模型類
創建一個模型類來表示要驗證的數據。例如，創建一個簡單的User類，包含一個用戶名和電子郵件字段：
public class User {
private String username;
private String email;
// getters and setters
}步驟3：創建自定義驗證器
接下來，通過實現org.springframework.validation.Validator接口來創建一個自定義驗證器類。該接口定義了supports()和validate()兩個方法。
supports()方法檢查驗證器是否支持給定的類。在我們的例子中，我們想要驗證User類，所以如果提供的類是User類或其子類之一，則該方法應返回true。
validate()方法執行實際的驗證邏輯，我們可以訪問正在驗證的對象，執行檢查，并使用
org.springframework.validation.Errors對象添加驗證錯誤。
以下是User類的自定義驗證器示例：
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;
public class UserValidator implements Validator {
@Override
public boolean supports(Class<?> clazz) {
return User.class.equals(clazz);
}
@Override
public void validate(Object target, Errors errors) {
User user = (User) target;
ValidationUtils.rejectIfEmptyOrWhitespace(errors, "username", "NotEmpty");
ValidationUtils.rejectIfEmptyOrWhitespace(errors, "email", "NotEmpty");
// Add additional validation logic
// Example:
// if (user.getUsername().length() < 5) {
// errors.rejectValue("username", "Size.userForm.username");
// }
}
}步驟4：注冊自定義驗證器
為了讓Spring Boot知道自定義驗證器，我們需要進行注冊。打開應用程序的配置類（通常使用@Configuration注解），并添加一個@Bean方法來實例化自定義驗證器。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.Validator;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
@Configuration
public class AppConfig {
@Bean
public Validator validator() {
return new UserValidator();
}
// 其他配置類和方法...
}步驟5：使用自定義驗證器
要將自定義驗證器應用于所需的端點，需要使用@Valid注解相應的方法參數，來觸發該對象的驗證過程。例如，有一個用于創建新用戶的RESTful端點：
@RestController
@RequestMapping("/users")
public class UserController {
@PostMapping
public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
// 處理用戶創建邏輯
return ResponseEntity.ok("User created successfully");
}
}在這個例子中，對user參數使用@Valid注解表示應該使用注冊的自定義驗證器進行驗證。
步驟6：提供錯誤消息
為了給自定義驗證約束提供有意義的錯誤消息，需要在項目的src/main/resources目錄中創建一個messages.properties文件。該文件用于不同的驗證約束定義自定義錯誤消息。打開messages.properties文件并添加以下條目：
# 自定義錯誤消息
NotEmpty.user.username=Username cannot be empty
NotEmpty.user.email=Email cannot be empty
Size.userForm.username=Username must be at least 5 characters long在上面的示例中，我們為NotEmpty和Size約束定義了錯誤消息。
步驟7：測試自定義驗證器
現在，我們可以通過觸發驗證過程來測試自定義驗證器。如果發生任何驗證錯誤，它們將自動添加到BindingResult對象中。例如，假設有一個用于創建新用戶的請求：
POST /users
Content-Type: application/json
{
"username": "",
"email": "test@example.com"
}當發送這個請求時，驗證過程將被觸發，如果用戶名字段為空，將會向BindingResult中添加一個驗證錯誤。
為了處理驗證錯誤，我們可以修改UserController中的createUser方法，如下所示：
@PostMapping
public ResponseEntity<String> createUser(@Valid @RequestBody User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
// 處理驗證錯誤
List<ObjectError> errors = bindingResult.getAllErrors();
// 按需處理并返回錯誤消息
// 示例: return ResponseEntity.badRequest().body(errors.toString());
}
// 如果驗證通過，繼續處理用戶創建邏輯
return ResponseEntity.ok("User created successfully");
}在這個例子中，如果存在驗證錯誤，可以使用bindingResult.getAllErrors()從BindingResult對象中檢索錯誤。然后，根據應用程序的需求處理和處理這些錯誤。
這樣，我們已經成功地在Spring Boot應用程序中創建并使用了自定義驗證器。自定義驗證器允許我們為特定字段或對象定義自己的驗證邏輯和錯誤消息，從而控制驗證過程。
