建站
咨詢
售后
建站咨詢
新聞中心
介紹
作為一名開發(fā)人員，你應(yīng)該知道確保應(yīng)用程序中流動的數(shù)據(jù)的準(zhǔn)確性和完整性是多么重要。Spring Boot提供了強(qiáng)大的驗(yàn)證功能，但有時(shí)我們需要額外的驗(yàn)證，創(chuàng)建適合特定需求的自定義驗(yàn)證器。
接下來，我們來介紹下如何完整的創(chuàng)建一個(gè)自定義驗(yàn)證器。
步驟1：準(zhǔn)備Spring Boot應(yīng)用程序
首先，確保你已經(jīng)設(shè)置了一個(gè)Spring Boot項(xiàng)目。可以選擇使用Maven或Gradle作為構(gòu)建工具。在項(xiàng)目的配置文件（pom.xml或build.gradle）中包含必要的依賴項(xiàng)，如spring-boot-starter-web和
spring-boot-starter-validation。
步驟2：創(chuàng)建模型類
創(chuàng)建一個(gè)模型類來表示要驗(yàn)證的數(shù)據(jù)。例如，創(chuàng)建一個(gè)簡單的User類，包含一個(gè)用戶名和電子郵件字段：
public class User {
private String username;
private String email;
// getters and setters
}步驟3：創(chuàng)建自定義驗(yàn)證器
接下來，通過實(shí)現(xiàn)org.springframework.validation.Validator接口來創(chuàng)建一個(gè)自定義驗(yàn)證器類。該接口定義了supports()和validate()兩個(gè)方法。
supports()方法檢查驗(yàn)證器是否支持給定的類。在我們的例子中，我們想要驗(yàn)證User類，所以如果提供的類是User類或其子類之一，則該方法應(yīng)返回true。
validate()方法執(zhí)行實(shí)際的驗(yàn)證邏輯，我們可以訪問正在驗(yàn)證的對象，執(zhí)行檢查，并使用
org.springframework.validation.Errors對象添加驗(yàn)證錯誤。
以下是User類的自定義驗(yàn)證器示例：
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：注冊自定義驗(yàn)證器
為了讓Spring Boot知道自定義驗(yàn)證器，我們需要進(jìn)行注冊。打開應(yīng)用程序的配置類（通常使用@Configuration注解），并添加一個(gè)@Bean方法來實(shí)例化自定義驗(yàn)證器。
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：使用自定義驗(yàn)證器
要將自定義驗(yàn)證器應(yīng)用于所需的端點(diǎn)，需要使用@Valid注解相應(yīng)的方法參數(shù)，來觸發(fā)該對象的驗(yàn)證過程。例如，有一個(gè)用于創(chuàng)建新用戶的RESTful端點(diǎn)：
@RestController
@RequestMapping("/users")
public class UserController {
@PostMapping
public ResponseEntity createUser(@Valid @RequestBody User user) {
// 處理用戶創(chuàng)建邏輯
return ResponseEntity.ok("User created successfully");
}
} 在這個(gè)例子中，對user參數(shù)使用@Valid注解表示應(yīng)該使用注冊的自定義驗(yàn)證器進(jìn)行驗(yàn)證。
步驟6：提供錯誤消息
為了給自定義驗(yàn)證約束提供有意義的錯誤消息，需要在項(xiàng)目的src/main/resources目錄中創(chuàng)建一個(gè)messages.properties文件。該文件用于不同的驗(yàn)證約束定義自定義錯誤消息。打開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在上面的示例中，我們?yōu)镹otEmpty和Size約束定義了錯誤消息。
步驟7：測試自定義驗(yàn)證器
現(xiàn)在，我們可以通過觸發(fā)驗(yàn)證過程來測試自定義驗(yàn)證器。如果發(fā)生任何驗(yàn)證錯誤，它們將自動添加到BindingResult對象中。例如，假設(shè)有一個(gè)用于創(chuàng)建新用戶的請求：
POST /users
Content-Type: application/json
{
"username": "",
"email": "test@example.com"
}當(dāng)發(fā)送這個(gè)請求時(shí)，驗(yàn)證過程將被觸發(fā)，如果用戶名字段為空，將會向BindingResult中添加一個(gè)驗(yàn)證錯誤。
為了處理驗(yàn)證錯誤，我們可以修改UserController中的createUser方法，如下所示：
@PostMapping
public ResponseEntity createUser(@Valid @RequestBody User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
// 處理驗(yàn)證錯誤
List errors = bindingResult.getAllErrors();
// 按需處理并返回錯誤消息
// 示例: return ResponseEntity.badRequest().body(errors.toString());
}
// 如果驗(yàn)證通過，繼續(xù)處理用戶創(chuàng)建邏輯
return ResponseEntity.ok("User created successfully");
} 在這個(gè)例子中，如果存在驗(yàn)證錯誤，可以使用bindingResult.getAllErrors()從BindingResult對象中檢索錯誤。然后，根據(jù)應(yīng)用程序的需求處理和處理這些錯誤。
這樣，我們已經(jīng)成功地在Spring Boot應(yīng)用程序中創(chuàng)建并使用了自定義驗(yàn)證器。自定義驗(yàn)證器允許我們?yōu)樘囟ㄗ侄位驅(qū)ο蠖x自己的驗(yàn)證邏輯和錯誤消息，從而控制驗(yàn)證過程。
網(wǎng)站題目：如何優(yōu)雅構(gòu)建自定義SpringBoot驗(yàn)證器，讓你的代碼更加絲滑！
地址分享：http://m.5511xx.com/article/coeospi.html
