javax.validation.Validation使用方法

本文深入解析JSR-303标准下的validationbean与HibernateValidator的使用,提供具体的代码示例,包括如何在项目中配置依赖、创建验证器、实现自定义异常及错误信息处理。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

 

后台开发需要对对象的传进来的参数进行校验,有专门的校验工具,validation bean 是基于JSR-303标准开发出来的,使用注解方式实现,及其方便,但是这只是一个接口,没有具体实现.Hibernate Validator是一个hibernate独立的包,可以直接引用,他实现了validation bean同时有做了扩展,比较强大。

要使用在pom.xml里添加依赖

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
<dependency>
	<groupId>org.hibernate</groupId>
	<artifactId>hibernate-validator</artifactId>
	<version>5.4.1.Final</version>
</dependency>

对要验证的类添加的注解

一个用于VO继承的父对象,实现了一个Validate方法,可以抛出自定义异常,然后把违背约束的属性给输出出来



import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.groups.Default;


public class BaseVO implements Serializable, Cloneable {
    private static final long serialVersionUID = -3282093394377931421L;
    //得到一个验证器实例
    private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
    //验证方法,抛出自定义异常
    public void validate() throws XXXException{
    //用Map保存错误
	Map<String, StringBuffer> errorMap = null;
    //把对象放到验证器的验证方法中,用Set存储违背约束的对象
	Set<ConstraintViolation<BaseVO>> set = validator.validate(this, Default.class);
    //当有违背约束的对象时
	if (set != null && set.size() > 0) {
        //初始化map
	    errorMap = new HashMap<String, StringBuffer>();
        //保存错误属性
	    String property = null;
	    for (ConstraintViolation<BaseVO> cv : set) {
		// 这里循环获取错误信息,可以自定义格式
		property = cv.getPropertyPath().toString();
		if (errorMap.get(property) != null) {
		    errorMap.get(property).append("," + cv.getMessage());
		} else {
		    StringBuffer sb = new StringBuffer();
		    sb.append(cv.getMessage());
		    errorMap.put(property, sb);
		}
	    }

	    if (errorMap != null) {
		StringBuffer sb = new StringBuffer();
		for (Map.Entry<String, StringBuffer> m : errorMap.entrySet()) {
		    sb.append(m.getValue().toString()).append("\r\n");
		}
        //输出
        throw new XXXException(sb.toString());
	    }

	}

    }

}

或者参照这个博客可以将其封装成工具类


package com.alibaba.banff.web.util;
 
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
 
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.groups.Default;
 
/**
 * 校验工具类
 * 
 * @author lizhilong
 */
public class ValidationUtils {
 
    private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
 
    public static <T> ValidationResult validateEntity(T obj) {
        ValidationResult result = new ValidationResult();
        Set<ConstraintViolation<T>> set = validator.validate(obj, Default.class);
        // if( CollectionUtils.isNotEmpty(set) ){
        if (set != null && set.size() != 0) {
            result.setHasErrors(true);
            Map<String, String> errorMsg = new HashMap<String, String>();
            for (ConstraintViolation<T> cv : set) {
                errorMsg.put(cv.getPropertyPath().toString(), cv.getMessage());
            }
            result.setErrorMsg(errorMsg);
        }
        return result;
    }
 
    public static <T> ValidationResult validateProperty(T obj, String propertyName) {
        ValidationResult result = new ValidationResult();
        Set<ConstraintViolation<T>> set = validator.validateProperty(obj, propertyName, Default.class);
        if (set != null && set.size() != 0) {
            result.setHasErrors(true);
            Map<String, String> errorMsg = new HashMap<String, String>();
            for (ConstraintViolation<T> cv : set) {
                errorMsg.put(propertyName, cv.getMessage());
            }
            result.setErrorMsg(errorMsg);
        }
        return result;
    }
}

 校验工具类返回的数据ValidationResult(省略getset):


package com.aliyun.prophet.facade.partner.flaw;
 
