av一区二区在线观看_亚洲男人的天堂网站_日韩亚洲视频_在线成人免费_欧美日韩精品免费观看视频_久草视

您的位置:首頁(yè)技術(shù)文章
文章詳情頁(yè)

如何在spring boot中進(jìn)行參數(shù)校驗(yàn)示例詳解

瀏覽:111日期:2023-09-05 18:13:31

上文我們討論了spring-boot如何去獲取前端傳遞過(guò)來(lái)的參數(shù),那傳遞過(guò)來(lái)總不能直接使用,需要對(duì)這些參數(shù)進(jìn)行校驗(yàn),符合程序的要求才會(huì)進(jìn)行下一步的處理,所以本篇文章我們主要討論spring-boot中如何進(jìn)行參數(shù)校驗(yàn)。

lombok使用介紹

在介紹參數(shù)校驗(yàn)之前,先來(lái)了解一下lombok的使用,因?yàn)樵诮酉聛?lái)的實(shí)例中或有不少的對(duì)象創(chuàng)建,但是又不想寫(xiě)那么多的getter和setter,所以先介紹一下這個(gè)很強(qiáng)大的工具的使用。

Lombok 是一個(gè)可以通過(guò)簡(jiǎn)單的注解形式來(lái)幫助我們簡(jiǎn)化消除一些必須有但顯得很臃腫的Java代碼的工具,通過(guò)使用對(duì)應(yīng)的注解,可以在編譯源碼的時(shí)候生成對(duì)應(yīng)的方法。

添加maven依賴(lài)

在pom文件中添加如下內(nèi)容:

<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.10</version></dependency>

基礎(chǔ)注解

@Getter給類(lèi)增加get方法

@Setter給類(lèi)增加set方法

@Builder給類(lèi)增加構(gòu)建者模式

@AllArgsConstructor給類(lèi)增加全參構(gòu)造方法

@NoArgsConstructor給類(lèi)增加無(wú)參數(shù)構(gòu)造方法

@RequiredArgsConstructor按照必填屬性增加構(gòu)造方法

@NonNull變量值不能為空

這里只簡(jiǎn)單列一下常用注解的含義,具體的使用方式在參數(shù)校驗(yàn)的實(shí)例中體現(xiàn)。

實(shí)戰(zhàn)

上篇文章中我們用BannerCreateDto這個(gè)對(duì)象了來(lái)接收前端傳遞的參數(shù),那時(shí)是手動(dòng)添加的get和set方法,這里我們用lombok注解來(lái)簡(jiǎn)化掉之前的樣板代碼:

@Setter@Getterpublic class BannerCreateDto { private String name; private Integer pos;}

接口的定義還是和之前一樣。不同做任何修改:

@PostMapping(value = '/create')public Map<String, Object> createBanner(@RequestBody BannerCreateDto dto){ Map<String, Object> res = new HashMap<>(); res.put('id', 10000); res.put('name', dto.getName()); res.put('pos', dto.getPos()); return res;}

重新運(yùn)行程序,訪問(wèn)接口

如何在spring boot中進(jìn)行參數(shù)校驗(yàn)示例詳解

還是和之前一樣,能夠請(qǐng)求成功并正常的返回?cái)?shù)據(jù)。

一般情況下,我們會(huì)針對(duì)返回的數(shù)據(jù),來(lái)單獨(dú)定義對(duì)象來(lái)進(jìn)行描述,這里我們也定義一個(gè)

@Builder@Getterpublic class BannerResponseDto { private int id; private String name; private Integer pos;}

這里用到了@Builder、@Getter,在接口中構(gòu)造對(duì)象并返回:

@PostMapping(value = '/create')public BannerResponseDto createBanner(@RequestBody BannerCreateDto dto){ return BannerResponseDto.builder() .id(500) .name(dto.getName()) .pos(dto.getPos()) .build();}

可以看到lombok的@Builder注解,能夠讓類(lèi)通過(guò)構(gòu)建者模式去創(chuàng)建對(duì)象,省去了大量的set代碼,而且可讀性也很好。

訪問(wèn)接口,看看數(shù)據(jù)返回的時(shí)候正常:

如何在spring boot中進(jìn)行參數(shù)校驗(yàn)示例詳解

與之前是一樣的,能夠正常返回?cái)?shù)據(jù),那接下來(lái)我們就正式看一下,spring-boot如何進(jìn)行參數(shù)校驗(yàn)了。

參數(shù)校驗(yàn)

參數(shù)校驗(yàn)就是說(shuō)對(duì)前端傳過(guò)來(lái)的數(shù)據(jù)進(jìn)行合理性校驗(yàn),看他能否滿足我們的業(yè)務(wù)規(guī)則,那這些對(duì)參數(shù)進(jìn)行校驗(yàn)的代碼是該放在那里呢,是在Controller里還是說(shuō)單獨(dú)存放,又獲取采用其他什么方式呢?

參數(shù)校驗(yàn)該怎么做

首先要明確的一點(diǎn),在Controller,不應(yīng)該有大量邏輯判斷的代碼,為什么呢,我們可想想當(dāng)參數(shù)較多的時(shí)候,對(duì)每個(gè)參數(shù)進(jìn)行合理性校驗(yàn)的話,那代碼量該有多少,那就會(huì)嚴(yán)重污染Controller,導(dǎo)致維護(hù)起來(lái)是很艱難的,所以應(yīng)該要有一個(gè)合理的機(jī)制能把校驗(yàn)的代碼抽離出來(lái),從而保證Controller的簡(jiǎn)潔性。

在java的世界里有這么個(gè)概念叫做 JSR,是Java Specification Requests的首字母縮寫(xiě),是編程語(yǔ)言Java規(guī)范請(qǐng)求或者說(shuō)是Java語(yǔ)言的說(shuō)明書(shū),既然是說(shuō)明書(shū)那就一定有各個(gè)版本,在JSR-303版本中,提出了Bean Validation的驗(yàn)證規(guī)范,目前主要有兩個(gè)兩個(gè)框架實(shí)現(xiàn)了Bean Validation規(guī)范,一個(gè)事自帶的javax.validation.api和hibernate-validator框架,而hibernate-validator框架應(yīng)用的更加廣泛一點(diǎn)。

那我們就用這種Bean Validation這種驗(yàn)證框架進(jìn)行參數(shù)的驗(yàn)證

實(shí)戰(zhàn)

@RestController@Validatedpublic class BannerController { @GetMapping('/v3/banner') public Map<String, Object> getBannerDetailV2(@RequestParam Integer id, @RequestParam @Max(10) Integer pos){ Map<String, Object> body = new HashMap<>(); body.put('id', id); body.put('pos', pos); return body; }}

上面代碼中,@Max(10)注解來(lái)驗(yàn)證輸入?yún)?shù)的pos,限制其輸入?yún)?shù)最大值為10,運(yùn)行程序我們來(lái)測(cè)試一下:

如何在spring boot中進(jìn)行參數(shù)校驗(yàn)示例詳解

訪問(wèn)接口http://localhost:8081/v3/banner?id=12&pos=33后,看到我們控制臺(tái)的輸出提示輸入不能超過(guò)10,這里的這個(gè)message不是我寫(xiě)的哈,這是java國(guó)際化后的效果能夠根據(jù)你所在地區(qū)決定顯示什么語(yǔ)言。

當(dāng)然這里我們也可以自定義錯(cuò)誤的message:

@GetMapping('/v3/banner')public Map<String, Object> getBannerDetailV2(@RequestParam Integer id, @RequestParam @Max(value = 10, message = '超過(guò)10了,趕緊看看哇') Integer pos){ Map<String, Object> body = new HashMap<>(); body.put('id', id); body.put('pos', pos); return body;}

還是上面的請(qǐng)求路徑,看看控制臺(tái)輸出:

如何在spring boot中進(jìn)行參數(shù)校驗(yàn)示例詳解

可以看到控制臺(tái)輸出了我們自定義的內(nèi)容。這里有一點(diǎn)要注意,要想使得校驗(yàn)生效,比如在Controller上方打上@Validated注解,至于為什么我們后面分解。

上面的驗(yàn)證都是比較基礎(chǔ)的數(shù)據(jù)類(lèi)型,但是如果現(xiàn)在要有驗(yàn)證更加復(fù)雜一點(diǎn)的java對(duì)象呢,又該如何操作,那接下來(lái)我們?cè)倏纯催@部分的內(nèi)容。

java對(duì)象進(jìn)行驗(yàn)證單個(gè)對(duì)象

還是用上面的BannerResponseDto來(lái)進(jìn)行演示

