Springboot使用validation優(yōu)雅校驗(yàn)參數(shù)

IT那活兒發(fā)布于2023-01-11 13:20 / 2037人閱讀

點(diǎn)擊上方藍(lán)字關(guān)注我們

使用背景

通常我們?cè)诰帉?xiě)后端接口時(shí)，一般都需要對(duì)參數(shù)（請(qǐng)求數(shù)據(jù)）進(jìn)行校驗(yàn)。參數(shù)校驗(yàn)的重要性自然不必多說(shuō)，先來(lái)看一下我們通常是如何進(jìn)行參數(shù)校驗(yàn)的？

StringaddUser(User user) {
// 參數(shù)校驗(yàn)
if (user == null || user.getId() == null || user.getAccount() ==null || user.getPassword() == null || user.getEmail() == null) {
return "對(duì)象或者對(duì)象字段不能為空";
}
if (StringUtils.isEmpty(user.getAccount()) ||StringUtils.isEmpty(user.getPassword()) ||StringUtils.isEmpty(user.getEmail())) {
return"不能輸入空字符串";
}
if (user.getAccount().length() < 5 ||user.getAccount().length() > 10) {
return"賬號(hào)長(zhǎng)度必須是5-10個(gè)字符";
}
if (user.getPassword().length() < 5 ||user.getPassword().length() > 10) {
return"密碼長(zhǎng)度必須是5-10個(gè)字符";
}
if(!Pattern.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(.[a-zA-Z0-9_-]+)+$",user.getEmail())) {
return "郵箱格式不正確";
}
// 執(zhí)行業(yè)務(wù)邏輯
// do something
return "true";
}

如上所見(jiàn)，我們最常見(jiàn)的做法就是在業(yè)務(wù)層使用if-else進(jìn)行校驗(yàn)，這種做法在邏輯上沒(méi)有問(wèn)題，同樣也能實(shí)現(xiàn)預(yù)期效果。但是這種做法過(guò)于繁瑣，在業(yè)務(wù)層包含了大量的校驗(yàn)代碼，實(shí)在不夠優(yōu)雅，失去了可讀性以及美觀(guān)程度。

為了解決這些問(wèn)題，我們可以使用SpringValidation來(lái)改進(jìn)參數(shù)校驗(yàn)方式。

如何使用

首先，需要引入相關(guān)依賴(lài)：

org.springframework.boot
spring-boot-starter-validation

引入依賴(lài)后我們就可以使用validation了，接下來(lái)看下具體使用方式：

1、為實(shí)體類(lèi)的參數(shù)添加相應(yīng)注解

springvalidation可以很方便的制定校驗(yàn)規(guī)則，并且能自動(dòng)完成校驗(yàn)。我們只要在需要校驗(yàn)的字段上加入相關(guān)注解，同時(shí)可以指定校驗(yàn)失敗的提示信息。

注：下面表格中列出一些常用校驗(yàn)注解供參考。

注解	功能
@AssertFalse	可以為null,如果不為null的話(huà)必須為false
@AssertTrue	可以為null,如果不為null的話(huà)必須為true
@DecimalMax	設(shè)置不能超過(guò)最大值
@DecimalMin	設(shè)置不能超過(guò)最小值
@Digits	設(shè)置必須是數(shù)字且數(shù)字整數(shù)的位數(shù)和小數(shù)的位數(shù)必須在指定范圍內(nèi)
@Future	日期必須在當(dāng)前日期的未來(lái)
@Past	日期必須在當(dāng)前日期的過(guò)去
@Max	最大不得超過(guò)此最大值
@Min	最大不得小于此最小值
@NotNull	不能為null，可以是空
@Null	必須為null
@Pattern	必須滿(mǎn)足指定的正則表達(dá)式
@Size	集合、數(shù)組、map等的size()值必須在指定范圍內(nèi)
@Email	必須是email格式
@Length	長(zhǎng)度必須在指定范圍內(nèi)
@NotBlank	字符串不能為null,字符串trim()后也不能等于“”
@NotEmpty	不能為null，集合、數(shù)組、map等size()不能為0；字符串trim()后可以等于“”
@Range	值必須在指定范圍內(nèi)
@URL	必須是一個(gè)URL

2、在控制器層進(jìn)行注解聲明

校驗(yàn)規(guī)則和錯(cuò)誤提示信息配置完畢后，只需要在控制器需要校驗(yàn)的對(duì)象上加入@Valid注解即可。

3、統(tǒng)一異常處理

前兩步配置完成后，當(dāng)傳入?yún)?shù)不滿(mǎn)足校驗(yàn)規(guī)則時(shí)，程序就會(huì)拋出MethodArgumentNotValidException異常。我們通過(guò)spring統(tǒng)一異常處理，將該異常封裝成規(guī)范響應(yīng)格式。

測(cè)試效果：

我們故意傳入一個(gè)不符合規(guī)則的參數(shù)，可以看到響應(yīng)已經(jīng)符合預(yù)期效果。

總結(jié)

Springboot接口參數(shù)校驗(yàn)方式改進(jìn)為validation后，業(yè)務(wù)方法中只包含業(yè)務(wù)邏輯，代碼變得更加簡(jiǎn)潔明了；同時(shí)降低了代碼耦合度，讓業(yè)務(wù)層只需關(guān)注業(yè)務(wù)邏輯，輕松構(gòu)建后端接口；并且validation提供了很多豐富的校驗(yàn)規(guī)則，只需要加上注解即可使用，大家可以繼續(xù)查閱官方文檔了解。