欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

Spring中校驗器(Validator)的深入講解

 更新時間:2018年06月13日 09:46:44   作者:Real_man  
Spring校驗器,參數(shù)校驗從此簡單。下面這篇文章主要給大家介紹了關(guān)于Spring中校驗器(Validator)的相關(guān)資料,文中通過示例代碼介紹非常詳細(xì),需要的朋友可以參考借鑒,下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

前言

Spring框架的 validator 組件,是個輔助組件,在進(jìn)行數(shù)據(jù)的完整性和有效性非常有用,通過定義一個某個驗證器,即可在其它需要的地方,使用即可,非常通用。


應(yīng)用在執(zhí)行業(yè)務(wù)邏輯之前,必須通過校驗保證接受到的輸入數(shù)據(jù)是合法正確的,但很多時候同樣的校驗出現(xiàn)了多次,在不同的層,不同的方法上,導(dǎo)致代碼冗余,浪費時間,違反DRY原則。

  • 每一個控制器都要校驗
  • 過多的校驗參數(shù)會導(dǎo)致代碼太長
  • 代碼的復(fù)用率太差,同樣的代碼如果出現(xiàn)多次,在業(yè)務(wù)越來越復(fù)雜的情況下,維護(hù)成本呈指數(shù)上升。

可以考慮把校驗的代碼封裝起來,來解決出現(xiàn)的這些問題。

JSR-303

JSR-303是Java為Bean數(shù)據(jù)合法性校驗提供的標(biāo)準(zhǔn)框架,它定義了一套可標(biāo)注在成員變量,屬性方法上的校驗注解。
Hibernate Validation提供了這套標(biāo)準(zhǔn)的實現(xiàn),在我們引入Spring Boot web starter或者Spring boot starter validation的時候,默認(rèn)會引入Hibernate Validation。

用法實例

說了這么多廢話,上代碼。

1、引入SpringBoot項目

 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 <dependency>
  <groupId>org.hibernate.validator</groupId>
  <artifactId>hibernate-validator</artifactId>
 </dependency>
 <!-- 引入lomhok --> 
 <dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
 </dependency> 

2、編寫校驗對象

@Data
public class User {
 // 名字不允許為空,并且名字的長度在2位到30位之間
 // 如果名字的長度校驗不通過,那么提示錯誤信息
 @NotNull
 @Size(min=2, max=30,message = "請檢查名字的長度是否有問題")
 private String name;

 // 不允許為空,并且年齡的最小值為18
 @NotNull
 @Min(18)
 private Integer age;
}

3、創(chuàng)建控制器

@SpringBootApplication
@RestController
public class UserApplication{
 public static void main(String[] args) {
 SpringApplication.run(UserApplication.class,args);
 }
 
 // 1. 要校驗的參數(shù)前,加上@Valid注解
 // 2. 緊隨其后的,跟上一個BindingResult來存儲校驗信息
 @RequestMapping("/test1")
 public Object test1(
  @Valid User user,
  BindingResult bindingResult
 ) {
 //如果檢驗出了問題,就返回錯誤信息
 // 這里我們返回的是全部的錯誤信息,實際中可根據(jù)bindingResult的方法根據(jù)需要返回自定義的信息。
 // 通常的解決方案為:JSR-303 + 全局ExceptionHandler
 if (bindingResult.hasErrors()){
  return bindingResult.getAllErrors();
 }
 return "OK";
 } 
}

4、運行應(yīng)用

稍作演示下運行的結(jié)果,可以看出校驗框架已經(jīng)生效了。


校驗?zāi)挲g

校驗名稱

校驗通過

常見的校驗注解

@Null 被注釋的元素必須為 null

@NotNull 被注釋的元素必須不為 null

@AssertTrue 被注釋的元素必須為 true

@AssertFalse 被注釋的元素必須為 false

@Min(value) 被注釋的元素必須是一個數(shù)字,其值必須大于等于指定的最小值

@Max(value) 被注釋的元素必須是一個數(shù)字,其值必須小于等于指定的最大值

@DecimalMin(value) 被注釋的元素必須是一個數(shù)字,其值必須大于等于指定的最小值

@DecimalMax(value) 被注釋的元素必須是一個數(shù)字,其值必須小于等于指定的最大值

@Size(max=, min=) 被注釋的元素的大小必須在指定的范圍內(nèi)

@Digits (integer, fraction) 被注釋的元素必須是一個數(shù)字,其值必須在可接受的范圍內(nèi)

@Past 被注釋的元素必須是一個過去的日期

@Future 被注釋的元素必須是一個將來的日期

