Springboot如何優(yōu)雅地進(jìn)行字段校驗(yàn)
差不多大半年沒(méi)寫(xiě)文章了,終于將手頭上的事忙完了,可以對(duì)外輸出了。前段時(shí)間提交代碼審核,同事提了一個(gè)代碼規(guī)范缺陷:參數(shù)校驗(yàn)應(yīng)該放在controller層。到底應(yīng)該如何做參數(shù)校驗(yàn)?zāi)?/p>
Controller層 VS Service層
去網(wǎng)上查閱了一些資料,一般推薦與業(yè)務(wù)無(wú)關(guān)的放在Controller層中進(jìn)行校驗(yàn),而與業(yè)務(wù)有關(guān)的放在Service層中進(jìn)行校驗(yàn)。那么如何將參數(shù)校驗(yàn)寫(xiě)的優(yōu)雅美觀呢,如果都是if - else,就感覺(jué)代碼寫(xiě)的很low,還好有輪子可以使用
常用校驗(yàn)工具類(lèi)
使用Hibernate Validate
引入依賴
<dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>4.3.1.Final</version> </dependency>
常用注解說(shuō)明
| 注解 | 說(shuō)明 |
|---|---|
| @Length(min=,max=) | 檢查所屬的字段的長(zhǎng)度是否在min和max之間,只能用于字符串 |
| @Range(min=,max=,message=) | 被注釋的元素必須在合適的范圍內(nèi) |
| @Max | 該字段的值只能小于或等于該值 |
| @Min | 該字段的值只能大于或等于該值 |
| @NotNull | 不能為null |
| @NotBlank | 不能為空,檢查時(shí)會(huì)將空格忽略 |
| @NotEmpty | 不能為空,這里的空是指空字符串 |
| @Pattern(regex=,flag=) | 被注釋的元素必須符合指定的正則表達(dá)式 |
使用姿勢(shì)
需要搭配在Controller中搭配@Validated或@Valid注解一起使用,@Validated和@Valid注解區(qū)別不是很大,一般情況下任選一個(gè)即可,區(qū)別如下:
| 注解 | @Validated | @Valid |
|---|---|---|
| 所屬的包 | 屬于org.springframework.validation.annotation包下的,是spring提供的 | 屬于javax.validation包下,是jdk給提供的 |
| 是否支持分組和排序 | 是 | 否 |
雖然@Validated比@Valid更加強(qiáng)大,在@Valid之上提供了分組功能和驗(yàn)證排序功能,不過(guò)在實(shí)際項(xiàng)目中一直沒(méi)有用到過(guò)
Hibernate-validate框架中的注解是需要加在實(shí)體中一起使用的
定義一個(gè)實(shí)體
public class DataSetSaveVO {
//唯一標(biāo)識(shí)符為空
@NotBlank(message = "user uuid is empty")
//用戶名稱(chēng)只能是字母和數(shù)字
@Pattern(regexp = "^[a-z0-9]+$", message = "user names can only be alphabetic and numeric")
@Length(max = 48, message = "user uuid length over 48 byte")
private String userUuid;
//數(shù)據(jù)集名稱(chēng)只能是字母和數(shù)字
@Pattern(regexp = "^[A-Za-z0-9]+$", message = "data set names can only be letters and Numbers")
//文件名稱(chēng)過(guò)長(zhǎng)
@Length(max = 48, message = "file name too long")
//文件名稱(chēng)為空
@NotBlank(message = "file name is empty")
private String name;
//數(shù)據(jù)集描述最多為256字節(jié)
@Length(max = 256, message = "data set description length over 256 byte")
//數(shù)據(jù)集描述為空
@NotBlank(message = "data set description is null")
private String description;
}
說(shuō)明:message字段為不符合校驗(yàn)規(guī)則時(shí)拋出的異常信息
Controller層中的方法
@PostMapping
public ResponseVO createDataSet(@Valid @RequestBody DataSetSaveVO dataSetVO) {
return ResponseUtil.success(dataSetService.saveDataSet(dataSetVO));
}
說(shuō)明:在校驗(yàn)的實(shí)體DataSetSaveVO旁邊添加@Valid或@Validated注解
使用commons-lang3
引入依賴
<dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.4</version> </dependency>
常用方法說(shuō)明
| 方法 | 說(shuō)明 |
|---|---|
| CollectionUtils.isEmpty | 判斷集合是否為空,為null或者size==0,返回true |
| CollectionUtils.isNotEmpty | 判斷集合是否為非空 |
| StringUtils.isEmpty | 判斷字符串是否為空 |
| StringUtils.isNotEmpty | 判斷字符串是否非空 |
| StringUtils.isBlank | 判斷字符串是否為空,為null或者size==0或者只存在空白字符(如" "),則返回true |
| StringUtils.isNotBlank | 判斷字符串是否為非空 |
測(cè)試代碼
//StringUtils.isEmpty
System.out.println(StringUtils.isEmpty("")); //true
System.out.println(StringUtils.isEmpty(" ")); //false
//StringUtils.isNotEmpty
System.out.println(StringUtils.isNotEmpty("")); //false
//StringUtils.isBlank
System.out.println(StringUtils.isBlank("")); //true
System.out.println(StringUtils.isBlank(" ")); //true
//StringUtils.isNotBlank
System.out.println(StringUtils.isNotBlank(" ")); //false
List<Integer> emptyList = new ArrayList<>();
List<Integer> nullList = null;
List<Integer> notEmptyList = new ArrayList<>();
notEmptyList.add(1);
//CollectionUtils.isEmpty
System.out.println(CollectionUtils.isEmpty(emptyList)); //true
System.out.println(CollectionUtils.isEmpty(nullList)); //true
System.out.println(CollectionUtils.isEmpty(notEmptyList)); //false
//CollectionUtils.isNotEmpty
System.out.println(CollectionUtils.isNotEmpty(emptyList)); //false
System.out.println(CollectionUtils.isNotEmpty(nullList)); //false
System.out.println(CollectionUtils.isNotEmpty(notEmptyList)); //true
自定義注解
當(dāng)上面的方面都無(wú)法滿足校驗(yàn)的需求以后,可以考慮使用自定義注解,如何寫(xiě)一個(gè)自定義注解,可以參考之前寫(xiě)的文章:Spring自定義注解從入門(mén)到精通
到此這篇關(guān)于Springboot如何優(yōu)雅地進(jìn)行字段校驗(yàn)的文章就介紹到這了,更多相關(guān)Springboot字段校驗(yàn)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java通過(guò)SMS短信平臺(tái)實(shí)現(xiàn)發(fā)短信功能 含多語(yǔ)言
這篇文章主要為大家詳細(xì)介紹了Java通過(guò)SMS短信平臺(tái)實(shí)現(xiàn)發(fā)短信功能的相關(guān)資料,感興趣的小伙伴們可以參考一下2016-07-07
java接口用戶上下文的設(shè)計(jì)與實(shí)現(xiàn)
這篇文章主要為大家介紹了接口用戶上下文的設(shè)計(jì)與實(shí)現(xiàn)實(shí)例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11
springboot自帶線程池ThreadPoolTaskExecutor使用
本文主要介紹了springboot自帶線程池ThreadPoolTaskExecutor使用,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
SpringBoot統(tǒng)一返回處理出現(xiàn)cannot?be?cast?to?java.lang.String異常解決
這篇文章主要給大家介紹了關(guān)于SpringBoot統(tǒng)一返回處理出現(xiàn)cannot?be?cast?to?java.lang.String異常解決的相關(guān)資料,文中通過(guò)圖文介紹的非常詳細(xì),需要的朋友可以參考下2023-09-09
JAVA演示阿里云圖像識(shí)別API,印刷文字識(shí)別-營(yíng)業(yè)執(zhí)照識(shí)別
最近有由于工作需要,開(kāi)始接觸阿里云的云市場(chǎng)的印刷文字識(shí)別API-營(yíng)業(yè)執(zhí)照識(shí)別這里我加上了官網(wǎng)的申請(qǐng)說(shuō)明,只要你有阿里云賬號(hào)就可以用,前500次是免費(fèi)的,API說(shuō)明很簡(jiǎn)陋,只能做個(gè)簡(jiǎn)單參考2019-05-05

