快捷導(dǎo)航

SpringBoot利用@Validated注解優(yōu)雅實(shí)現(xiàn)參數(shù)校驗(yàn)

更新時(shí)間：2025年04月09日 16:01:29 作者：浪浪山老周

在開發(fā) Web 應(yīng)用時(shí),用戶輸入的合法性校驗(yàn)是保障系統(tǒng)穩(wěn)定性的基礎(chǔ),?Spring Boot 的 @Validated 注解提供了一種更優(yōu)雅的解決方案,下面就跟隨小編一起學(xué)習(xí)一下吧

?一、為什么需要參數(shù)校驗(yàn)

在開發(fā) Web 應(yīng)用時(shí)，用戶輸入的合法性校驗(yàn)是保障系統(tǒng)穩(wěn)定性的基礎(chǔ)。傳統(tǒng)做法是通過 if-else 語句逐個(gè)判斷參數(shù)，但代碼臃腫、可讀性差且容易遺漏校驗(yàn)邏輯。?Spring Boot 的 @Validated 注解提供了一種更優(yōu)雅的解決方案，結(jié)合 JSR-303/380 規(guī)范，只需簡單注解即可實(shí)現(xiàn)復(fù)雜校驗(yàn)。

二、Validated 的核心用法

?1. 基礎(chǔ)校驗(yàn)

在實(shí)體類字段上添加校驗(yàn)注解（如 @NotBlank、@Email），并在控制器方法參數(shù)前添加 @Validated，即可自動(dòng)觸發(fā)校驗(yàn)。

示例代碼：

// 實(shí)體類  
public class UserDTO {  
    @NotBlank(message = "用戶名不能為空")  
    @Size(min = 3, max = 20, message = "長度需 3-20 位")  
    private String username;  
    
    @Email(message = "郵箱格式錯(cuò)誤")  
    private String email;  
}  

// 控制器  
@RestController  
public class UserController {  
    @PostMapping("/register")  
    public String register(@Validated @RequestBody UserDTO user) {  
        return "注冊(cè)成功！";  // 校驗(yàn)通過后執(zhí)行  
    }  
}

效果：若參數(shù)不合法，直接返回錯(cuò)誤信息，不會(huì)進(jìn)入方法體。

2. 分組校驗(yàn)

針對(duì)不同場景（如新增、更新）設(shè)置不同校驗(yàn)規(guī)則，通過 groups 參數(shù)實(shí)現(xiàn)精細(xì)化控制。

示例代碼：

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 = "預(yù)算不能低于 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 "修改成功！";  
    }  
}

效果：新增時(shí)校驗(yàn)預(yù)算，更新時(shí)校驗(yàn) ID。

3. 嵌套校驗(yàn)

對(duì)嵌套對(duì)象進(jìn)行級(jí)聯(lián)校驗(yàn)，只需在父對(duì)象字段添加 @Valid（注意：@Validated 無法直接用于嵌套對(duì)象）。

示例代碼：

public class User {  
    @NotBlank  
    private String name;  
    
    @Valid  
    private Address address;  // 嵌套對(duì)象需加 @Valid  
}  

public class Address {  
    @NotBlank  
    private String city;  
}  

???????// 控制器  
@PostMapping("/user")  
public String user(@Validated @RequestBody User user) {  
    return "校驗(yàn)通過！";  
}

效果：若 address.city 為空，直接返回錯(cuò)誤。

三、進(jìn)階技巧

?1. 自定義校驗(yàn)注解

當(dāng)內(nèi)置注解無法滿足需求時(shí)，可創(chuàng)建自定義注解。例如校驗(yàn)用戶名唯一性：

步驟：

定義注解 @UniqueUsername
實(shí)現(xiàn)校驗(yàn)器 UniqueUsernameValidator

代碼片段：

// 自定義注解  
@Target({ElementType.FIELD})  
@Retention(RetentionPolicy.RUNTIME)  
@Constraint(validatedBy = UniqueUsernameValidator.class)  
public @interface UniqueUsername {  
    String message() default "用戶名已存在";  
}  

???????// 校驗(yàn)器  
public class UniqueUsernameValidator implements ConstraintValidator<UniqueUsername, String> {  
    @Override  
    public boolean isValid(String username, ConstraintValidatorContext context) {  
        // 調(diào)用數(shù)據(jù)庫或緩存驗(yàn)證唯一性  
        return !"admin".equals(username);  // 示例邏輯  
    }  
}

使用：

public class UserDTO {  
    @UniqueUsername  
    private String username;  
}

效果：校驗(yàn)用戶名是否重復(fù)。

?2. 全局異常處理

通過 @RestControllerAdvice 統(tǒng)一處理校驗(yàn)異常，返回結(jié)構(gòu)化錯(cuò)誤信息：

代碼示例：

@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 格式錯(cuò)誤信息，如 {“username”:“用戶名不能為空”}。

四、總結(jié)

@Validated 不僅簡化了參數(shù)校驗(yàn)邏輯，還通過分組、嵌套校驗(yàn)和自定義注解提供了強(qiáng)大的擴(kuò)展性。結(jié)合全局異常處理，開發(fā)者可以專注于業(yè)務(wù)邏輯，而非重復(fù)的校驗(yàn)代碼。

實(shí)踐建議：

在 pom.xml 中添加依賴：

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

優(yōu)先使用 @Validated（Spring 特有），復(fù)雜場景結(jié)合 @Valid（Java 標(biāo)準(zhǔn)）。

到此這篇關(guān)于SpringBoot利用@Validated注解優(yōu)雅實(shí)現(xiàn)參數(shù)校驗(yàn)的文章就介紹到這了,更多相關(guān)SpringBoot @Validated參數(shù)校驗(yàn)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: