SpringBoot 使用hibernate validator校验

 更新时间:2018年11月27日 11:32:22   作者:殷天文  
这篇文章主要介绍了SpringBoot 使用hibernate validator校验,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

本文将全面的介绍如何使用 validator 进行数据校验

本文源码: https://gitee.com/yintianwen7/taven-springboot-learning/tree/master/springboot-validate

准备工作

我们只需要引入 spring-boot-starter-web 包即可使用

1.常用注解

常用注解

2.简单的实体校验

public class CardDTO {

  @NotBlank
  private String cardId;

  @Size(min = 10, max = 10)
  @NotNull
  private String cardNum; // 卡号

  @Past
  @NotNull
  private Date createDate;

  @Range(max = 3)
  private String cardType;

  // 省略get set
}
@RestController
public class UserController {

  @PostMapping("simple")
  public Object simple(@RequestBody @Valid CardDTO cardDTO) {
    return cardDTO;
  }

}
  • 实体属性上添加校验注解
  • controller 方法 参数前 使用@Valid 即可

3. 复杂的实体校验

 3.1 嵌套实体校验

public class UserDTO {

  @NotBlank
  private String userId;

  @NotBlank
  private String username;

  private String password;

  @Valid
  private List<CardDTO> cardList;

  //省略 get set
}

controller 写法 同上,只是在 UserDTO cardList 属性上标记@Valid 注解 即可。 3.2 List<DTO> 校验

无效示例

如果我们想校验 一个实体List,如上图所示的这种写法是完全不起效的。

我们需要像 嵌套校验 时一样,对 List<CardDTO> 做一层封装

public class ValidList<E> implements List<E> {

  @Valid
  private List<E> list = new ArrayList<>();

  public List<E> getList() {
    return list;
  }

  public void setList(List<E> list) {
    this.list = list;
  }

  // 省略了 实现方法
}

重写实现方法完全使用 this.list.xxx()

Gitee:spring 会将数据封装到我们定义的 list 属性中,又将属性声明了 @Valid 使得 hibernate validator 可以为我们做校验!

3.3 使用 @Validated 分组校验

public interface Insert {
}

public interface Update {
}

定义两个接口

public class GroupCardDTO {

  @NotBlank(groups = {Update.class})
  private String id;

  @NotBlank(groups = {Insert.class})
  private String cardNum;

  @NotNull(groups = {Insert.class, Update.class})
  private Integer cardType;

  //省略 get set
}

实体标记的注解中添加 group 属性

@PostMapping("insert_card")
  public Object insert_card(@RequestBody @Validated(Insert.class) GroupCardDTO card){
    return card;
  }

使用 @Validated(xxx.class) 标记参数,完成分组校验!

4.自定义注解校验

当 validator 提供的注解无法满足我们的业务需求,可以通过自定义的方式来实现校验。

需求:校验某字符串必须为大写或者小写

public enum CaseMode {
  UPPER,
  LOWER
}

定义一个枚举类

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Target( { ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = CheckCaseValidator.class)
@Documented
public @interface CheckCase {

  String message() default "";

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

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

  CaseMode value() default CaseMode.LOWER;

}
  • 定义注解
  • @Constraint 指定我们的校验逻辑实现类
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class CheckCaseValidator implements ConstraintValidator<CheckCase, String> {

  private CaseMode caseMode;

  @Override
  public void initialize(CheckCase constraintAnnotation) {
    this.caseMode = constraintAnnotation.value();
  }

  @Override
  public boolean isValid(String value, ConstraintValidatorContext context) {

    if (value == null || "".equals(value.trim())) {
      return false;
    }

    switch (this.caseMode) {
      case LOWER:
        return value.equals(value.toLowerCase());
      case UPPER:
        return value.equals(value.toUpperCase());
      default:
        return false;
    }

  }

}
  • initialize() 初始化时执行,可以用来获取注解中的属性
  • isValid() 实现我们的校验逻辑

备注

我们自定义的注解依然支持 @Validated group 分组

本节源码: https://gitee.com/yintianwen7/taven-springboot-learning/tree/master/springboot-validate

本地下载地址:springboot-validate_jb51.rar

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Java在控制台输出带颜色字符的2种方式详解

    Java在控制台输出带颜色字符的2种方式详解

    这篇文章主要给大家介绍了关于Java在控制台输出带颜色字符的2种方式,文中通过实例代码以及图文介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2022-01-01
  • Android开发Activity管理工具类的操作方法

    Android开发Activity管理工具类的操作方法

    这篇文章主要介绍了Android开发Activity管理工具类,下面是一个完整的Activity管理工具类实现,可以帮助你管理应用中的所有Activity,方便一键退出应用、获取当前Activity等操作,需要的朋友可以参考下
    2021-02-02
  • 在Java中使用Jwt的示例代码

    在Java中使用Jwt的示例代码

    这篇文章主要介绍了在Java中使用Jwt的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • spring控制事务的三种方式小结

    spring控制事务的三种方式小结

    这篇文章主要介绍了spring控制事务的三种方式小结,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • Java如何通过jstack命令查询日志

    Java如何通过jstack命令查询日志

    在分析线上问题时常使用到jstack <PID>命令将当时Java应用程序的线程堆栈dump出来,面对jstack 日志,我们如何查看?下面小编给大家介绍下Java如何通过jstack命令查询日志,感兴趣的朋友一起看看吧
    2023-03-03
  • springboot+mybatis+redis 二级缓存问题实例详解

    springboot+mybatis+redis 二级缓存问题实例详解

    Mybatis默认没有开启二级缓存,需要在全局配置(mybatis-config.xml)中开启二级缓存。本文讲述的是使用Redis作为缓存,与springboot、mybatis进行集成的方法。需要的朋友参考下吧
    2017-12-12
  • 为何HashSet中使用PRESENT而不是null作为value

    为何HashSet中使用PRESENT而不是null作为value

    这篇文章主要介绍了为何HashSet中使用PRESENT而不是null作为value,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • Spring中Bean的生命周期实例解析

    Spring中Bean的生命周期实例解析

    这篇文章主要介绍了Spring中Bean的生命周期实例解析,我们定义一个自定义的MySpringBeanPostProcessor,主要是重写了BeanPostProcessor接口的postProcessBeforeInitialization与postProcessAfterInitialization方法,需要的朋友可以参考下
    2023-12-12
  • IDEA报错:java:无效的源发行版21解决方式

    IDEA报错:java:无效的源发行版21解决方式

    这篇文章主要给大家介绍了关于IDEA报错:java:无效的源发行版21的解决方式,这个错误是因为你的项目使用的Java版本与你的IDEA使用的Java版本不一致导致的,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2024-06-06
  • java 从int数组中获取最大数的方法

    java 从int数组中获取最大数的方法

    这篇文章主要介绍了java 从int数组中获取最大数的方法,需要的朋友可以参考下
    2017-02-02

最新评论