Java如何使用JSR303校驗(yàn)數(shù)據(jù)與自定義校驗(yàn)注解

更新時(shí)間：2020年09月02日 10:57:20 作者：碼上好運(yùn)

這篇文章主要介紹了Java如何使用JSR303校驗(yàn)數(shù)據(jù)與自定義校驗(yàn)注解，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

一、自帶校驗(yàn)注解實(shí)現(xiàn)數(shù)據(jù)校驗(yàn)

1、web項(xiàng)目導(dǎo)入依賴

<!-- 該依賴默認(rèn)導(dǎo)入了 hibernate-validator 所以不需要再單獨(dú)導(dǎo)入 -->
　　<dependency>
　　　　<groupId>org.springframework.boot</groupId>
　　　　<artifactId>spring-boot-starter-web</artifactId>
　　</dependency>

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

如果感興趣的話還可以進(jìn)入hibernate-validator查看引入了什么相關(guān)依賴

2、默認(rèn)注解的使用

在需要校驗(yàn)的字段添加不同校驗(yàn)類型的注解

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

下圖是自帶的所有校驗(yàn)注解，可以進(jìn)入查看源碼的注釋查看如何使用

3、設(shè)置誰(shuí)需要進(jìn)行數(shù)據(jù)校驗(yàn)?。?！

在接口參數(shù)需要校驗(yàn)的對(duì)象前標(biāo)注注解**@Valid** - 標(biāo)明前臺(tái)提交數(shù)據(jù)時(shí)該對(duì)象的字段需要進(jìn)行數(shù)據(jù)校驗(yàn)

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

    return R.ok();
  }

二、如何使用分組校驗(yàn)？

由于不同功能的接口接收的對(duì)象數(shù)據(jù)可能需要校驗(yàn)的字段不同，并不是每一個(gè)接口接收的對(duì)象的所有字段都需要校驗(yàn)的，所以則需要使用"分組校驗(yàn)"來(lái)區(qū)分不同的業(yè)務(wù)需要校驗(yàn)不同的字段，在這里我使用新增業(yè)務(wù)和修改業(yè)務(wù)為例。

根據(jù)上圖可以看到，默認(rèn)的注解源碼不僅可以設(shè)置message（消息）還有一個(gè)可以設(shè)置group（分組）

1、創(chuàng)建分組接口

/**
 * 新增業(yè)務(wù)分組校驗(yàn) - 不需要實(shí)現(xiàn)任何業(yè)務(wù)，只是用來(lái)標(biāo)識(shí)身份
 */
public interface AddGroup {
}

/**
 * 修改業(yè)務(wù)分組校驗(yàn) - 不需要實(shí)現(xiàn)任何業(yè)務(wù)，只是用來(lái)標(biāo)識(shí)身份
 */
public interface UpdateGroup {
}

2、如何使用分組校驗(yàn)？

2.1、修改Bean每個(gè)字段上校驗(yàn)注解，設(shè)置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地址格式錯(cuò)誤", groups = {AddGroup.class, UpdateGroup.class})
	private String logo;
	/**
	 * 介紹
	 */
	private String descript;
	/**
	 * 顯示狀態(tài)[0-不顯示；1-顯示]
	 */
	private Integer showStatus;
	/**
	 * 檢索首字母
	 */
	@NotNull(message = "首字母必須提交", groups = {AddGroup.class})
	@Pattern(message = "首字母必須是一個(gè)字母，且a-z或A-Z", regexp = "/^[a-zA-Z]$/", groups = {AddGroup.class, UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@Min(value = 0, groups = {AddGroup.class, UpdateGroup.class})
	private Integer sort;

2.2、設(shè)置什么業(yè)務(wù)需要使用什么分組進(jìn)行校驗(yàn)

/**
   * 保存 - 使用添加分組校驗(yàn)接口參數(shù)對(duì)象的字段
   */
  @RequestMapping("/save")
  public R save(@Validated(value = {AddGroup.class}) @RequestBody BrandEntity brand){
		brandService.save(brand);

    return R.ok();
  }

/**
   * 修改 - 使用修改分組校驗(yàn)接口參數(shù)對(duì)象的字段
   */
  @RequestMapping("/update")
  public R update(@Validated(value = UpdateGroup.class) @RequestBody BrandEntity brand){
		brandService.updateById(brand);

    return R.ok();
  }

此時(shí)，不同業(yè)務(wù)就會(huì)校驗(yàn)不同的字段?。?！

三、自定義校驗(yàn)注解

1、導(dǎo)入依賴的jar包

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

2、編寫自定義校驗(yàn)注解

/**
 * 自定義校驗(yàn)注解
 * @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、編寫自定義校驗(yàn)器

/**
 * 自定義校驗(yàn)器
 * @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 判斷是否校驗(yàn)成功
   * @Author mashanghaoyun
   * @Date 15:18 2020/8/31
   * @Param [value（當(dāng)前提交校驗(yàn)的值）, context]
   * @return boolean
   **/
  @Override
  public boolean isValid(Integer value, ConstraintValidatorContext context) {
    if (set.size() > 0) {
      if (set.contains(value)) {
        return true;
      }
    }
    return false;
  }
}

3、關(guān)聯(lián)自定義注解與校驗(yàn)器

4、使用自定義注解

到此這篇關(guān)于Java如何使用JSR303校驗(yàn)數(shù)據(jù)與自定義校驗(yàn)注解的文章就介紹到這了,更多相關(guān)Java JSR303校驗(yàn)數(shù)據(jù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: