springmvc項(xiàng)目使用@Valid+BindingResult遇到的問(wèn)題
今天在一個(gè)老的dubbo+springmvc結(jié)構(gòu)的項(xiàng)目做一個(gè)接口。通過(guò)controller的方式,因?yàn)閰?shù)復(fù)雜,所以想通過(guò)@valid+BindingResult的方式做參數(shù)校驗(yàn)。
在springcloude+springboot中,maven的依賴無(wú)需你去考慮,一般都引用好了。但是在老的springmvc中,還是需要你自己添加一下引用的。
看了網(wǎng)上的一些資料,往往都忽略著這部分,所以@valid一致無(wú)效,也不報(bào)錯(cuò),BindingResult的errors數(shù)量是0。后來(lái)經(jīng)過(guò)多方查找,資料拼湊,終于解決了這個(gè)問(wèn)題。這里記錄一下。
第一步:pom.xml中引入
javax.validation和hibernate-validator
<!-- springmvc的參數(shù)valid校驗(yàn)依賴 開(kāi)始 --> <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.1.Final</version> </dependency> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>6.0.16.Final</version> </dependency> <!-- springmvc的參數(shù)valid校驗(yàn)依賴 結(jié)束 -->
之前我只引入了javax的驗(yàn)證,這樣做系統(tǒng)不會(huì)報(bào)錯(cuò)。就是bindingResult返回的errors一直為0。校驗(yàn)不起作用。
第二步:創(chuàng)建需要校驗(yàn)的參數(shù)bean類
需要引入的類:
import javax.validation.constraints.Min; import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotNull; import javax.validation.constraints.Pattern;
@Component public class UserScheduleByManualBean implements Serializable { /** * */ private static final long serialVersionUID = 8093326646402381469L; @NotBlank(message = "賽事不能為空") private String matchEventName; // 賽事名稱 @NotBlank(message = "發(fā)槍時(shí)間不能為空") @Pattern(regexp = "((([0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]{1}|[0-9]{1}[1-9][0-9]{2}|[1-9][0-9]{3})-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|11)-(0[1-9]|[12][0-9]|30))|(02-(0[1-9]|[1][0-9]|2[0-8]))))|((([0-9]{2})(0[48]|[2468][048]|[13579][26])|((0[48]|[2468][048]|[3579][26])00))-02-29))\\s([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", message = "發(fā)槍格式錯(cuò)誤") private String gunTime; // 發(fā)槍時(shí)間 @NotNull(message = "國(guó)家ID不能為空") @Min(value = 0,message = "國(guó)家ID數(shù)據(jù)格式錯(cuò)誤") private int dicCountryId; // 國(guó)家ID @NotBlank(message = "國(guó)家名稱不能為空") private String countryName; // 國(guó)家名稱 @NotNull(message = "省份ID不能為空") @Min(value = 0,message = "省份ID數(shù)據(jù)格式錯(cuò)誤") private int dicProvinceId; // 省份ID @NotBlank(message = "省份名稱不能為空") private String provinceName; // 省份名稱 @NotNull(message = "城市ID不能為空") @Min(value = 0,message = "城市ID數(shù)據(jù)格式錯(cuò)誤") private int dicCityId; // 城市ID @NotBlank(message = "城市名稱不能為空") private String cityName; // 城市名稱 private String projectName; // 項(xiàng)目名稱 private String remarks; // 說(shuō)明 可以為空 private String bib; // 賽號(hào) 可以為空 //get和set方法忽略 }
這里一定要注意兩個(gè)問(wèn)題
1: bean上加@Component注解,并且spring配置要掃描到這個(gè)包,否則也不生效。
2: @valid方式校驗(yàn),有很多限制注解(后面附表)。不通的限制注解,對(duì)應(yīng)的數(shù)據(jù)類型不一樣。比如:@Pattern注解,只能在String類型上使用。我一開(kāi)始希望int的屬性也直接通過(guò)正則做校驗(yàn)。結(jié)果報(bào)錯(cuò):HV000030: No validator could be found for constraint 'javax.validation.constraints.Pattern' validating type 'java.lang.Integer'
3: 注解可以多個(gè)
第三步:寫controller類
首先,我們先創(chuàng)建一個(gè)BaseController抽象類,其中有BindingResult校驗(yàn)方法,其他所有的controller繼承該類實(shí)現(xiàn)校驗(yàn)。
引入的java類:
import org.springframework.validation.BindingResult; import javax.validation.Valid;
public abstract class BaseController { /** * 校驗(yàn)通過(guò)bean當(dāng)參數(shù)的驗(yàn)證結(jié)果方法 * @param bindingResult * @return */ protected Map<String, Object> validate(BindingResult bindingResult) { Map<String, Object> ret = new HashMap<>(); boolean isTrue = true; StringBuilder sb = new StringBuilder(""); if (bindingResult.hasErrors()) { bindingResult.getAllErrors().forEach(o ->{ FieldError error = (FieldError) o; sb.append("|" + error.getDefaultMessage());// 添加錯(cuò)誤信息 }); isTrue = false; } ret.put("isTrue", isTrue); ret.put("message", sb.toString());// 錯(cuò)誤信息 return ret; } }
其次,我們創(chuàng)建業(yè)務(wù)的controller類,繼承BaseController。
@Api(value = "TestController-API", description = "測(cè)試操作接口") @Controller @RequestMapping("testController/*") public class TestController extends BaseController { @RequestMapping(value = "tstex", method = RequestMethod.POST, produces = "application/json;charset=UTF-8") @ApiOperation(value = "測(cè)試異常方法", notes = "測(cè)試異常方法") public @ResponseBody String tstex(@Valid @RequestBody UserScheduleByManualBean userScheduleByManualBean, BindingResult bindingResult) { Map<String, Object> ret = new HashMap<>(); // 校驗(yàn)userScheduleByManualBean是否合法 Map<String, Object> validRet = validate(bindingResult); boolean isTrue = (Boolean) validRet.get("isTrue"); if (!isTrue) { // 參數(shù)不合法 String erroMsg = (String) validRet.get("message"); ret.put("resultCode", “0001”); ret.put("resultDesc", “參數(shù)錯(cuò)誤” + erroMsg); return JsonUtil.gson_ObjectToJSON(ret); } ret.put("resultCode", “0000”); ret.put("resultDesc", “成功”); return JsonUtil.gson_ObjectToJSON(ret); } }
這里需要注意的問(wèn)題:@Valid和@RequestBody是有位置關(guān)系的,必須@Valid在前面。BindingResult bindingResult作為參數(shù)傳遞進(jìn)來(lái),然后通過(guò)validate校驗(yàn)參數(shù),并設(shè)置統(tǒng)一的返回結(jié)果。
通過(guò)swagger運(yùn)行結(jié)果如下:
附 件
限制注解 | 說(shuō)明 | 限制類型 | 樣例 |
@Null | 限制只能為null | 全部 | @Null(message="") |
@NotNull | 限制必須不為null | 全部 | @NotNull(message="") |
@AssertFalse | 限制必須為false | ||
@AssertTrue | 限制必須為true | ||
@DecimalMax(value) | 限制必須為一個(gè)不大于指定值的數(shù)字 | ||
@DecimalMin(value) | 限制必須為一個(gè)不小于指定值的數(shù)字 | ||
@Digits(integer,fraction) | 限制必須為一個(gè)小數(shù),且整數(shù)部分的位數(shù)不能超過(guò)integer,小數(shù)部分的位數(shù)不能超過(guò)fraction | ||
@Future | 限制必須是一個(gè)將來(lái)的日期 | ||
@Max(value) | 限制必須為一個(gè)不大于指定值的數(shù)字 | int | @Max(value=100,message="") |
@Min(value) | 限制必須為一個(gè)不小于指定值的數(shù)字 | int | @Min(value=100,message="") |
@Past | 限制必須是一個(gè)過(guò)去的日期 | ||
@Pattern(value) | 限制必須符合指定的正則表達(dá)式 | String |
@Pattern(regexp="",message="") |
@Size(max,min) | 限制字符長(zhǎng)度必須在min到max之間 | ||
@NotEmpty | 驗(yàn)證注解的元素值不為null且不為空(字符串長(zhǎng)度不為0、集合大小不為0) | String |
@NotEmpty(message = "") |
@NotBlank | 驗(yàn)證注解的元素值不為空(不為null、去除首位空格后長(zhǎng)度為0),不同于@NotEmpty,@NotBlank只應(yīng)用于字符串且在比較時(shí)會(huì)去除字符串的空格 | String |
@NotBlank(message = "") |
驗(yàn)證注解的元素值是Email,也可以通過(guò)正則表達(dá)式和flag指定自定義的email格式 | String |
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
- @valid 無(wú)法觸發(fā)BindingResult的解決
- 使用@Valid+BindingResult進(jìn)行controller參數(shù)校驗(yàn)方式
- 使用BindingResult 自定義錯(cuò)誤信息
- 使用注解@Validated和BindingResult對(duì)入?yún)⑦M(jìn)行非空校驗(yàn)方式
- @Valid 校驗(yàn)無(wú)效,BindingResult未獲得錯(cuò)誤的解決
- 使用@Validated 和 BindingResult 遇到的坑及解決
- 關(guān)于BindingResult的使用總結(jié)及注意事項(xiàng)
相關(guān)文章
詳述IntelliJ IDEA遠(yuǎn)程調(diào)試Tomcat的方法(圖文)
本篇文章主要介紹了詳述IntelliJ IDEA遠(yuǎn)程調(diào)試Tomcat的方法,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-12-12IntelliJ IDEA本地代碼覆蓋后恢復(fù)原來(lái)的代碼圖解
今天小編就為大家分享一篇關(guān)于IntelliJ IDEA本地代碼覆蓋后恢復(fù)原來(lái)的代碼圖解,小編覺(jué)得內(nèi)容挺不錯(cuò)的,現(xiàn)在分享給大家,具有很好的參考價(jià)值,需要的朋友一起跟隨小編來(lái)看看吧2018-10-10詳解Springboot如何通過(guò)注解實(shí)現(xiàn)接口防刷
本文主要為大家介紹一種極簡(jiǎn)潔、靈活通用接口防刷實(shí)現(xiàn)方式、通過(guò)在需要防刷的方法加上@Prevent?注解即可實(shí)現(xiàn)短信防刷,感興趣的可以了解一下2022-09-09SpringBoot整合Swagger3生成接口文檔過(guò)程解析
這篇文章主要介紹了SpringBoot整合Swagger3生成接口文檔過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07java數(shù)據(jù)結(jié)構(gòu)與算法之中綴表達(dá)式轉(zhuǎn)為后綴表達(dá)式的方法
這篇文章主要介紹了java數(shù)據(jù)結(jié)構(gòu)與算法之中綴表達(dá)式轉(zhuǎn)為后綴表達(dá)式的方法,簡(jiǎn)單分析了java中綴表達(dá)式轉(zhuǎn)為后綴表達(dá)式的相關(guān)實(shí)現(xiàn)方法與技巧,需要的朋友可以參考下2016-08-08Java數(shù)據(jù)結(jié)構(gòu)之基于比較的排序算法基本原理及具體實(shí)現(xiàn)
最近剛學(xué)習(xí)完七種比較常見(jiàn)的基于比較的排序算法,感覺(jué)比較重要,所以寫個(gè)博客記錄一下,通讀本篇對(duì)大家的學(xué)習(xí)或工作具有一定的價(jià)值,需要的朋友可以參考下2021-09-09Java結(jié)構(gòu)性設(shè)計(jì)模式中的裝飾器模式介紹使用
裝飾器模式又名包裝(Wrapper)模式。裝飾器模式以對(duì)客戶端透明的方式拓展對(duì)象的功能,是繼承關(guān)系的一種替代方案,本篇文章以虹貓藍(lán)兔生動(dòng)形象的為你帶來(lái)詳細(xì)講解2022-09-09SpringBoot 自定義注解異步記錄復(fù)雜日志詳解
這篇文章主要為大家介紹了SpringBoot 自定義注解異步記錄復(fù)雜日志詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-09-09