JAVA中通过Hibernate-Validation进行参数验证
程序员文章站
2023-12-14 14:25:52
在开发java服务器端代码时,我们会遇到对外部传来的参数合法性进行验证,而hibernate-validator提供了一些常用的参数校验注解,我们可以拿来使用。
1....
在开发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地址 | |
@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或数组的字段,或该字段直接为一个其他对象的引用,这样在检查当前对象的同时也会检查该字段所引用的对象 |
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。