import org.hibernate.validator.constraints.Length;@Setter@Getterpublic class BannerCreateDto { @Length(min = 2, max = 4, message = 'banner名稱(chēng)必須是2-10個(gè)字符') private String name; private Integer pos;}

對(duì)于這些基礎(chǔ)類(lèi)型的成員變量仍然使用這些基礎(chǔ)注解進(jìn)行校驗(yàn)定義,上面我們使用了 @Length注解來(lái)定義banner名稱(chēng)的字符長(zhǎng)度范圍,并定義發(fā)生錯(cuò)誤時(shí)提示的message,這里還需要在Controller里額外的處理一下:

@PostMapping('/v3/banner/create')public BannerResponseDto createBanner(@RequestBody @Validated BannerCreateDto dto){ return BannerResponseDto.builder() .id(500) .name(dto.getName()) .pos(dto.getPos()) .build();}

@Validated BannerCreateDto這里必須要加@Validated注解,否則無(wú)法觸發(fā)校驗(yàn)機(jī)制。

嵌套

如果某個(gè)類(lèi)的成員變量也是一個(gè)自定義對(duì)象,那校驗(yàn)該是什么樣的呢,下面我們來(lái)看一下。

先定義一個(gè)新的對(duì)象,用來(lái)接收banner到的素材信息

@Getter@Setterpublic class MaterialDto { @Length(min = 2, max = 5, message = '素材的名稱(chēng)長(zhǎng)度范圍必須在2-5之內(nèi)') private String name;}

然后banner對(duì)象增加一個(gè)成員變量

@Setter@Getterpublic class BannerCreateDto { @Length(min = 2, max = 4, message = 'banner名稱(chēng)必須是2-10個(gè)字符') private String name; private Integer pos; @Valid private MaterialDto materialDto;}

這里有一點(diǎn),要想使得這種級(jí)聯(lián)的關(guān)系能夠觸發(fā)校驗(yàn)機(jī)制,必須 @Valid注解進(jìn)行標(biāo)記,我們來(lái)請(qǐng)求一下url看看效果

如何在spring boot中進(jìn)行參數(shù)校驗(yàn)示例詳解

可以看到校驗(yàn)沒(méi)通過(guò),再看看控制臺(tái)輸出內(nèi)容:

如何在spring boot中進(jìn)行參數(shù)校驗(yàn)示例詳解

輸出了我們定義的錯(cuò)誤信息。

總結(jié)

本篇文章主要介紹了里面lombok的使用,以及校驗(yàn)規(guī)范介紹和校驗(yàn)框架基本注解的使用,還有自定義對(duì)象校驗(yàn),下篇文章我們將通過(guò)自定義注解來(lái)實(shí)現(xiàn)更加個(gè)性化的校驗(yàn)規(guī)則,敬請(qǐng)期待。

到此這篇關(guān)于如何在spring-boot中進(jìn)行參數(shù)校驗(yàn)的文章就介紹到這了,更多相關(guān)spring-boot 參數(shù)校驗(yàn)內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)!

標(biāo)簽: Spring
相關(guān)文章:
主站蜘蛛池模板: 亚洲国产日本 | 亚州午夜精品 | 久色视频在线 | 一级做受毛片免费大片 | 国产黄色一级电影 | 精品真实国产乱文在线 | 欧美日韩久久精品 | 日韩最新网站 | 精品久久99 | 国产区一区 | 国产亚洲一区二区三区在线 | 福利二区| 国产三级 | 亚洲免费视频在线观看 | 日韩精品一区二区三区中文在线 | 国产午夜精品一区二区三区四区 | 精品国产欧美一区二区三区不卡 | 国产日韩欧美中文 | 天天色天天色 | 久久综合av| 国产午夜精品视频 | 中文字幕三区 | 蜜桃视频在线观看免费视频网站www | 国产亚洲精品综合一区 | 一本在线| 中文字幕亚洲一区二区三区 | 欧美一区二区在线 | 91视频在线看 | 日韩欧美国产精品 | 国产91黄色 | 久久精品黄色 | 香蕉av免费 | 国产欧美久久精品 | 国产成人精品久久二区二区91 | 人人九九精 | 二区久久 | 天天玩天天干天天操 | 激情a | 国产一级淫片a直接免费看 免费a网站 | 国产精品久久久久久久久久久免费看 | 天堂中文在线播放 |