import java.util.Map;
 
/**
 * 校验结果
 * 
 * @author lizhilong
 */
public class ValidationResult {
 
    // 校验结果是否有错
    private boolean             hasErrors;
 
    // 校验错误信息
    private Map<String, String> errorMsg;
}

 

### 在 `javax.validation.constraints` 中对数组应用约束条件 在 Java 的 Bean Validation API 中,`javax.validation.constraints` 包提供了一些内置的约束注解。这些注解可以用于验证对象属性的值是否符合特定规则。对于数组或集合类型的字段,可以通过以下几种方式应用约束条件: 1. **直接在数组上使用约束注解** 如果需要对数组中的每个元素进行验证,可以直接将约束注解应用到数组类型上。例如,`@NotNull`、`@Size` 等注解可以用于验证数组本身及其元素。 2. **嵌套验证** 如果数组中的元素是复杂对象(如自定义类),则可以通过级联验证机制来验证这些对象的属性。 #### 示例代码 以下是一个使用 `@Size` 和 `@NotNull` 注解验证数组的示例: ```java import javax.validation.constraints.NotNull; import javax.validation.constraints.Size; public class ArrayValidationExample { // 验证数组不能为空且长度必须在 1 到 5 之间 @Size(min = 1, max = 5, message = "Array size must be between 1 and 5") @NotNull(message = "Array cannot be null") private String[] stringArray; public String[] getStringArray() { return stringArray; } public void setStringArray(String[] stringArray) { this.stringArray = stringArray; } } ``` 上述代码中,`@Size` 和 `@NotNull` 被应用于 `stringArray` 字段,确保数组不为空且其长度在指定范围内[^1]。 3. **自定义约束校验器** 如果需要更复杂的验证逻辑,可以实现 `ConstraintValidator` 接口并编写自定义校验器。例如,验证数组中的每个元素是否符合正则表达式。 #### 自定义校验器示例 以下是一个验证数组中每个元素是否符合正则表达式的自定义校验器: ```java import javax.validation.Constraint; import javax.validation.Payload; import javax.validation.ReportAsSingleViolation; import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; import java.lang.annotation.*; import java.util.regex.Pattern; // 定义自定义注解 @Documented @Constraint(validatedBy = EncryptIdArrayValidator.class) @Target({ElementType.FIELD, ElementType.PARAMETER}) @Retention(RetentionPolicy.RUNTIME) @ReportAsSingleViolation public @interface ValidEncryptIdArray { String message() default "Invalid encrypt ID format in array"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } // 实现 ConstraintValidator 接口 public class EncryptIdArrayValidator implements ConstraintValidator<ValidEncryptIdArray, String[]> { private static final Pattern PATTERN = Pattern.compile("^[a-f\\d]{6,8}$"); @Override public boolean isValid(String[] values, ConstraintValidatorContext context) { if (values == null) { return true; // 允许为 null } for (String value : values) { if (value != null) { Matcher matcher = PATTERN.matcher(value); if (!matcher.find()) { return false; } } } return true; } } ``` 在上述代码中,`@ValidEncryptIdArray` 是一个自定义注解,用于验证数组中的每个字符串是否符合正则表达式 `^[a-f\\d]{6,8}$`[^2]。 #### 使用自定义注解 将自定义注解应用到数组字段上: ```java public class CustomValidationExample { @ValidEncryptIdArray private String[] encryptIds; public String[] getEncryptIds() { return encryptIds; } public void setEncryptIds(String[] encryptIds) { this.encryptIds = encryptIds; } } ``` 通过这种方式,可以在数组级别应用复杂的验证逻辑。 ### 注意事项 - 如果需要对数组中的每个元素单独验证,可以结合 Hibernate Validator 提供的 `@Valid` 注解进行级联验证[^3]。 - 自定义校验器需要实现 `ConstraintValidator` 接口,并重写 `isValid` 方法以定义具体的验证逻辑。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值