JAVA中通过Hibernate-Validation进行参数验证

2024-07-29 00:33:31

在开发JAVA服务器端代码时，我们会遇到对外部传来的参数合法性进行验证，而hibernate-validator提供了一些常用的参数校验注解，我们可以拿来使用。

1.maven中引入hibernate-validator对应的jar：

<dependency>
  <groupId>org.hibernate</groupId>
  <artifactId>hibernate-validator</artifactId>
  <version>4.3.1.Final</version>
</dependency>

2.在Model中定义要校验的字段：

import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import org.hibernate.validator.constraints.NotEmpty;

public class PayRequestDto {

  /**
   * 支付完成时间
   **/
  @NotEmpty(message="支付完成时间不能空")
  @Size(max=14,message="支付完成时间长度不能超过{max}位")
  private String payTime;

  /**
   * 状态
   **/
  @Pattern(regexp = "0[0123]", message = "状态只能为00或01或02或03")
  private String status;

  public String getPayTime() {
    return payTime;
  }

  public void setPayTime(String payTime) {
    this.payTime = payTime;
  }

  public String getStatus() {
    return status;
  }

  public void setStatus(String status) {
    this.status = status;
  }
}

3.定义Validation工具类：

import java.util.Set;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import org.hibernate.validator.HibernateValidator;
import com.atai.framework.lang.AppException;
public class ValidationUtils {

  /**
   * 使用hibernate的注解来进行验证
   *
   */
  private static Validator validator = Validation
      .byProvider(HibernateValidator.class).configure().failFast(true).buildValidatorFactory().getValidator();
  /**
   * 功能描述: <br>
   * 〈注解验证参数〉
   *
   * @param obj
   * @see [相关类/方法](可选)
   * @since [产品/模块版本](可选)
   */
  public static <T> void validate(T obj) {
    Set<ConstraintViolation<T>> constraintViolations = validator.validate(obj);
    // 抛出检验异常
    if (constraintViolations.size() > 0) {
      throw new AppException("0001", String.format("参数校验失败:%s", constraintViolations.iterator().next().getMessage()));
    }
  }
}

4.在代码中调用工具类进行参数校验：

ValidationUtils.validate(requestDto);

以下是对hibernate-validator中部分注解进行描述：

@AssertTrue	用于boolean字段，该字段只能为true
@AssertFalse	该字段的值只能为false
@CreditCardNumber	对信用卡号进行一个大致的验证
@DecimalMax	只能小于或等于该值
@DecimalMin	只能大于或等于该值
@Digits(integer=,fraction=)	检查是否是一种数字的整数、分数,小数位数的数字
@Email	检查是否是一个有效的email地址
@Future	检查该字段的日期是否是属于将来的日期
@Length(min=,max=)	检查所属的字段的长度是否在min和max之间,只能用于字符串
@Max	该字段的值只能小于或等于该值
@Min	该字段的值只能大于或等于该值
@NotNull	不能为null
@NotBlank	不能为空，检查时会将空格忽略
@NotEmpty	不能为空，这里的空是指空字符串
@Null	检查该字段为空
@Past	检查该字段的日期是在过去
@Pattern(regex=,flag=)	被注释的元素必须符合指定的正则表达式
@Range(min=,max=,message=)	被注释的元素必须在合适的范围内
@Size(min=, max=)	检查该字段的size是否在min和max之间，可以是字符串、数组、集合、Map等
@URL(protocol=,host,port)	检查是否是一个有效的URL，如果提供了protocol，host等，则该URL还需满足提供的条件
@Valid	该注解主要用于字段为一个包含其他对象的集合或map或数组的字段，或该字段直接为一个其他对象的引用，这样在检查当前对象的同时也会检查该字段所引用的对象

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

Hibernate Validation自定义注解校验的实现

情景:需要对String类型的属性比如description进行验证,验证规则是当description为空时不进行正则校验,description不为空时进行正则校验.上述需求Hibernate Validation没有可用于上述需求的注解,故自定义一个注解并自定义校验规则. 自定义注解进行校验的步骤写一个校验注解,在注解中指定校验器类,校验注解与校验器一般一一对应. 写一个校验器类并在校验器类中写校验逻辑,校验器必须实现ConstraintValidator<?, ?>接口,第一个参数是
如何自定义hibernate validation注解示例代码

Bean Validation 中内置的 constraint @Null 被注释的元素必须为 null @NotNull 被注释的元素必须不为 null @AssertTrue 被注释的元素必须为 true @AssertFalse 被注释的元素必须为 false @Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值 @Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值 @DecimalMin(value) 被注释的元素必须是一个数字,其
springboot使用hibernate validation对参数校验的实现方法

springboot天生支持使用hibernate validation对参数的优雅校验,如果不使用它,只能对参数挨个进行如下方式的手工校验,不仅难看,使用起来还很不方便: if(StringUtils.isEmpty(userName)){ throw new RuntimeException("用户名不能为空"); } 下面将介绍hibernate validation的基本使用方法. 一.引入依赖这里在springboot 2.4.1中进行实验,引入以下依赖: <pare
SpringBoot整合Hibernate Validator实现参数验证功能

