SpringBoot利用@Validated注解優(yōu)雅實現參數校驗
?一、為什么需要參數校驗
在開發(fā) Web 應用時,用戶輸入的合法性校驗是保障系統穩(wěn)定性的基礎。傳統做法是通過 if-else 語句逐個判斷參數,但代碼臃腫、可讀性差且容易遺漏校驗邏輯。?Spring Boot 的 @Validated 注解 提供了一種更優(yōu)雅的解決方案,結合 JSR-303/380 規(guī)范,只需簡單注解即可實現復雜校驗。
二、Validated 的核心用法
?1. 基礎校驗
在實體類字段上添加校驗注解(如 @NotBlank、@Email),并在控制器方法參數前添加 @Validated,即可自動觸發(fā)校驗。
示例代碼:
// 實體類
public class UserDTO {
@NotBlank(message = "用戶名不能為空")
@Size(min = 3, max = 20, message = "長度需 3-20 位")
private String username;
@Email(message = "郵箱格式錯誤")
private String email;
}
// 控制器
@RestController
public class UserController {
@PostMapping("/register")
public String register(@Validated @RequestBody UserDTO user) {
return "注冊成功!"; // 校驗通過后執(zhí)行
}
}
效果: 若參數不合法,直接返回錯誤信息,不會進入方法體。
2. 分組校驗
針對不同場景(如新增、更新)設置不同校驗規(guī)則,通過 groups 參數實現精細化控制。
示例代碼:
public interface ValidationGroups {
interface Insert extends Default {} // 新增分組
interface Update extends Default {} // 更新分組
}
public class Project {
@NotBlank(groups = Update.class, message = "ID 不能為空")
private String id;
@Min(value = 1000, groups = Insert.class, message = "預算不能低于 1000")
private int budget;
}
???????// 控制器
@RestController
public class ProjectController {
@PostMapping("/add")
public String addProject(
@Validated(Insert.class) @RequestBody Project project) {
return "新增成功!";
}
@PostMapping("/modify")
public String modifyProject(
@Validated(Update.class) @RequestBody Project project) {
return "修改成功!";
}
} 效果: 新增時校驗預算,更新時校驗 ID。
3. 嵌套校驗
對嵌套對象進行級聯校驗,只需在父對象字段添加 @Valid(注意:@Validated 無法直接用于嵌套對象)。
示例代碼:
public class User {
@NotBlank
private String name;
@Valid
private Address address; // 嵌套對象需加 @Valid
}
public class Address {
@NotBlank
private String city;
}
???????// 控制器
@PostMapping("/user")
public String user(@Validated @RequestBody User user) {
return "校驗通過!";
} 效果: 若 address.city 為空,直接返回錯誤。
三、進階技巧
?1. 自定義校驗注解
當內置注解無法滿足需求時,可創(chuàng)建自定義注解。例如校驗用戶名唯一性:
步驟:
- 定義注解 @UniqueUsername
- 實現校驗器 UniqueUsernameValidator
代碼片段:
// 自定義注解
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = UniqueUsernameValidator.class)
public @interface UniqueUsername {
String message() default "用戶名已存在";
}
???????// 校驗器
public class UniqueUsernameValidator implements ConstraintValidator<UniqueUsername, String> {
@Override
public boolean isValid(String username, ConstraintValidatorContext context) {
// 調用數據庫或緩存驗證唯一性
return !"admin".equals(username); // 示例邏輯
}
} 使用:
public class UserDTO {
@UniqueUsername
private String username;
}
效果: 校驗用戶名是否重復。
?2. 全局異常處理
通過 @RestControllerAdvice 統一處理校驗異常,返回結構化錯誤信息:
代碼示例:
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
public Map<String, String> handleValidationExceptions(
MethodArgumentNotValidException ex) {
Map<String, String> errors = new HashMap<>();
ex.getBindingResult().getAllErrors().forEach((error) -> {
String fieldName = ((FieldError) error).getField();
String errorMessage = error.getDefaultMessage();
errors.put(fieldName, errorMessage);
});
return errors;
}
}
效果: 返回 JSON 格式錯誤信息,如 {“username”:“用戶名不能為空”}。
四、總結
@Validated 不僅簡化了參數校驗邏輯,還通過分組、嵌套校驗和自定義注解提供了強大的擴展性。結合全局異常處理,開發(fā)者可以專注于業(yè)務邏輯,而非重復的校驗代碼。
實踐建議:
在 pom.xml 中添加依賴:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
優(yōu)先使用 @Validated(Spring 特有),復雜場景結合 @Valid(Java 標準)。
到此這篇關于SpringBoot利用@Validated注解優(yōu)雅實現參數校驗的文章就介紹到這了,更多相關SpringBoot @Validated參數校驗內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Java使用RandomAccessFile類對文件進行讀寫
本篇文章主要介紹了Java使用RandomAccessFile類對文件進行讀寫,詳細的介紹了RandomAccessFile類的使用技巧和實例應用,有興趣的可以了解一下2017-04-04
SpringMVC使用MultipartFile 實現異步上傳方法介紹
這篇文章主要介紹了SpringMVC使用MultipartFile 實現異步上傳方法介紹,涉及pom依賴的添加,配置文件的修改等具體操作代碼,需要的朋友可以了解下。2017-09-09
詳解Spring boot/Spring 統一錯誤處理方案的使用
這篇文章主要介紹了詳解Spring boot/Spring 統一錯誤處理方案的使用,小編覺得挺不錯的,現在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-06-06
Maven項目如何在pom文件中引入lib下的第三方jar包并打包進去
在使用Maven進行項目開發(fā)時,引入第三方私有的Jar包可能會遇到問題,一種常見的解決方案是將Jar包添加到項目的lib目錄,并通過IDE進行配置,但這需要每個開發(fā)者單獨操作,效率低下,更好的方法是通過Maven的pom.xml文件管理這些Jar包2024-09-09

