Spring利用@Validated注解實現(xiàn)參數(shù)校驗詳解
Spring Framework 提供了一套可以方便地對 Controller 層中接收的參數(shù)進(jìn)行校驗的框架，其中就包括了 @Validated 注解。在 Spring 項目中使用 @Validated 注解可以讓我們更加方便地進(jìn)行參數(shù)校驗，避免了手動校驗的麻煩，并且使得代碼更加優(yōu)雅和易于維護(hù)。本文將詳細(xì)介紹在 Spring 項目中使用 @Validated 進(jìn)行參數(shù)校驗的方法和常見應(yīng)用場景。
一、@Validated 注解簡介
@Validated 注解是 Spring Framework 中提供的一個參數(shù)校驗注解，它可以用來標(biāo)記需要進(jìn)行參數(shù)校驗的方法、類、方法參數(shù)和方法返回值等地方。通過使用 @Validated 注解，我們可以非常方便地對入?yún)⑦M(jìn)行檢查，并且可以自定義校驗規(guī)則和錯誤提示信息。
引入依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>二、@Validated 注解的使用
2.1 在 Controller 層中使用
在 Controller 層中使用 @Validated 注解是最為常見的使用場景。通過在 Controller 方法的參數(shù)上添加 @Validated 注解，可以對該參數(shù)進(jìn)行校驗。下面是一個簡單的例子：
@RestController
@RequestMapping("/api/user")
public class UserController {
@PostMapping
public User createUser(@RequestBody @Validated User user) {
// ...
}
}在上述代碼中，@Validated 注解標(biāo)記了 User 類型的參數(shù)，表示需要對該參數(shù)進(jìn)行校驗。如果 User 類中存在校驗注解，那么這些注解會自動觸發(fā)校驗過程。如果校驗不通過，則會拋出 MethodArgumentNotValidException 異常。
2.2 自定義校驗規(guī)則
在使用 @Validated 注解進(jìn)行參數(shù)校驗時，我們常常需要自定義校驗規(guī)則。Spring Framework 提供了多種自定義校驗規(guī)則的方式，包括使用注解實現(xiàn)、編寫自定義 Validator 等方式。
2.2.1 使用注解實現(xiàn)
可以通過編寫注解來進(jìn)行自定義校驗規(guī)則的實現(xiàn)。例如，下面是一個用于校驗手機(jī)號碼格式的注解：
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PhoneValidator.class)
public @interface Phone {
String message() default "手機(jī)號碼格式不正確";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}在上述代碼中，@Phone 注解用于標(biāo)記需要進(jìn)行手機(jī)號碼格式校驗的字段，而 @Constraint 注解指定了具體的校驗邏輯類 PhoneValidator。PhoneValidator 實現(xiàn)了 ConstraintValidator 接口，完成對手機(jī)號碼格式的校驗。
接下來，我們來看一下 PhoneValidator 的實現(xiàn)：
public class PhoneValidator implements ConstraintValidator<Phone, String> {
private final static Pattern PHONE_PATTERN = Pattern.compile("^1\\d{10}$");
@Override
public void initialize(Phone constraintAnnotation) {
}
@Override
public boolean isValid(String phone, ConstraintValidatorContext context) {
return StringUtils.isEmpty(phone) || PHONE_PATTERN.matcher(phone).matches();
}
}在 PhoneValidator 的 isValid 方法中，我們使用了正則表達(dá)式來判斷手機(jī)號碼的格式是否正確。如果格式不正確，則返回 false，并且可以通過 context 參數(shù)來設(shè)置錯誤提示信息。
使用上述自定義注解實現(xiàn)的校驗規(guī)則，可以和 Spring 自帶的校驗注解一樣，方便地被應(yīng)用到 Controller 層中。
2.2.2 編寫自定義 Validator
除了使用注解來實現(xiàn)自定義校驗規(guī)則以外，還可以編寫自定義 Validator 來實現(xiàn)具體的校驗邏輯。
下面是一個簡單的示例，用于校驗兩個整數(shù)的大小關(guān)系：
public class ComparisonValidator implements ConstraintValidator<Comparison, Object> {
private Comparison.Operator operator;
private String valueFieldName;
@Override
public void initialize(Comparison constraintAnnotation) {
operator = constraintAnnotation.operator();
valueFieldName = constraintAnnotation.valueFieldName();
}
@Override
public boolean isValid(Object value, ConstraintValidatorContext context) {
if (value == null) {
return true;
}
try {
Field valueField = value.getClass().getDeclaredField(valueFieldName);
valueField.setAccessible(true);
Object otherValue = valueField.get(value);
if (otherValue == null) {
return true;
}
int result = ((Comparable) value).compareTo(otherValue);
switch (operator) {
case GREATER_THAN:
return result > 0;
case LESS_THAN:
return result < 0;
case GREATER_THAN_OR_EQUAL_TO:
return result >= 0;
case LESS_THAN_OR_EQUAL_TO:
return result <= 0;
default:
throw new IllegalArgumentException("Unsupported Comparison Operator: " + operator);
}
} catch (NoSuchFieldException | IllegalAccessException e) {
throw new RuntimeException(e);
}
}
}在上述代碼中，我們定義了一個 ComparisonValidator 類，它實現(xiàn)了 ConstraintValidator 接口，并且自定義了一個校驗規(guī)則 @Comparison。
該校驗規(guī)則需要通過 operator 和 valueFieldName 兩個屬性來確定具體的比較方式和被比較的屬性名稱。在 isValid 方法中，我們首先獲取到被比較的屬性值 otherValue，然后根據(jù) operator 來判斷 value 是否大于（小于、等于）otherValue。
使用自定義 Validator 需要手動創(chuàng)建校驗邏輯類，并將其與注解進(jìn)行關(guān)聯(lián)。在 Controller 層使用時，我們可以像使用 Spring 自帶的校驗注解一樣來使用自定義的校驗注解。
2.3 組合注解
有時候，我們需要對同一個參數(shù)進(jìn)行多種校驗，這時候可以使用組合注解的方式來實現(xiàn)。例如，下面是一個用于校驗密碼格式的組合注解示例：
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {})
@Pattern(regexp = "^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[@#$%^&+=])(?=\\S+$).{8,}$", message = "密碼必須包含大小寫字母、數(shù)字和特殊字符，長度至少為 8 位")
@NotNull(message = "密碼不能為空")
public @interface Password {
String message() default "密碼格式不正確";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}在上述代碼中，@Password 注解通過組合 @Pattern 和 @NotNull 注解來實現(xiàn)了密碼的格式校驗。如果密碼格式不正確或者為空，則會拋出校驗異常。
在使用組合注解時，需要注意被組合的注解是否已經(jīng)使用了 @Constraint 注解，并且不要忘記設(shè)置 message、groups 和 payload 等屬性。
2.4 統(tǒng)一異常處理
在使用 @Validated 進(jìn)行參數(shù)校驗時，如果校驗失敗，會拋出 MethodArgumentNotValidException 異常。為了提高代碼的可維護(hù)性，我們可以通過在 Controller 層添加 @ExceptionHandler 注解并捕獲該異常，來統(tǒng)一處理校驗失敗的情況。
例如，下面是一個簡單的異常處理示例：
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
public Map<String, Object> handleValidationException(MethodArgumentNotValidException ex) {
BindingResult bindingResult = ex.getBindingResult();
List<String> errorList = bindingResult.getAllErrors().stream()
.map(DefaultMessageSourceResolvable::getDefaultMessage)
.collect(Collectors.toList());
return Collections.singletonMap("message", errorList);
}
}在上述代碼中，我們通過在 GlobalExceptionHandler 類中添加 @RestControllerAdvice 和 @ExceptionHandler 注解來統(tǒng)一處理 MethodArgumentNotValidException 異常。在 handleValidationException 方法中，我們首先獲取到 BindingResult 對象，并通過遍歷所有錯誤信息來收集錯誤提示信息。最終返回一個包含錯誤提示信息的 Map 對象。
三、@Validated 注解的常見應(yīng)用場景
@Validated 注解作為 Spring Framework 中的一個參數(shù)校驗注解，廣泛應(yīng)用于 Controller 層的參數(shù)校驗、DTO 類的參數(shù)校驗和業(yè)務(wù)類的參數(shù)校驗等方面。下面列舉了幾個常見的應(yīng)用場景：
1.數(shù)據(jù)庫操作時的參數(shù)校驗：數(shù)據(jù)庫操作一般需要對參數(shù)進(jìn)行校驗，避免因為無效參數(shù)導(dǎo)致的 SQL 注入等安全問題。
2.DTO 類的參數(shù)校驗：在使用 DTO（Data Transfer Object）類進(jìn)行數(shù)據(jù)傳輸時，往往需要對傳輸?shù)淖侄芜M(jìn)行校驗，保證數(shù)據(jù)的有效性和完整性。
3.業(yè)務(wù)類的參數(shù)校驗：業(yè)務(wù)類中的方法通常也需要對參數(shù)進(jìn)行校驗，以確保業(yè)務(wù)邏輯的正確性和可靠性。
四、常用的驗證注解
1.@NotNull 注解
@NotNull 表示被注解的參數(shù)不能為 null。
例如：
public void testNotNull(@NotNull String str) {}2.@Size 注解
@Size 表示被注解的參數(shù)的大小必須在指定的范圍內(nèi)（包括最小值和最大值）。
例如：
public void testSize(@Size(min = 1, max = 10) String str) {}3.@Min 和 @Max 注解
@Min 和 @Max 分別表示被注解的參數(shù)的最小值和最大值。
例如：
public void testMin(@Min(18) int age) {}
public void testMax(@Max(100) int score) {}4.@DecimalMin 和 @DecimalMax 注解
@DecimalMin 和 @DecimalMax 分別表示被注解的參數(shù)的最小值和最大值，適用于浮點(diǎn)數(shù)、BigDecimal 或 BigInteger 類型的參數(shù)。
例如：
public void testDecimalMin(@DecimalMin("0.00") BigDecimal price) {}
public void testDecimalMax(@DecimalMax("100.00") BigDecimal score) {}5.@Digits 注解
@Digits 表示被注解的參數(shù)必須是一個數(shù)字，并且整數(shù)位和小數(shù)位的位數(shù)不能超過指定的值（默認(rèn)整數(shù)位 2 位，小數(shù)位 0 位）。
例如：
public void testDigits(@Digits(integer = 2, fraction = 1) BigDecimal num) {}6.@Email 注解
@Email 表示被注解的參數(shù)必須是一個合法的電子郵件地址。
例如：
public void testEmail(@Email String email) {}7.@Pattern 注解
@Pattern 表示被注解的參數(shù)必須符合指定的正則表達(dá)式模式。
例如：
public void testPattern(@Pattern(regexp = "^\\d{4}-\\d{1,2}-\\d{1,2}$") String date) {}除了使用單個注解外，也可以使用組合注解來完成更為復(fù)雜的校驗邏輯。
例如：
@NotNull(message = "用戶名不能為空")
@Size(min = 5, max = 20, message = "用戶名長度必須在 5 到 20 之間")
public String getUsername() {
return this.username;
}上述代碼表示要求用戶名不能為空，并且在長度范圍內(nèi)。如果不符合要求，則會拋出相應(yīng)的異常，如 MethodArgumentNotValidException 等。
到此這篇關(guān)于Spring利用@Validated注解實現(xiàn)參數(shù)校驗詳解的文章就介紹到這了,更多相關(guān)Spring Validated內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
- 使用@Validated和@Valid 解決list校驗的問題
- Java中的三種校驗注解的使用(@Valid,@Validated和@PathVariable)
- spring @Validated 注解開發(fā)中使用group分組校驗的實現(xiàn)
- Java參數(shù)校驗@Validated、@Valid介紹及使用詳解
- SpringBoot參數(shù)校驗之@Validated的使用詳解
- @Valid和@Validated注解校驗以及異常處理方式
- 使用@Validated注解進(jìn)行校驗卻沒有效果的解決
- Spring 中@Validated 分組校驗的使用解析
- JAVA校驗之@Valid和@Validated實踐指南
相關(guān)文章
javaSE,javaEE,javaME的區(qū)別小結(jié)
本篇文章小編就為大家簡單說說JavaSE、JavaEE、JavaME三者之間的區(qū)別,需要的朋友可以過來參考下,感興趣的小伙伴們可以參考一下2023-08-08
本文主要介紹了Java啟動Tomcat的實現(xiàn)步驟，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-05-05
IntelliJ IDEA 安裝及初次使用圖文教程（2020.3.2社區(qū)版）
這篇文章主要介紹了IntelliJ IDEA 安裝及初次使用（2020.3.2社區(qū)版）,本文通過圖文并茂的形式給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-03-03
Spring Boot實現(xiàn)STOMP協(xié)議的WebSocket的方法步驟
這篇文章主要介紹了Spring Boot實現(xiàn)STOMP協(xié)議的WebSocket的方法步驟，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-05-05
SpringBoot中使用Servlet三大組件的方法(Servlet、Filter、Listener)
這篇文章主要介紹了SpringBoot中使用Servlet三大組件的方法(Servlet、Filter、Listener),本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-01-01
這篇文章主要介紹了SpringMVC中的表現(xiàn)層結(jié)果封裝，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-11-11
在本篇文章里小編給大家整理了關(guān)于創(chuàng)建java虛擬機(jī)失敗的解決方法和知識點(diǎn)，需要的朋友們可以參考學(xué)習(xí)下。2020-02-02
Java Socket聊天室編程(二)之利用socket實現(xiàn)單聊聊天室
這篇文章主要介紹了Java Socket聊天室編程(二)之利用socket實現(xiàn)單聊聊天室的相關(guān)資料,非常不錯，具有參考借鑒價值，需要的朋友可以參考下2016-09-09
這篇文章主要介紹了Java編程中的boolean對象的運(yùn)用,是Java入門學(xué)習(xí)中的基礎(chǔ)知識,需要的朋友可以參考下2015-10-10
這篇文章主要介紹了java中List接口的方法詳解,List接口是繼承Collection接口，所以Collection集合中有的方法，List集合也繼承過來,本文主要介紹一下list下的方法,需要的朋友可以參考下2023-10-10