一、自帶校驗註解實現資料校驗

1、web專案匯入依賴

<!-- 該依賴預設匯入了 hibernate-validator 所以不需要再單獨匯入 -->
　　<dependency>
　　　　<groupId>org.springframework.boot</groupId>
　　　　<artifactId>spring-boot-starter-web</artifactId>
　　</dependency>

下圖可以看到spring-boot-starter-web依賴自動引入了hibernate-validator；

如果感興趣的話還可以進入hibernate-validator檢視引入了什麼相關依賴

2、預設註解的使用

在需要校驗的欄位新增不同校驗型別的註解

	/**
   * 品牌id
   */
  @NotNull(message = "必須提交品牌id")
  @TableId
  private Long brandId;
  /**
   * 品牌名
   */
  @NotBlank(message = "品牌名不可為空")
  private String name;
  /**
   * 品牌logo地址
   */
  @NotBlank(message = "logo必須提交")
  @URL(message = "logo地址格式錯誤")
  private String logo;
  /**
   * 介紹
   */
  private String descript;
  /**
   * 顯示狀態[0-不顯示；1-顯示]
   */private Integer showStatus;
  /**
   * 檢索首字母 - 正則校驗實現
   */
  @NotNull(message = "首字母必須提交")
  @Pattern(message = "首字母必須是一個字母，且a-z或A-Z",regexp = "/^[a-zA-Z]$/")
  private String firstLetter;

下圖是自帶的所有校驗註解，可以進入檢視原始碼的註釋檢視如何使用

3、設定誰需要進行資料校驗！！！

在介面引數需要校驗的物件前標註註解**@Valid** - 標明前臺提交資料時該物件的欄位需要進行資料校驗

/**
   * 修改
   */
  @RequestMapping("/update")
  public R update(@Valid @RequestBody AttrGroupEntity attrGroup){
    attrGroupService.updateById(attrGroup);

    return R.ok();
  }

二、如何使用分組校驗？

由於不同功能的介面接收的物件資料可能需要校驗的欄位不同，並不是每一個介面接收的物件的所有欄位都需要校驗的，所以則需要使用"分組校驗"來區分不同的業務需要校驗不同的欄位，在這裡我使用新增業務和修改業務為例。

根據上圖可以看到，預設的註解原始碼不僅可以設定message（訊息）還有一個可以設定group（分組）

1、建立分組介面

/**
 * 新增業務分組校驗 - 不需要實現任何業務，只是用來標識身份
 */
public interface AddGroup {
}

/**
 * 修改業務分組校驗 - 不需要實現任何業務，只是用來標識身份
 */
public interface UpdateGroup {
}

2、如何使用分組校驗？

2.1、修改Bean每個欄位上校驗註解，設定group值

	/**
	 * 品牌id
	 */
	@NotNull(message = "修改必須提交品牌id",groups = {UpdateGroup.class})
	@Null(message = "新增不需要提交品牌id",groups = {AddGroup.class})
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名不可為空",groups = {AddGroup.class,UpdateGroup.class})
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank(message = "logo必須提交",groups = {AddGroup.class})
	@URL(message = "logo地址格式錯誤",UpdateGroup.class})
	private String logo;
	/**
	 * 介紹
	 */
	private String descript;
	/**
	 * 顯示狀態[0-不顯示；1-顯示]
	 */
	private Integer showStatus;
	/**
	 * 檢索首字母
	 */
	@NotNull(message = "首字母必須提交",groups = {AddGroup.class})
	@Pattern(message = "首字母必須是一個字母，且a-z或A-Z",regexp = "/^[a-zA-Z]$/",UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@Min(value = 0,UpdateGroup.class})
	private Integer sort;

2.2、設定什麼業務需要使用什麼分組進行校驗

/**
   * 儲存 - 使用新增分組校驗介面引數物件的欄位
   */
  @RequestMapping("/save")
  public R save(@Validated(value = {AddGroup.class}) @RequestBody BrandEntity brand){
		brandService.save(brand);

    return R.ok();
  }

/**
   * 修改 - 使用修改分組校驗介面引數物件的欄位
   */
  @RequestMapping("/update")
  public R update(@Validated(value = UpdateGroup.class) @RequestBody BrandEntity brand){
		brandService.updateById(brand);

    return R.ok();
  }

此時，不同業務就會校驗不同的欄位！！！

三、自定義校驗註解

1、匯入依賴的jar包

<dependency>
  <groupId>javax.validation</groupId>
  <artifactId>validation-api</artifactId>
  <version>2.0.1.Final</version>
</dependency>

2、編寫自定義校驗註解

/**
 * 自定義校驗註解
 * @author mashanghaoyun
 * @date 2020/8/3115:01
 */
@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {})
public @interface ListValue {

  String message() default "{com.mashanghaoyun.common.valid.ListValue.message}";

  Class<?>[] groups() default {};

  Class<? extends Payload>[] payload() default {};

  int[] vals() default { };

}

3、編寫自定義校驗器

/**
 * 自定義校驗器
 * @author mashanghaoyun
 * @date 2020/8/3115:15
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {

  private Set<Integer> set = new HashSet<>();

  /**
   * @Description 初始化方法
   * @Author mashanghaoyun
   * @Date 15:17 2020/8/31
   * @Param [constraintAnnotation]
   * @return void
   **/
  @Override
  public void initialize(ListValue constraintAnnotation) {
    int[] vals = constraintAnnotation.vals();
    if (vals.length > 0) {
      for (int val : vals) {
        set.add(val);
      }
    }
  }

  /**
   * @Description 判斷是否校驗成功
   * @Author mashanghaoyun
   * @Date 15:18 2020/8/31
   * @Param [value（當前提交校驗的值）,context]
   * @return boolean
   **/
  @Override
  public boolean isValid(Integer value,ConstraintValidatorContext context) {
    if (set.size() > 0) {
      if (set.contains(value)) {
        return true;
      }
    }
    return false;
  }
}

3、關聯自定義註解與校驗器

4、使用自定義註解

到此這篇關於Java如何使用JSR303校驗資料與自定義校驗註解的文章就介紹到這了,更多相關Java JSR303校驗資料內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！