@Pattern(regex=,flag=) 被注釋的元素必須符合指定的正則表達(dá)式

Hibernate Validator提供的校驗注解:

@NotBlank(message =) 驗證字符串非null,且長度必須大于0

@Email 被注釋的元素必須是電子郵箱地址

@Length(min=,max=) 被注釋的字符串的大小必須在指定的范圍內(nèi)

@NotEmpty 被注釋的字符串的必須非空

@Range(min=,max=,message=) 被注釋的元素必須在合適的范圍內(nèi)

自定義校驗注解

有時候,第三方庫中并沒有我們想要的校驗類型,好在系統(tǒng)提供了很好的擴(kuò)展能力,我們可以自定義檢驗。
比如,我們想校驗用戶的手機(jī)格式,寫手機(jī)號碼校驗器

1、編寫校驗注解

// 我們可以直接拷貝系統(tǒng)內(nèi)的注解如@Min,復(fù)制到我們新的注解中,然后根據(jù)需要修改。
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
//注解的實現(xiàn)類。
@Constraint(validatedBy = {IsMobileValidator.class})
public @interface IsMobile {
 //校驗錯誤的默認(rèn)信息
 String message() default "手機(jī)號碼格式有問題";
 //是否強(qiáng)制校驗
 boolean isRequired() default false;
 Class<?>[] groups() default {};
 Class<? extends Payload>[] payload() default {};
}

2、編寫具體的實現(xiàn)類

我們知道注解只是一個標(biāo)記,真正的邏輯還要在特定的類中實現(xiàn),上一步的注解指定了實現(xiàn)校驗功能的類為IsMobileValidator。

// 自定義注解一定要實現(xiàn)ConstraintValidator接口奧,里面的兩個參數(shù)
// 第一個為 具體要校驗的注解
// 第二個為 校驗的參數(shù)類型
public class IsMobileValidator implements ConstraintValidator<IsMobile, String> {

 private boolean required = false;

 private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
 //工具方法,判斷是否是手機(jī)號
 public static boolean isMobile(String src) {
  if (StringUtils.isEmpty(src)) {
   return false;
  }
  Matcher m = mobile_pattern.matcher(src);
  return m.matches();
 }

 @Override
 public void initialize(IsMobile constraintAnnotation) {
  required = constraintAnnotation.isRequired();
 }

 @Override
 public boolean isValid(String phone, ConstraintValidatorContext constraintValidatorContext) {
  //是否為手機(jī)號的實現(xiàn)
  if (required) {
   return isMobile(phone);
  } else {
   if (StringUtils.isEmpty(phone)) {
    return true;
   } else {
    return isMobile(phone);
   }
  }
 }
}

3、測試自定義注解的功能

@Data
public class User {
 @NotNull
 @Size(min=2, max=30,message = "請檢查名字的長度是否有問題")
 private String name;
 @NotNull
 @Min(18)
 private Integer age;
 //這里是新添加的注解奧
 @IsMobile
 private String phone;
}

4、測試

通過

手機(jī)號有問題

可以看出自定義的注解已經(jīng)生效了。

我們還可以繼續(xù)優(yōu)化的地方,新建一個全局的異常,如果校驗失敗的話,拋出全局的業(yè)務(wù)異常,捕獲業(yè)務(wù)異常,然后返回用戶友好的提示信息。

額外

也可以通過方法的校驗。

1、控制器上添加@Validated注解

2、在控制器的方法上添加校驗注解,@Min,@Max等。

@Validated
@RestController
@SpringBootApplication
public class UserApplication{
 public static void main(String[] args) {
  SpringApplication.run(UserApplication.class,args);
 }

 @RequestMapping("/test2")
 public String test2(
   @IsMobile String phone

 ){
  return phone + "ok";
 }

 @ExceptionHandler(ConstraintViolationException.class)
 @ResponseBody
 public Object handleConstraintViolationException(ConstraintViolationException cve){

  HashSet<String> messageSet = new HashSet();
  for (ConstraintViolation constraintViolation : cve.getConstraintViolations()) {
   messageSet.add(constraintViolation.getMessage());
  }
  return messageSet;
 }
}

類的校驗規(guī)則

最后

通過使用校驗器,所有的控制器,我們都不用再去做校驗啦,代碼再回看是不是清爽很多。我們寫代碼很簡答,但是一定要想到如何把代碼寫的更簡單,更清晰,更利于維護(hù),寫重復(fù)的代碼是在浪費自己的時間奧。

以后再碰到參數(shù)校驗的情況,首先想到的不是直接就去校驗,可以查找自己是否寫過某一類的驗證器,可以直接拿來即用。

