快捷導(dǎo)航

SpringBoot項(xiàng)目使用validated實(shí)現(xiàn)參數(shù)校驗(yàn)框架

更新時(shí)間：2024年05月30日 09:13:44 作者：風(fēng)止?

當(dāng)談到Spring的參數(shù)校驗(yàn)功能時(shí),@Validated注解無疑是一個(gè)重要的利器,它為我們提供了一種簡(jiǎn)單而又強(qiáng)大的方式來驗(yàn)證請(qǐng)求參數(shù)的合法性,保證了系統(tǒng)的穩(wěn)定性和安全性,本文將介紹Spring Validated的基本用法以及在實(shí)際項(xiàng)目中的應(yīng)用,需要的朋友可以參考下

引言

當(dāng)談到Spring的參數(shù)校驗(yàn)功能時(shí)，@Validated注解無疑是一個(gè)重要的利器。它為我們提供了一種簡(jiǎn)單而又強(qiáng)大的方式來驗(yàn)證請(qǐng)求參數(shù)的合法性，保證了系統(tǒng)的穩(wěn)定性和安全性。本文將介紹Spring Validated的基本用法以及在實(shí)際項(xiàng)目中的應(yīng)用。

一、validated是什么？

@Validated注解的作用和使用方法

可以用于Controller類或方法上，開啟對(duì)請(qǐng)求參數(shù)的校驗(yàn)功能。
通過在方法參數(shù)上使用其他校驗(yàn)注解（如@NotNull、@NotBlank、@Min、@Max等），對(duì)請(qǐng)求參數(shù)進(jìn)行校驗(yàn)和驗(yàn)證，確保參數(shù)的合法性。
可配合使用Spring Validation API或其他支持JSR-303規(guī)范的驗(yàn)證框架（如Hibernate Validator），發(fā)揮@Validated注解的最大效用。
@Validated注解的實(shí)際應(yīng)用示例

編寫一個(gè)用戶注冊(cè)接口，結(jié)合@Pattern注解對(duì)用戶名和密碼進(jìn)行格式校驗(yàn)。
處理校驗(yàn)失敗時(shí)的異常情況，并返回友好的錯(cuò)誤信息給接口調(diào)用方。
@Validated注解的注意事項(xiàng)和最佳實(shí)踐

討論@Validated注解在復(fù)雜校驗(yàn)場(chǎng)景下的使用技巧。
如何在全局配置文件中聲明驗(yàn)證器或配置驗(yàn)證規(guī)則，使得@Validated注解更加靈活地適應(yīng)各種項(xiàng)目需求。

二、使用步驟

1.引入maven依賴

代碼如下（示例）：

<!--        Validation合法性校驗(yàn)(參數(shù))  參數(shù)校驗(yàn)框架的依賴-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

2.使用實(shí)現(xiàn)

代碼如下參數(shù)長(zhǎng)度在 5 - 16位（示例）：

/**
 * @Description: 用戶相關(guān)的控制層
 * @Author: windStop
 * @Date: 2024/5/26 16:18
 */
@RestController
@RequestMapping("/user")
@Validated  //啟用參數(shù)校驗(yàn)功能
public class UserController {
    @Autowired
    private UserService userService;

    /**
     * 用于注冊(cè)新用戶  在注冊(cè)用戶的時(shí)候需要先判斷用戶名是否存在，因?yàn)橛脩裘豢梢灾貜?fù)
     * 這里我不打算使用給用戶名添加唯一字段
     * @param username 用戶名
     * @param password 密碼
     * @return 是否注冊(cè)成功
     */
    @PostMapping("/register")
    public Result register(@Pattern(regexp = "^\\S{5,16}") String username, @Pattern(regexp = "^\\S{5,16}")String password){
        //1.判斷用戶是否存在
        if (userService.findByUsername(username)){
            return Result.error("用戶名已存在無法注冊(cè)");
        }
        //2.不存在進(jìn)行注冊(cè)
        boolean flag = userService.register(username,password);
        return Result.success(flag);
    }

}

總結(jié)

通過本文的學(xué)習(xí)，讀者將深入了解Spring Validated的使用方法和原理，掌握在實(shí)際項(xiàng)目中如何有效地利用@Validated注解進(jìn)行參數(shù)校驗(yàn)。希望本文能夠?yàn)槟赟pring項(xiàng)目開發(fā)中遇到的參數(shù)校驗(yàn)問題提供一些啟發(fā)和幫助。如有需要進(jìn)一步了解或其他問題，請(qǐng)隨時(shí)告訴我。

以上就是SpringBoot項(xiàng)目使用validated實(shí)現(xiàn)參數(shù)校驗(yàn)框架的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot validated參數(shù)校驗(yàn)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: