JPA基于注解的校验中无法保存不符合校验规则的对象的解决方案（基于注解的java bean分组校验）

Bertha 。 2021-06-24 16:10 426阅读 0赞

### 背景： ###

通过注解对bean进行校验比较方便，比起传统的if else判断能少些很多代码，下面进行介绍开发例子。如果您是来找解决方案的，请直接转到最后 -->

### 导入jar包： ###

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

如果你是springboot项目，直接引入spring-boot-starter-web就可以了，里面已经包含了这两个jar包

如果报javax.validation.ValidationException: HV000183: Unable to initialize 'javax.el.ExpressionFactory'. Check that you have the EL dependencies on the classpath, or use ParameterMessageInterpolator instead类似错误

还需要加入：

<dependency>
         <groupId>javax.el</groupId>
         <artifactId>javax.el-api</artifactId>
         <version>2.2.4</version>
    </dependency>
    <dependency>
          <groupId>org.glassfish.web</groupId>
          <artifactId>javax.el</artifactId>
          <version>2.2.4</version>
    </dependency>

### 实体类： ###

import com.goods.management.utils.Validation.groups.InvalidProductGroup;
    import javax.persistence.*;
    import javax.validation.constraints.DecimalMin;
    import javax.validation.constraints.NotBlank;
    import javax.validation.constraints.NotNull;
    import javax.validation.constraints.Pattern;
    
    @Entity
    public class Product {
    	private int id;
    	@NotBlank(message = "商品id不能为空",groups = InvalidProductGroup.class)
    	private String productId;
    	@NotBlank(message = "商品名称不能为空",groups = InvalidProductGroup.class)
    	private String productName;
    	
        /**
    	 * 获取id
    	 * @return id
    	 */
    	@Id
    	@Column(name = "id")
    	@GeneratedValue(strategy = GenerationType.IDENTITY)
    	public int getId() {
    		return id;
    	}
    
    	/**
    	 * 设置id
    	 * @param id id
    	 */
    	public void setId(int id) {
    		this.id = id;
    	}
    
    	/**
    	 * 获取productId
    	 * @return productId
    	 */
    	@Basic
    	@Column(name = "product_id")
    	public String getProductId() {
    		return productId;
    	}
    
    	/**
    	 * 设置productId
    	 * @param productId productId
    	 */
    	public void setProductId(String productId) {
    		this.productId = productId;
    	}
    
    	/**
    	 * 获取productName
    	 * @return productName
    	 */
    	@Basic
    	@Column(name = "product_name")
    	public String getProductName() {
    		return productName;
    	}
    
    	/**
    	 * 设置productName
    	 * @param productName productName
    	 */
    	public void setProductName(String productName) {
    		this.productName = productName;
    	}
    }

### 写一个校验工具类： ###

import javax.validation.Validation;
    import javax.validation.ValidationException;
    import javax.validation.Validator;
    import javax.validation.ValidatorFactory;
    import javax.validation.ConstraintViolation;
    import java.util.Set;
    
    public class ValidationUtil {
    
    	private static Validator validator;
            // 静态代码块，初始化是就新建一个默认校验工厂，并获取一个校验器
    	static {
    		ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
    		validator = validatorFactory.getValidator();
    	}
            //写一个校验方法，方法中调用validator.validate方法，该方法包含了校验的过程，并把校验结果返回
    	public static <T> void validate(T t,Class<?>... groups) throws ValidationException {
    		Set<ConstraintViolation<T>> set = validator.validate(t,groups);
    		StringBuilder validateError = new StringBuilder();
    		if(set.size()>0){
    			for(ConstraintViolation constraintViolation : set){
    				validateError.append(constraintViolation.getMessage()+";");
    			}
    			throw new ValidationException(validateError.toString());
    		}
    	}
    }

这样以后就可以通过对实体类新增注解如@NotBlank，@NotNull，@Pattern,@DecimalMin,@DecimalMax,@Length等注解通过

ValidationUtil.validate(product, InvalidProductGroup.class);

进行数据的校验了。

### 解决方案&注意点： ###

@NotBlank(message = "商品id不能为空",groups = InvalidProductGroup.class)
    	private String productId;

其中的groups为自己定义的一个接口，（空接口，不需要写方法），用来对对象的属性进行分组校验。如下：

package com.goods.management.utils.Validation.groups;
    
    /**
    * <pre>类名: InvalidProductGroup</pre>
    * <pre>描述: 非法商品信息分组</pre>
    * <pre>版权: 浙江理工大学信息学院</pre>
    * <pre>日期: 2019/3/8 13:56</pre>
    * <pre>作者: chenwb</pre>
    */
    public interface InvalidProductGroup {
    }

如果不对对象的校验属性进行分组，在保存操作的时候，系统（尚不确定是不是JPA）会自动调用默认的校验方法validate（T t）对对象进行校验，如果要保存某些不满足校验条件的数据，就可以对属性进行分组，校验的时候采用显式校验的形式就可以了。

有什么问题可以在下方留言，看到都会及时回复。