怎么在Spring Boot項(xiàng)目中利用JSR-380進(jìn)行校驗(yàn)?相信很多沒有經(jīng)驗(yàn)的人對(duì)此束手無策,為此本文總結(jié)了問題出現(xiàn)的原因和解決方法,通過這篇文章希望你能解決這個(gè)問題。
讓客戶滿意是我們工作的目標(biāo),不斷超越客戶的期望值來自于我們對(duì)這個(gè)行業(yè)的熱愛。我們立志把好的技術(shù)通過有效、簡(jiǎn)單的方式提供給客戶,將通過不懈努力成為客戶在信息化領(lǐng)域值得信任、有價(jià)值的長期合作伙伴,公司提供的服務(wù)項(xiàng)目有:域名注冊(cè)、網(wǎng)站空間、營銷軟件、網(wǎng)站建設(shè)、廣昌網(wǎng)站維護(hù)、網(wǎng)站推廣。JSR-380
是 J2EE 的一個(gè)規(guī)范,用于校驗(yàn)實(shí)體屬性,它是JSR-303
的升級(jí)版,在 Spring Boot 中可以基于它優(yōu)雅實(shí)現(xiàn)參數(shù)校驗(yàn)。
<!--more-->
在沒有使用JSR-380
之前,我們一般都會(huì)將參數(shù)校驗(yàn)硬編碼在controller
類中,示例:
public Result add(@RequestBody User user){ if(StringUtils.isBlank(user.getName())){ return Result.error("用戶名不能為空"); } // ... }
而使用JSR-380
只需要通過添加對(duì)應(yīng)的注解即可實(shí)現(xiàn)校驗(yàn),示例:
@Data public class User{ @NotBlank private String name; private Integer age; }
public Result register(@Validated @RequestBody User user){ // ... }
這樣看起來代碼是不是清爽了很多,只需要在需要校驗(yàn)的字段上加上對(duì)應(yīng)的校驗(yàn)注解,然后對(duì)需要校驗(yàn)的地方加上@Validated
注解,然后框架就會(huì)幫我們完成校驗(yàn)。
框架校驗(yàn)失敗之后會(huì)拋出異常,需要捕獲這個(gè)異常然后來自定義校驗(yàn)不通過的錯(cuò)誤響應(yīng),這里直接貼代碼,兼容@RequestBody
、@ModelAttribute
、@RequestParam
三種入?yún)⒌男r?yàn):
@ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(value = {MethodArgumentNotValidException.class, BindException.class}) public ResponseEntity<Result> methodArgumentNotValidHandler(HttpServletRequest request, Exception e) { BindingResult bindingResult; if (e instanceof MethodArgumentNotValidException) { //@RequestBody參數(shù)校驗(yàn) bindingResult = ((MethodArgumentNotValidException) e).getBindingResult(); } else { //@ModelAttribute參數(shù)校驗(yàn) bindingResult = ((BindException) e).getBindingResult(); } FieldError fieldError = bindingResult.getFieldError(); return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + fieldError.getField() + "]" + fieldError.getDefaultMessage())); } //@RequestParam參數(shù)校驗(yàn) @ExceptionHandler(value = {ConstraintViolationException.class, MissingServletRequestParameterException.class}) public ResponseEntity<Result> constraintViolationHandler(Exception e) { String field; String msg; if (e instanceof ConstraintViolationException) { ConstraintViolation<?> constraintViolation = ((ConstraintViolationException) e).getConstraintViolations().stream().findFirst().get(); List<Path.Node> pathList = StreamSupport.stream(constraintViolation.getPropertyPath().spliterator(), false) .collect(Collectors.toList()); field = pathList.get(pathList.size() - 1).getName(); msg = constraintViolation.getMessage(); } else { // 這個(gè)不是JSR標(biāo)準(zhǔn)返回的異常,要自定義提示文本 field = ((MissingServletRequestParameterException) e).getParameterName(); msg = "不能為空"; } return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + field + "]" + msg)); } }
然后再訪問一下接口,可以看到錯(cuò)誤提示已經(jīng)按自定義的規(guī)范顯示了:
可以看到都不需要寫任何提示文本就可以完成校驗(yàn)和提示,上圖的不能為空
是框架內(nèi)置的I18N
國際化支持,每個(gè)注解都內(nèi)置相應(yīng)的提示模板。
常用校驗(yàn)注解
注解 | 描述 |
---|---|
@NotNull | 驗(yàn)證值不為 null |
@AssertTrue | 驗(yàn)證值為 true |
@Size | 驗(yàn)證值的長度介于 min 和 max 之間,可應(yīng)用于 String、Collection、Map 和數(shù)組類型 |
@Min | 驗(yàn)證值不小于該值 |
@Max | 驗(yàn)證值不大于該值 |
驗(yàn)證字符串是有效的電子郵件地址 | |
@NotEmpty | 驗(yàn)證值不為 null 或空,可應(yīng)用于 String、Collection、Map 和數(shù)組類型 |
@NotBlank | 驗(yàn)證字符串不為 null 并且不是空白字符 |
@Positive | 驗(yàn)證數(shù)字為正數(shù) |
@PositiveOrZero | 驗(yàn)證數(shù)字為正數(shù)(包括 0) |
@Negative | 驗(yàn)證數(shù)字為負(fù)數(shù) |
@NegativeOrZero | 驗(yàn)證數(shù)字為負(fù)數(shù)(包括 0) |
@Past | 驗(yàn)證日期值是過去 |
@PastOrPresent | 驗(yàn)證日期值是過去(包括現(xiàn)在) |
@Future | 驗(yàn)證日期值是未來 |
@FutureOrPresent | 驗(yàn)證日期值是未來(包括現(xiàn)在) |
看完上述內(nèi)容,你們掌握怎么在Spring Boot項(xiàng)目中利用JSR-380進(jìn)行校驗(yàn)的方法了嗎?如果還想學(xué)到更多技能或想了解更多相關(guān)內(nèi)容,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道,感謝各位的閱讀!
當(dāng)前名稱:怎么在SpringBoot項(xiàng)目中利用JSR-380進(jìn)行校驗(yàn)-創(chuàng)新互聯(lián)
URL分享:http://www.rwnh.cn/article40/csideo.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供企業(yè)建站、建站公司、外貿(mào)建站、做網(wǎng)站、網(wǎng)站設(shè)計(jì)公司、電子商務(wù)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容