javascript
bean validation校验方法参数_SpringBoot参数校验 从入门到精通 解决繁琐的参数验证工作...
目錄
1、參數(shù)校驗(yàn)簡介2、Validation介紹Hibernate Validator與Spring Validator3、應(yīng)用示例?4、補(bǔ)充01PART參數(shù)校驗(yàn)簡介開發(fā)過程中,后臺的參數(shù)校驗(yàn)是必不可少的,所以經(jīng)常會看到類似下面這樣的代碼
這樣寫并沒有什么錯,還挺工整的,只是看起來不是很優(yōu)雅而已。
接下來,用Validation來改寫這段
02PARTValidation介紹在Spring Boot的官網(wǎng)中,關(guān)于Validation只是簡單的提了一句,如下
其實(shí),Spring Validator和Hibernate Validator是兩套Validator,可以混著用,這里我們用Hibernate Validator
Hibernate Validator的官方文檔:
https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#preface
Spring Validator的官方文檔
https://docs.spring.io/spring/docs/5.0.5.RELEASE/spring-framework-reference/core.html#validation
03PART應(yīng)用示例1、引入spring-boot-starter-validation
2、定義一個對象
3、適用@Valid校驗(yàn),并將校驗(yàn)結(jié)果放到BindingResult對象中
注意:?
默認(rèn)情況下,如果校驗(yàn)失敗會拋javax.validation.ConstraintViolationException異常,可以用統(tǒng)一異常處理去對這些異常做處理?
An Errors/BindingResult argument is expected to be declared immediately after the model attribute
如果在校驗(yàn)的對象后面再加上Model對象的話,如果返回的是ModelAndView就可以將這個Model設(shè)置到其中,這樣在頁面就可以取到錯誤消息了
僅僅只是單字段校驗(yàn)的話未免也太不靈活了吧,如果字段之間有關(guān)聯(lián)關(guān)系,那該如何校驗(yàn)?zāi)?#xff1f;答案是自定義
5、自定義校驗(yàn)規(guī)則
文檔:https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#validator-customconstraints這里,以優(yōu)惠券創(chuàng)建為例來演示如何自定義校驗(yàn)規(guī)則?首先,優(yōu)惠券表單如下(僅僅只是演示用):這里除了自定義了兩條校驗(yàn)規(guī)則之外,還用到了分組。為什么要有分組這一說呢?因?yàn)?#xff0c;舉個例子,添加的時候不需要校驗(yàn)id,而修改的時候id不能為空,有了分組以后,就可以添加的時候校驗(yàn)用組A,修改的時候校驗(yàn)用組B下面重點(diǎn)看一下@CheckTimeInterval第一步、定義一個注解叫CheckTimeInterval第二步、定義Validator去校驗(yàn)它
順便提一句,這里BeanWrapper去取對象的屬性值,我們稍微看一下BeanWrapper是做什么的第三步、驗(yàn)證自定義的校驗(yàn)已經(jīng)生效了04PART補(bǔ)充1、校驗(yàn)?zāi)J?/strong>
文檔:https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#section-fail-fast下面補(bǔ)充一點(diǎn),關(guān)于校驗(yàn)?zāi)J侥J(rèn)會校驗(yàn)完所有屬性,然后將錯誤信息一起返回,但很多時候不需要這樣,一個校驗(yàn)失敗了,其它就不必校驗(yàn)了為此,需要這樣設(shè)置2、單個參數(shù)校驗(yàn)如果是調(diào)整頁面的時候參數(shù)校驗(yàn)失敗的話,這時可以不做處理,讓其調(diào)到錯誤頁面。如果是接口參數(shù)校驗(yàn)失敗的話,可以在這里進(jìn)行統(tǒng)一處理,并返回。例如:3、錯誤頁面以剛才優(yōu)惠券詳情為例http://localhost:8080/coupon/detail.html 400http://localhost:8080/coupon/detail.html?id= 400http://localhost:8080/coupon/detail.html?id=abc ?400http://localhost:8080/coupon/detail222.html?id=123 404無權(quán)限 403int a = 1 / 0; 5004、@Valid與@ValidatedSpring Validation驗(yàn)證框架對參數(shù)的驗(yàn)證機(jī)制提供了@Validated(Spring's JSR-303規(guī)范,是標(biāo)準(zhǔn)JSR-303的一個變種),javax提供了@Valid(標(biāo)準(zhǔn)JSR-303規(guī)范),配合BindingResult可以直接提供參數(shù)驗(yàn)證結(jié)果。其中對于字段的特定驗(yàn)證注解比如@NotNull等網(wǎng)上到處都有,這里不詳述在檢驗(yàn)Controller的入?yún)⑹欠穹弦?guī)范時,使用@Validated或者@Valid在基本驗(yàn)證功能上沒有太多區(qū)別。但是在分組、注解地方、嵌套驗(yàn)證等功能上兩個有所不同:1. 分組@Validated:提供了一個分組功能,可以在入?yún)Ⅱ?yàn)證時,根據(jù)不同的分組采用不同的驗(yàn)證機(jī)制,這個網(wǎng)上也有資料,不詳述。@Valid:作為標(biāo)準(zhǔn)JSR-303規(guī)范,還沒有吸收分組的功能。2. 注解地方@Validated:可以用在類型、方法和方法參數(shù)上。但是不能用在成員屬性(字段)上。@Valid:可以用在方法、構(gòu)造函數(shù)、方法參數(shù)和成員屬性(字段)上兩者是否能用于成員屬性(字段)上直接影響能否提供嵌套驗(yàn)證的功能。3. 嵌套驗(yàn)證在比較兩者嵌套驗(yàn)證時,先說明下什么叫做嵌套驗(yàn)證。比如我們現(xiàn)在有個實(shí)體叫做Item:public class Item { @NotNull(message = "id不能為空") @Min(value = 1, message = "id必須為正整數(shù)") private Long id; @NotNull(message = "props不能為空") @Size(min = 1, message = "至少要有一個屬性") private List props;}Item帶有很多屬性,屬性里面有屬性id,屬性值id,屬性名和屬性值,如下所示:
public?class?Prop?{ @NotNull(message = "pid不能為空") @Min(value = 1, message = "pid必須為正整數(shù)") private Long pid; @NotNull(message = "vid不能為空") @Min(value = 1, message = "vid必須為正整數(shù)") private Long vid; @NotBlank(message = "pidName不能為空") private String pidName; @NotBlank(message = "vidName不能為空") private String vidName;}屬性這個實(shí)體也有自己的驗(yàn)證機(jī)制,比如屬性和屬性值id不能為空,屬性名和屬性值不能為空等。
現(xiàn)在我們有個ItemController接受一個Item的入?yún)?#xff0c;想要對Item進(jìn)行驗(yàn)證,如下所示:@RestControllerpublic class ItemController { @RequestMapping("/item/add") public void addItem(@Validated Item item, BindingResult bindingResult) { doSomething(); }}在上代碼中,如果Item實(shí)體的props屬性不額外加注釋,只有@NotNull和@Size,無論入?yún)⒉捎?#64;Validated還是@Valid驗(yàn)證,Spring Validation框架只會對Item的id和props做非空和數(shù)量驗(yàn)證,不會對props字段里的Prop實(shí)體進(jìn)行字段驗(yàn)證,也就是@Validated和@Valid加在方法參數(shù)前,都不會自動對參數(shù)進(jìn)行嵌套驗(yàn)證。也就是說如果傳的List中有Prop的pid為空或者是負(fù)數(shù),入?yún)Ⅱ?yàn)證不會檢測出來。為了能夠進(jìn)行嵌套驗(yàn)證,必須手動在Item實(shí)體的props字段上明確指出這個字段里面的實(shí)體也要進(jìn)行驗(yàn)證。由于@Validated不能用在成員屬性(字段)上,但是@Valid能加在成員屬性(字段)上,而且@Valid類注解上也說明了它支持嵌套驗(yàn)證功能,那么我們能夠推斷出:@Valid加在方法參數(shù)時并不能夠自動進(jìn)行嵌套驗(yàn)證,而是用在需要嵌套驗(yàn)證類的相應(yīng)字段上,來配合方法參數(shù)上@Validated或@Valid來進(jìn)行嵌套驗(yàn)證。我們修改Item類如下所示:public class Item { @NotNull(message = "id不能為空") @Min(value = 1, message = "id必須為正整數(shù)") private Long id; @Valid // 嵌套驗(yàn)證必須用@Valid @NotNull(message = "props不能為空") @Size(min = 1, message = "props至少要有一個自定義屬性") private List props;}然后我們在ItemController的addItem函數(shù)上再使用@Validated或者@Valid,就能對Item的入?yún)⑦M(jìn)行嵌套驗(yàn)證。此時Item里面的props如果含有Prop的相應(yīng)字段為空的情況,Spring Validation框架就會檢測出來,bindingResult就會記錄相應(yīng)的錯誤。總結(jié)一下@Validated和@Valid在嵌套驗(yàn)證功能上的區(qū)別:@Validated:用在方法入?yún)⑸蠠o法單獨(dú)提供嵌套驗(yàn)證功能。不能用在成員屬性(字段)上,也無法提示框架進(jìn)行嵌套驗(yàn)證。能配合嵌套驗(yàn)證注解@Valid進(jìn)行嵌套驗(yàn)證。
@Valid:用在方法入?yún)⑸蠠o法單獨(dú)提供嵌套驗(yàn)證功能。能夠用在成員屬性(字段)上,提示驗(yàn)證框架進(jìn)行嵌套驗(yàn)證。能配合嵌套驗(yàn)證注解@Valid進(jìn)行嵌套驗(yàn)證。
總結(jié)
以上是生活随笔為你收集整理的bean validation校验方法参数_SpringBoot参数校验 从入门到精通 解决繁琐的参数验证工作...的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: mysql 截取字符串部分值,Mysql
- 下一篇: 如何修改matlab中的语句,求大神帮忙