JAVA中通过Hibernate-Validation进行参数验证 在开发JAVA服务器端代码时,我们会遇到对外部传来的参数合法性进行验证,而hibernate-validator提供了一些常用的参数校验注解,我们可以拿来使用。 1.maven中引入hibernate-validator对应的jar: org.hibernate hibernate-validator 4.3.1.Final 2.在Model中定义要校验的字段(即该字段不能为空,并且最大长度为14): import javax.validation.constraints.Size; import org.hibernate.validator.constraints.NotEmpty; public class PayRequestDto { /** * 支付完成时间 **/ @NotEmpty(message="支付完成时间不能空") @Size(max=14,message="支付完成时间长度不能超过{max}位") private String payTime; public String getPayTime() { return payTime; } public void setPayTime(String payTime) { this.payTime = payTime; } } 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(); /** * 功能描述: * 〈注解验证参数〉 * * @param obj * @see [相关类/方法](可选) * @since [产品/模块版本](可选) */ public static void validate(T obj) { Set> 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或数组的字段,或该字段直接为一个其他对象的引用,这样在检查当前对象的同时也会检查该字段所引用的对象
如何使用java validation api进行参数校验
最新推荐文章于 2024-05-17 18:18:32 发布