腳本之家服務器常用軟件

快捷導航

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

更新時間：2018年06月13日 09:46:44 作者：Real_man

Spring校驗器，參數(shù)校驗從此簡單。下面這篇文章主要給大家介紹了關(guān)于Spring中校驗器(Validator)的相關(guān)資料，文中通過示例代碼介紹非常詳細，需要的朋友可以參考借鑒，下面隨著小編來一起學習學習吧

前言

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

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

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

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

JSR-303

JSR-303是Java為Bean數(shù)據(jù)合法性校驗提供的標準框架，它定義了一套可標注在成員變量，屬性方法上的校驗注解。
Hibernate Validation提供了這套標準的實現(xiàn)，在我們引入Spring Boot web starter或者Spring boot starter validation的時候，默認會引入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、運行應用

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

校驗年齡

校驗名稱

校驗通過

常見的校驗注解

@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=) 被注釋的元素必須符合指定的正則表達式

Hibernate Validator提供的校驗注解：

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

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

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

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

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

自定義校驗注解

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

1、編寫校驗注解

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

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

我們知道注解只是一個標記，真正的邏輯還要在特定的類中實現(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}");
 //工具方法，判斷是否是手機號
 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) {
  //是否為手機號的實現(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īng)生效了。

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

額外

也可以通過方法的校驗。

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;
 }
}