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

青旅半醒 2022-04-05 03:23 274阅读 0赞

在开发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中定义要校验的字段（即该字段不能为空，并且最大长度为14）：**

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 </td> 
 <td> <code>import</code>&nbsp;<code>javax.validation.constraints.Pattern;</code> <code>import</code>&nbsp;<code>javax.validation.constraints.Size;</code> <code>import</code>&nbsp;<code>org.hibernate.validator.constraints.NotEmpty;</code> &nbsp; <code>public</code>&nbsp;<code>class</code>&nbsp;<code>PayRequestDto { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/**</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* 支付完成时间</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>**/</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@NotEmpty</code><code>(message=</code><code>"支付完成时间不能空"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Size</code><code>(max=</code><code>14</code><code>,message=</code><code>"支付完成时间长度不能超过{max}位"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String payTime;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/**</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* 状态</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>**/</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Pattern</code><code>(regexp =&nbsp;</code><code>"0[0123]"</code><code>, message =&nbsp;</code><code>"状态只能为00或01或02或03"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String status;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String getPayTime() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>payTime;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>setPayTime(String payTime) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>this</code><code>.payTime = payTime;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String getStatus() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>status;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>setStatus(String status) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>this</code><code>.status = status;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**3.定义Validation工具类：**

![复制代码][copycode.gif]

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 <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()));
 }
 }
 }

![复制代码][copycode.gif]

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

ValidationUtils.validate(requestDto);

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

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

标签: [Java][]

[copycode.gif]: /images/20220405/080f22f2ac8a45cf95af5430f079d8d0.png
[Java]: https://www.cnblogs.com/atai/tag/Java/