總結(jié)

以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。

相關(guān)文章

  • Java Socket 編程詳解

    Java Socket 編程詳解

    Java Socket 編程是指使用 Java 語言進(jìn)行網(wǎng)絡(luò)通信的過程,包括建立連接、傳輸數(shù)據(jù)和關(guān)閉連接等操作,本文將詳細(xì)介紹Java Socket編程,需要的朋友可以參考下
    2023-05-05
  • Spring與Mybatis相結(jié)合實現(xiàn)多數(shù)據(jù)源切換功能

    Spring與Mybatis相結(jié)合實現(xiàn)多數(shù)據(jù)源切換功能

    這篇文章主要介紹了Spring與Mybatis相結(jié)合實現(xiàn)多數(shù)據(jù)源切換功能的相關(guān)資料,非常不錯,具有參考借鑒價值,需要的朋友可以參考下
    2016-06-06
  • RocketMQ根據(jù)Tag進(jìn)行消息過濾

    RocketMQ根據(jù)Tag進(jìn)行消息過濾

    消費者訂閱了某個主題后,Apache RocketMQ 會將該主題中的所有消息投遞給消費者。若消費者只需要關(guān)注部分消息,可通過設(shè)置過濾條件在 Apache RocketMQ 服務(wù)端進(jìn)行過濾,只獲取到需要關(guān)注的消息子集,避免接收到大量無效的消息
    2023-02-02
  • Java雜談之如何消除代碼中一大串參數(shù)列表

    Java雜談之如何消除代碼中一大串參數(shù)列表

    參數(shù)列表和字面意思差不多,主要是表示該參數(shù)數(shù)量不是固定的,可能會有一個參數(shù),可能多個,不管多少個參數(shù),都放到一個數(shù)組處理,這種參數(shù)叫可變參數(shù)??勺冮L參數(shù)要放在最后一個參數(shù)位置處理,但是一個函數(shù)里面不能有倆種類型的可變參數(shù)
    2021-10-10
  • 關(guān)于重寫equals()方法和hashCode()方法及其簡單的應(yīng)用

    關(guān)于重寫equals()方法和hashCode()方法及其簡單的應(yīng)用

    這篇文章主要介紹了關(guān)于重寫equals()方法和hashCode()方法及其簡單的應(yīng)用,網(wǎng)上的知識有些可能是錯誤的,關(guān)于?equals()?方法的理解,大家討論不一樣,需要的朋友可以參考下
    2023-04-04
  • Java網(wǎng)絡(luò)通信中ServerSocket的設(shè)計優(yōu)化方案

    Java網(wǎng)絡(luò)通信中ServerSocket的設(shè)計優(yōu)化方案

    今天小編就為大家分享一篇關(guān)于Java網(wǎng)絡(luò)通信中ServerSocket的設(shè)計優(yōu)化方案,小編覺得內(nèi)容挺不錯的,現(xiàn)在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧
    2019-04-04
  • 5個步驟讓你明白多線程和線程安全

    5個步驟讓你明白多線程和線程安全

    本文詳細(xì)講解了多線程和線程安全的實現(xiàn),文中通過示例代碼介紹的非常詳細(xì)。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2021-12-12
  • Java 中的內(nèi)存映射 mmap

    Java 中的內(nèi)存映射 mmap

    這篇文章主要介紹了Java 中的內(nèi)存映射,mmap 是一種內(nèi)存映射文件的方法,即將一個文件映射到進(jìn)程的地址空間,實現(xiàn)文件磁盤地址和一段進(jìn)程虛擬地址的映射,下面來看看詳細(xì)內(nèi)容,需要的朋友可以參考一下
    2021-11-11
  • java求解漢諾塔問題示例

    java求解漢諾塔問題示例

    漢諾塔問題的描述如下:有3根柱子A、B和C,在A上從上往下按照從小到大的順序放著一些圓盤,以B為中介,把盤子全部移動到C上。移動過程中,要求任意盤子的下面要么沒有盤子,要么只能有比它大的盤子。編程實現(xiàn)3階漢諾塔的求解步驟
    2014-02-02
  • 一文搞懂Java中對象池的實現(xiàn)

    一文搞懂Java中對象池的實現(xiàn)

    池化并不是什么新鮮的技術(shù),它更像一種軟件設(shè)計模式,主要功能是緩存一組已經(jīng)初始化的對象,以供隨時可以使用。本文將為大家詳細(xì)講講Java中對象池的實現(xiàn),需要的可以參考一下
    2022-07-07

最新評論