在前后端分离的开发模式中,后端对前端传入的参数的校验成了必不可少的一个环节.但是在多参数的情况下,在controller层加上参数验证,会显得特别臃肿,并且会有许多的重复代码.这里可以引用Hibernate Validator来解决这个问题,直接在实体类进行参数校验,验证失败直接返回错误信息给前端,减少controller层的代码量. 一.xml引入Hibernate Validator  <dependency> <groupId>org.hi
java实现表单必填参数验证的方法

一. 概述在开发后端接口, 通常都会涉及检验参数必填校验, 一般我们的处理都是很粗暴的写个if()判断, 然后抛异常. 本文将介绍通过代理的思想, 用注解优雅的处理非空判断二. 实现过程最终想要的效果->在方法的参数加个注解或者参数的属性里加个注解, 注解可以自定义报错信息, 就可以实现自动非空校验 2.1 编写注解 @Target({ElementType.FIELD}) //作用的位置 @Retention(RetentionPolicy.RUNTIME) //作用域 @Documen
java validation 后台参数验证的使用详解

一.前言在后台开发过程中,对参数的校验成为开发环境不可缺少的一个环节.比如参数不能为null,email那么必须符合email的格式,如果手动进行if判断或者写正则表达式判断无意开发效率太慢,在时间.成本.质量的博弈中必然会落后.所以把校验层抽象出来是必然的结果,下面说下几种解决方案. 二.几种解决方案 1.struts2的valid可以通过配置xml,xml中描述规则和返回的信息,这种方式比较麻烦.开发效率低,不推荐 2.validation bean 是基于JSR-303标准开发出来的,使
JAVA中通过自定义注解进行数据验证的方法

前言最近为了工作也为了更加深入了解掌握java注解的使用,决定自定义注解来实现数据验证. API开发中经常会遇到一些对请求数据进行验证的情况,这时候如果使用注解就有两个好处,一是验证逻辑和业务逻辑分离,代码清晰,二是验证逻辑可以轻松复用,只需要在要验证的地方加上注解就可以. Java提供了一些基本的验证注解,比如@NotNull.@Size,但是更多情况下需要自定义验证逻辑,这时候就可以自己实现一个验证注解,方法很简单,仅需要两个东西: 一个自定义的注解,并且指定验证器一个验证器的实现自定
Java中用户向系统传递参数的三种基本方式实例分享

使用Main方法的参数传递方式例示代码如下: 复制代码代码如下: public class MainArgs { public static void main(String[] args) { System.out.println(args.length); for(String str : args){ System.out.println(str); } }} 在运行 java程序后面跟的字符串(一个或多个多个用空格隔开)jvm将会把这些一个或多个字符串赋给args数组.当
Java中Timer的schedule()方法参数详解

timer.schedule(new MyTask(),long time1,long timer2); 今天算是彻底的搞懂了这个曾经让我为之头疼的方法.下面我就重点介绍一下: 第一个参数,是 TimerTask 类,在包:import Java.util.TimerTask .使用者要继承该类,并实现public void run() 方法,因为 TimerTask 类实现了 Runnable 接口. 第二个参数的意思是,当你调用该方法后,该方法必然会调用 TimerTask 类 Timer
Java中final作用于变量、参数、方法及类该如何处理

Java中方法用final修饰参数的作用在方法参数前面加final关键字就是为了防止数据在方法体重被修改. 主要分为两种情况:第一,用final修饰基本数据类型:第二,用final修饰引用数据类型. 第一种情况,修饰基本数据类型,这时参数的值在方法体内是不能被修改的,即不能被重新赋值.否则编译就不通过. 第二种情况,修饰引用类型.这时参数变量所引用的对象是不能被改变的.但是对于引用数据类型,如果修改其属性的话是完全可以的. 所以,final这个关键字,想用的话就用基本数据类型,还是很有作用的.
JAVA中通过Hibernate-Validation进行参数验证

在开发JAVA服务器端代码时,我们会遇到对外部传来的参数合法性进行验证,而hibernate-validator提供了一些常用的参数校验注解,我们可以拿来使用. 1.maven中引入hibernate-validator对应的jar: <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>4
SpringBoot 中使用 Validation 校验参数的方法详解

目录 1. Validation 介绍 1.1 Validation 注解 1.2 @valid 和 @validated的区别 2. SpringBoot 中使用 Validator 校验参数 2.1 依赖引入 2.2 标注校验实体类 2.3 开启参数校验 2.3.1 简单参数校验 2.3.2 JavaBean 校验 2.4 捕捉参数校验异常项目中写逻辑时,为保证程序的健壮性,需要对各种参数进行判断,这就导致业务代码不只健壮,还十分臃肿.其实 SpringBoot 中已经提供了 Valida

JAVA中通过Hibernate-Validation进行参数验证

相关推荐

随机推荐