Java如何使用JSR303校验数据与自定义校验注解

 更新时间:2020年09月02日 10:57:20   作者:码上好运  
这篇文章主要介绍了Java如何使用JSR303校验数据与自定义校验注解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

一、自带校验注解实现数据校验

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地址格式错误", groups = {AddGroup.class, 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]$/", groups = {AddGroup.class, UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@Min(value = 0, groups = {AddGroup.class, 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校验数据内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot 如何使用sharding jdbc进行分库分表

    SpringBoot 如何使用sharding jdbc进行分库分表

    这篇文章主要介绍了SpringBoot 如何使用sharding jdbc进行分库分表,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • IntelliJ IDEA失焦自动重启服务的解决方法

    IntelliJ IDEA失焦自动重启服务的解决方法

    在使用 IntelliJ IDEA运行 SpringBoot 项目时,你可能会遇到一个令人困扰的问题,一旦你的鼠标指针离开当前IDE窗口,点击其他位置时, IDE 窗口会失去焦点,你的 SpringBoot 服务就会自动重启,所以本文给大家介绍了IntelliJ IDEA失焦自动重启服务的解决方法
    2023-10-10
  • springboot 自定义LocaleResolver实现切换语言

    springboot 自定义LocaleResolver实现切换语言

    我们在做项目的时候,往往有很多项目需要根据用户的需要来切换不同的语言,使用国际化就可以轻松解决。这篇文章主要介绍了springboot 自定义LocaleResolver切换语言,需要的朋友可以参考下
    2019-10-10
  • 使用@JsonFormat的一个坑及解决

    使用@JsonFormat的一个坑及解决

    这篇文章主要介绍了使用@JsonFormat的一个坑及解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • Java中检查字符串是否以特定字符结尾

    Java中检查字符串是否以特定字符结尾

    这篇文章主要介绍了Java中检查字符串是否以特定字符结尾,文章围绕主题展开字符串匹配问题,具有一定的参考价值需要的小伙伴可以参考一下
    2022-06-06
  • mybatis-plus调用update方法时,自动填充字段不生效问题及解决

    mybatis-plus调用update方法时,自动填充字段不生效问题及解决

    这篇文章主要介绍了mybatis-plus调用update方法时,自动填充字段不生效问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-06-06
  • ApiOperation和ApiParam注解依赖的安装和使用以及注意事项说明

    ApiOperation和ApiParam注解依赖的安装和使用以及注意事项说明

    这篇文章主要介绍了ApiOperation和ApiParam注解依赖的安装和使用以及注意事项说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-09-09
  • 解决spring boot2集成activiti6踩过的坑

    解决spring boot2集成activiti6踩过的坑

    这篇文章主要介绍了解决spring boot2集成activiti6踩过的坑,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • java仿百度假分页代码实现的详解

    java仿百度假分页代码实现的详解

    这篇文章主要介绍了java仿百度假分页代码实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • 在springboot项目中同时接收文件和多个参数的方法总结

    在springboot项目中同时接收文件和多个参数的方法总结

    在开发接口中,遇到了需要同时接收文件和多个参数的情况,可以有多种方式实现文件和参数的同时接收,文中给大家介绍了两种实现方法,感兴趣的同学跟着小编一起来看看吧
    2023-08-08

最新评论