日韩成人免费在线_国产成人一二_精品国产免费人成电影在线观..._日本一区二区三区久久久久久久久不

當前位置:首頁 > 科技  > 軟件

必讀!SpringBoot接口參數校驗N種實用技巧大揭秘

來源: 責編: 時間:2023-11-08 09:10:33 252觀看
導讀環境:SpringBoot2.6.12實際的開發工作中大部分的接口都是需要進行參數有效性校驗的,參數可能是簡單的基本數據類型,也可能是對象類型,基本上所有接收參數的接口都是需要對這些參數進行校驗的,你對這些參數是怎么校驗的?接下

環境:SpringBoot2.6.12wVD28資訊網——每日最新資訊28at.com

實際的開發工作中大部分的接口都是需要進行參數有效性校驗的,參數可能是簡單的基本數據類型,也可能是對象類型,基本上所有接收參數的接口都是需要對這些參數進行校驗的,你對這些參數是怎么校驗的?接下來帶你一起見識下我在實際項目中都應用過哪些校驗姿勢!。該案例會詳細介紹如下 7 方面的內容。wVD28資訊網——每日最新資訊28at.com

  1. 簡單參數校驗
  2. 參數校驗分組
  3. 單個參數校驗
  4. 嵌套參數校驗
  5. 自定義工具類參數校驗
  6. 國際化支持
  7. AOP 驗證參數統一處理

wVD28資訊網——每日最新資訊28at.com

在正式介紹主體內容前我們還是先要了解學習一些規范 JSR303。wVD28資訊網——每日最新資訊28at.com

JSR 是什么?

JSR 是 Java Specification Requests 的縮寫,意思是 Java 規范提案。是指向 JCP(Java Community Process)提出新增一個標準化技術規范的正式請求。任何人都可以提交 JSR,以向 Java 平臺增添新的 API 和服務。JSR 已成為 Java 界的一個重要標準。JSR-303 是 JAVA EE 6 中的一項子規范,叫做 Bean Validation,Hibernate Validator 是 Bean Validation 的參考實現 . Hibernate Validator 提供了 JSR 303 規范中所有內置 constraint 的實現,除此之外還有一些附加的 constraint。相關注解如下:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

在Spring中提供了SpringValidation驗證框架對參數的驗證機制提供了@Validated(Spring'sJSR-303規范,是標準JSR-303的一個變種),javax提供了@Valid(標準JSR-303規范),結合BindingResult對象可以直接獲取錯誤信息。在本案中這兩種是等效的,但是也有區別,在接下來的案例中將會說明。wVD28資訊網——每日最新資訊28at.com

1. 配置依賴

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.aspectj</groupId><artifactId>aspectjrt</artifactId></dependency><dependency><groupId>org.aspectj</groupId><artifactId>aspectjweaver</artifactId><scope>runtime</scope></dependency></dependencies>

org.aspectj 依賴是在最后我們要通過 AOP 技術來實現統一參數的校驗。wVD28資訊網——每日最新資訊28at.com

2. 參數驗證

  • 簡單參數校驗
public class Users {  @NotEmpty(message = "姓名必需填寫")  private String name ;  @Min(value = 10, message = "年齡不能小于 10")  private Integer age ;  @Length(min = 6, max = 18, message = "郵箱介于 6 到 18 之間")  private String email ;  @NotEmpty(message = "電話必需填寫")  private String phone ;  // 這里的2個接口在下面的案例中會使用到  public static interface G1 {}  public static interface G2 {}}

這里對需要校驗的字段都應用了不同的注解來約束。接下來就是在Controller接口上添加相應的注解即可:wVD28資訊網——每日最新資訊28at.com

@ResponseBodypublic class UsersController extends BaseController {  @RequestMapping(value = "/valid/save1", method = RequestMethod.POST)  public Object save1(@RequestBody @Validated Users user, BindingResult result) {    Optional<List<String>> op = valid(result) ;    if (op.isPresent()) {      return op.get() ;    }    return "success" ;  }}public class BaseController {  protected Optional<List<String>> valid(BindingResult result) {    if (result.hasErrors()) {      return Optional.of(result.getAllErrors().stream().map(err -> err.getDefaultMessage()).collect(Collectors.toList())) ;    }    return Optional.empty() ;  }}

接收參數的 Users 對象前面要是用@Validated 注解,并且通過 BindingResult 來收集錯誤信息(可判斷是否有錯誤信息);測試如下:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

正確情況

圖片圖片wVD28資訊網——每日最新資訊28at.com

  • 參數校驗分組

有些時候我們這一個對象可能會應用到不同的場景,出現不同的校驗規則該怎么做呢?這時候我們就可以應用分組功能,不同的應用場景指明不同的分組即可,開始擼。注意:JSR303 是沒有分組功能的。wVD28資訊網——每日最新資訊28at.com

public class Users {  @NotEmpty(message = "姓名不能為空", groups = G1.class)  private String name ;  @Min(value = 10, message = "年齡不能小于 10", groups = G1.class)  @Min(value = 20, message = "年齡不能小于 20", groups = G2.class)  private Integer age ;  @Length(min = 6, max = 18, message = "郵箱介于 6 到 18 之間", groups = {G1.class, G2.class})  private String email ;  @NotEmpty(message = "電話必需填寫")  private String phone ;  public static interface G1 {}  public static interface G2 {}}

這里不同的字段上加了 groups 屬性,指明屬于哪個分組。注意在該實體類中我們又定義了 2 個類 G1,G2 就是為了分組用的(具體指明哪個分組)。接口處理:wVD28資訊網——每日最新資訊28at.com

@RequestMapping(value = "/valid/save1", method = RequestMethod.POST)public Object save1(@RequestBody @Validated(Users.G1.class) Users user, BindingResult result) {  Optional<List<String>> op = valid(result) ;  if (op.isPresent()) {    return op.get() ;  }  return "success" ;}@RequestMapping(value = "/valid/save2", method = RequestMethod.POST)public Object save2(@RequestBody @Validated(Users.G2.class) Users user, BindingResult result) {  Optional<List<String>> op = valid(result) ;  if (op.isPresent()) {    return op.get() ;  }  return "success" ;}

在這個兩個接口中 @Validated(Users.G2.class)分別指明了自己的分組,接下來測試看看效果。wVD28資訊網——每日最新資訊28at.com

分組 G1 測試:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

從這里返回的信息來看我們的 phone 雖然寫了@NotEmpty 但是并沒有起作用,因為我們并沒有指明他的分組,并且接口上我們指明了是用 G1 分組。wVD28資訊網——每日最新資訊28at.com

分組 G2 測試:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

在這個接口中發現 name 驗證是 G1 的,所以這里不會進行校驗,并且年齡的判斷是不能小于 20 了。wVD28資訊網——每日最新資訊28at.com

  • 單個參數校驗

單個參數的校驗不需要實體對象,一般就是吧 JSR303 相關的注解直接應用到接口參數上即可。同時還需要在 Controller 類上添加@Validated 注解。wVD28資訊網——每日最新資訊28at.com

@Validatedpublic class UsersController extends BaseController {  @PackMapping("/valid/find")  public Object find(@NotEmpty(message = "參數 Id 不能為空") String id) {    return "查詢到參數【" + id + "】" ;  }}

該接口中直接將注解應用到參數上。測試:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

同時控制臺會輸出如下異常:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

你也發現這種異常信息提示很不友好,接下來我們做個簡單的局部異常處理。wVD28資訊網——每日最新資訊28at.com

我們只需要在Controller添加如下方法即可:wVD28資訊網——每日最新資訊28at.com

@ExceptionHandler(ConstraintViolationException.class)@ResponseBodypublic Object ConstraintViolationExceptionHandler(ConstraintViolationException e) {  String message = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining());  return message ;}

在該 Controller 中我們添加了一個異常處理句柄(簡單吧將錯誤信息輸出)。wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

  • 嵌套參數校驗

在實際的工作中往往參數對象比這復雜的多,Users 對象中可能還嵌套有其他的對象,這個其他的對象也可能需要參數的校驗。接下來我們就來看看這種嵌套參數是如何校驗的。wVD28資訊網——每日最新資訊28at.com

public class Users {  @NotEmpty(message = "姓名不能為空", groups = G1.class)  private String name ;  @Min(value = 10, message = "年齡不能小于 10", groups = G1.class)  @Min(value = 20, message = "年齡不能小于 20", groups = G2.class)  private Integer age ;  @Length(min = 6, max = 18, message = "郵箱介于 6 到 18 之間", groups = {G1.class, G2.class})  private String email ;  @NotEmpty(message = "電話必需填寫")  private String phone ;  @Valid  private Address address;}

注意:嵌套對象 Address 的校驗需要在上面加@Valid 注解。wVD28資訊網——每日最新資訊28at.com

public class Address {  @NotEmpty(message = "地址信息必需填寫")  private String addr ;}

測試接口:wVD28資訊網——每日最新資訊28at.com

@RequestMapping(value = "/valid/save3", method = RequestMethod.POST)public Object save3(@RequestBody @Validated Users user, BindingResult result) {  Optional<List<String>> op = valid(result) ;  if (op.isPresent()) {    return op.get() ;  }  return "success" ;}

接口上沒有什么特別的與之前的一模一樣。注意:這里的校驗沒有設定分組,所以校驗時都是校驗的沒有設置分組的字段。wVD28資訊網——每日最新資訊28at.com

測試:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

這里發現我們的地址信息根本就沒有進行校驗。接著我們吧參數變動下wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

參數中我們吧 address 字段設置上后 參數進行校驗了。接下來修改 Users 實體,吧 Address 默認 new 出來再進行測試wVD28資訊網——每日最新資訊28at.com

@Validprivate Address address = new Address();

圖片圖片wVD28資訊網——每日最新資訊28at.com

發現即便我們的入參沒有 address 字段也能進行校驗了,這里大家需要注意下。wVD28資訊網——每日最新資訊28at.com

  • 自定義參數校驗

請查看【技巧】API接口參數驗證的必備神器,讓你的代碼更高效!wVD28資訊網——每日最新資訊28at.com

  • 國際化支持
public class Users {  @NotEmpty(message = "{name.notempty}", groups = G1.class)  private String name ;  @Min(value = 10, message = "年齡不能小于 10", groups = G1.class)  @Min(value = 20, message = "年齡不能小于 20", groups = G2.class)  private Integer age ;  @Length(min = 6, max = 18, message = "郵箱介于 6 到 18 之間", groups = {G1.class,  G2.class})  private String email ;  @NotEmpty(message = "電話必需填寫")  private String phone ;  @Valid  private Address address = new Address();}

注意這里的 name 字段中的 message 屬性我們使用了表達式的方式,而 name.notempty 為我們在資源文件中定義的 key。接下來,在 resources/下新建如下屬性文件:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

屬性文件必須是 ValidationMessages 開頭。默認文件及 zh_CN 內容:wVD28資訊網——每日最新資訊28at.com

name.notempty=姓名必需填寫

en_US 內容:wVD28資訊網——每日最新資訊28at.com

name.notempty=name is require

測試:wVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

為了模擬英文環境,我們需要設置請求頭 Accept-Language:en-USwVD28資訊網——每日最新資訊28at.com

圖片圖片wVD28資訊網——每日最新資訊28at.com

顯示了 en_US.properties 中定義的消息,到此國際化完成。wVD28資訊網——每日最新資訊28at.com

  • AOP 驗證參數統一處理

自定義注解標記需要進行統一參數校驗處理的接口。wVD28資訊網——每日最新資訊28at.com

@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface EnableValidate {}

AOP切面類wVD28資訊網——每日最新資訊28at.com

@Component@Aspectpublic class ValidateAspect {  @Pointcut("@annotation(com.pack.params.valid.EnableValidate)")  public void valid() {}  @Before("valid()")  public void validateBefore(JoinPoint jp) {    Object[] args = jp.getArgs() ;    for (Object arg : args) {      if (arg instanceof BindingResult) {        BindingResult result = (BindingResult) arg ;        if (result.hasErrors()) {          String messages = result.getAllErrors().stream().map(err -> err.getDefaultMessage()).collect(Collectors.joining(",")) ;          throw new ParamsException(messages) ;        }      }    }  }}

定義了一個前置通知,攔截標記有@EnableValidate 注解的接口。如果有異常信息收集錯誤信息然后拋出異常信息。測試:wVD28資訊網——每日最新資訊28at.com

@PackMapping(value = "/valid/save1", method = RequestMethod.POST)@EnableValidatepublic Object save1(@RequestBody @Validated(Users.G1.class) Users user, BindingResult result) {  Optional<List<String>> op = valid(result) ;  if (op.isPresent()) {    return op.get() ;  }  return "success" ;}

圖片圖片wVD28資訊網——每日最新資訊28at.com

到此我們通過 AOP 技術實現了參數統一處理,但是這樣輸出錯誤信息很不友好,接下來我們來完善下,通過全局異常通知攔截處理。這里的異常信息我們可以通過全局異常處理下格式。wVD28資訊網——每日最新資訊28at.com

完畢!!!wVD28資訊網——每日最新資訊28at.com

本文鏈接:http://www.www897cc.com/showinfo-26-17647-0.html必讀!SpringBoot接口參數校驗N種實用技巧大揭秘

聲明:本網頁內容旨在傳播知識,若有侵權等問題請及時與本網聯系,我們將在第一時間刪除處理。郵件:2376512515@qq.com

上一篇: JavaScript的大分水嶺:CommonJS vs ES模塊

下一篇: Java中的泛型,看完這個還不會,我倒立洗頭!

標簽:
  • 熱門焦點
Top 主站蜘蛛池模板: 东光县| 湟中县| 富锦市| 长岛县| 泰和县| 青河县| 伊宁市| 五指山市| 攀枝花市| 郸城县| 龙泉市| 西林县| 偃师市| 玉树县| 鄢陵县| 瑞丽市| 沛县| 浦北县| 恩平市| 博乐市| 博客| 香河县| 晋江市| 封丘县| 广丰县| 漯河市| 孙吴县| 邯郸市| 普兰店市| 仙游县| 仙居县| 东城区| 高清| 普定县| 安康市| 聂荣县| 富源县| 上栗县| 陇西县| 荆州市| 祁连县|