`
wdmcygah
  • 浏览: 62479 次
社区版块
存档分类
最新评论

Hibernate Validation使用示例及讲解

阅读更多

在项目开发过程中,后台在很多场景都需要进行校验操作,比如:前台表单提交到后台,系统接口调用,数据传输等等。而且很多项目都采用MVC分层式设计,每层还有需要进行相应地校验,这样在项目较大,多人协作开发的时候,会造成大量重复校验代码,且出错率高。

针对这个问题,JCP出台一个JSR 303-Bean Validation规范,而Hibernate Validator 作为Bean Validation的参考实现,提供了JSR 303规范中所有内置constraint的实现,除此之外还有一些附加的constraint。

Hibernate Validation的使用非常简单,只用在相应的实体类中加上注解,再调用对应的校验API方法即可。

Hibernate Validation目前最新的稳定版本是:5.1.3。下载地址

官网地址 
官方英文使用手册 
官方中文使用手册地址(中文版目前最新的是4.3版本)

具体使用方法请查看上面的官方使用手册地址,每个注解对应的含义在官方手册2.4章节有详细介绍,内容太多我就不贴过来了。下面直接上最常用情况(实体类校验)的示例代码。

一、依赖包

J2SE环境下除了需要引入Hibernate Validation包外,还需要额外引入两个实现表达式语言的包。J2EE环境如果容器提供不需要再引入。下面是J2SE环境下的依赖包:

<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-validator</artifactId>
			<version>5.1.3.Final</version>
		</dependency>
		<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>

 

二、校验工具类

工具类提供了校验实体类、实体字段的方法,返回一个自定义的校验对象。

/**
 * 校验工具类
 * @author wdmcygah
 *
 */
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) ){
			 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( CollectionUtils.isNotEmpty(set) ){
			 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;
	}
}

 

三、校验返回对象

/**
 * 校验结果
 * @author wdmcygah
 *
 */
public class ValidationResult {

	//校验结果是否有错
	private boolean hasErrors;
	
	//校验错误信息
	private Map<String,String> errorMsg;

	public boolean isHasErrors() {
		return hasErrors;
	}

	public void setHasErrors(boolean hasErrors) {
		this.hasErrors = hasErrors;
	}

	public Map<String, String> getErrorMsg() {
		return errorMsg;
	}

	public void setErrorMsg(Map<String, String> errorMsg) {
		this.errorMsg = errorMsg;
	}

	@Override
	public String toString() {
		return "ValidationResult [hasErrors=" + hasErrors + ", errorMsg="
				+ errorMsg + "]";
	}

}

四、被校验实体

public class SimpleEntity {

	@NotBlank(message="名字不能为空或者空串")
	@Length(min=2,max=10,message="名字必须由2~10个字组成")
	private String name;
	
	@Past(message="时间不能晚于当前时间")
	private Date date;
	
	@Email(message="邮箱格式不正确")
	private String email;
	
	@Pattern(regexp="(?![0-9]+$)(?![a-zA-Z]+$)[0-9A-Za-z]{5,10}",message="密码必须是5~10位数字和字母的组合")
	private String password;
	
	@AssertTrue(message="字段必须为真")
	private boolean valid;
  
       //get set方法省略,自己添加
}

 

有些情况下,Hibernate Validation自带的注解不能够满足需求,我们想定制一个注解进行使用,此时可以参考下面的示例(自定义密码注解及校验规则)。

一、密码注解

package research.hibernate.validation.extend;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

@Target( { METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = PasswordValidator.class)
@Documented
public @interface Password {

	String message() default "{密码必须是5~10位数字和字母组合}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

 

二、密码校验类

/**
 * 自定义密码校验类
 * @author wdmcygah
 *
 */
public class PasswordValidator implements ConstraintValidator<Password, String> {

	//5~10位的数字与字母组合
	private static Pattern pattern = Pattern.compile("(?![0-9]+$)(?![a-zA-Z]+$)[0-9A-Za-z]{5,10}");
	
	public void initialize(Password constraintAnnotation) {
		//do nothing
	}

	public boolean isValid(String value, ConstraintValidatorContext context) {
		if( value==null ){
			return false;
		}
		Matcher m = pattern.matcher(value);
		return m.matches();
	}	
}

 

三、被校验实体

public class ExtendEntity {

	@Password
	private String password;
	
	public String getPassword() {
		return password;
	}

	public void setPassword(String password) {
		this.password = password;
	}

}

 

对应的测试类如下:

public class ValidationUtilsTest extends TestCase{

  public void validateSimpleEntity() {
	  SimpleEntity se = new SimpleEntity();
	  se.setDate(new Date());
	  se.setEmail("123");
	  se.setName("123");
	  se.setPassword("123");
	  se.setValid(false);
	  ValidationResult result = ValidationUtils.validateEntity(se);
	  System.out.println("--------------------------");
	  System.out.println(result);
	  Assert.assertTrue(result.isHasErrors());
  }
  
  public void validateSimpleProperty() {
	  SimpleEntity se = new SimpleEntity();
	  ValidationResult result = ValidationUtils.validateProperty(se,"name");
	  System.out.println("--------------------------");
	  System.out.println(result);
	  Assert.assertTrue(result.isHasErrors());
  }
  
  public void validateExtendEntity() {
	  ExtendEntity ee = new ExtendEntity();
	  ee.setPassword("212");
	  ValidationResult result = ValidationUtils.validateEntity(ee);
	  System.out.println("--------------------------");
	  System.out.println(result);
	  Assert.assertTrue(result.isHasErrors());
  }
}

 

代码在JDK1.8下测试通过。完整代码可查看我的Github仓库:https://github.com/wdmcygah/research-J2SE

 

备注:
(1)上述示例只是展示了Hibernate Validation比较常用的示例,框架其实还支持方法返回值、方法参数校验,另外也可以通过XML进行配置,校验还可以分组、合并等等。这些内容请查阅官方使用手册。
(2)另外还有一个也还不错的校验框架:OVAL。OVAL源码地址

 

 

1
4
分享到:
评论

相关推荐

    后台验证hibernate-validator必须的jar包

    本主题将详细讲解`Hibernate Validator`以及与之相关的`validation-api-2.0.1.Final.jar`、`hibernate-validator-6.0.8.Final.jar`和`jboss-logging-3.3.2.Final.jar`这三个jar包的作用和重要性。 首先,`...

    hibernate 中文参考文档

    Hibernate允许开发人员在Java应用程序中使用面向对象的方式操作数据库,消除了传统的JDBC代码与SQL之间的繁琐对接。在这个文档中,我们将深入探讨其核心概念、配置、实体管理以及查询语言等方面。 首先,文档会讲解...

    Hibernate 参考文档

    - **JCA支持**:讲解了Hibernate如何通过Java Connector Architecture (JCA)与外部数据源进行交互。 #### 三、SessionFactory 配置 - **可编程配置方式**:探讨了通过代码而非XML配置文件来设置SessionFactory的...

    hibernate_validator_reference 5.0.3

    Hibernate Validator是一个基于Java Bean Validation规范(JSR 349)的实现,它允许开发者通过注解的方式对Java Bean进行校验。Hibernate Validator 5.0.3版本是该实现的特定版本,本手册将详细介绍如何使用这一版本...

    hibernate-release-5.0.7.Final.zip

    在传智播客黑马程序员2016年的Hibernate课程中,讲师深入讲解了如何使用5.0.7.Final版本进行实际项目开发,包括实体类设计、配置文件设置、CRUD操作、关联映射、查询优化等关键知识点,旨在帮助学员快速掌握...

    Hibernate_Validator_reference中文版@www.java1234.com.pdf

    为了使用Hibernate Validator进行校验,需要获取一个Validator的实例,这可以通过 ValidatorFactory 实例来完成。 文档详细介绍了如何定义约束条件,包括字段级约束、属性级别约束、类级别约束和约束继承。它还讲解...

    struts、spring、hibernate、ajax、JQuery原理讲解.doc

    Struts、Spring、Hibernate、Ajax、JQuery原理讲解 Struts2框架的工作原理可以分为以下几个步骤: 1. 客户端发出一个指向servlet容器的请求(tomcat)。 2. 这个请求会经过图中的几个过滤器,最后会到达...

    hibernate_validator_官方文档中文&英文版

    2. **配置与集成**:讲解如何在Spring、JSF、CDI等不同框架中集成Hibernate Validator,以及如何通过XML或编程方式进行配置。 3. **表达式语言**:介绍Hibernate Validator的内置表达式语言,用于在约束中定义复杂...

    spring3.0+struts2.2+hibernate3.3集成.rar

    压缩包内的文件 "spring3.0+struts2.2+hibernate3.3集成.ppt" 很可能是对此集成过程的详细讲解,涵盖了配置、实例和最佳实践。如果你希望深入学习或实施这样的集成方案,这份资料应该会提供宝贵的指导。在实际开发中...

    轻量级Java_EE企业应用实战_Struts_2+Spring_3+Hibernate整合开发_第3版PDF

    本书《轻量级Java_EE企业应用实战_Struts_2+Spring_3+Hibernate整合开发_第3版》将详细讲解SSH框架的整合过程,包括环境配置、项目结构设计、各个组件的配置与使用,以及实际案例的开发步骤。通过学习,读者可以掌握...

    SpringMVC数据验证——注册用户格式的验证实例

    首先,我们需要理解Spring MVC的数据验证是基于JavaBeans规范中的Java Bean Validation(JSR 303/349)标准和Hibernate Validation实现的。这允许我们在模型类(通常是用户实体类)中添加注解,来定义验证规则。 ...

    spring mvc服务端表单验证实例

    这包括Spring MVC本身、Bean Validation实现(如Hibernate Validator)、以及可能的视图技术库。 9. **学习资源**: 这个实例是一个很好的学习资源,可以帮助初学者理解如何在实际项目中集成和使用Spring MVC的...

    JSR303数据校验springboot-01-config.zip

    下面将详细讲解JSR303在Spring Boot中的使用和配置。 1. **引入依赖**:首先,你需要在项目的`pom.xml`或`build.gradle`文件中添加Hibernate Validator的依赖。例如,在Maven项目中,可以添加如下依赖: ```xml ...

    httpclient书籍

    在描述中提到了"hibernate-validate书籍",这可能是与HttpClient相关的一个补充,因为Hibernate Validate是Hibernate项目的一部分,它是Java Bean Validation规范的实现,用于校验对象的属性值。尽管两者主要关注的...

    ssh三大框架整合

    在这个例子中,可能会讲解如何配置Struts2的Action,如何定义Hibernate的实体类和映射文件,以及如何在Spring中配置数据源、事务管理器和DAO接口的实现。同时,它还可能涵盖了如何将这些组件集成到一起,形成一个...

    spring3.x项目开发

    - `chapter2`:这部分可能涵盖了Spring的基础知识,包括环境配置、Spring IoC容器的使用、Bean的定义与实例化,以及DI的初步实践。可能还会讲解到Spring的XML配置和基于注解的配置方式。 - `chapter3`:在这一章,...

    struts2应用实例

    在讲解Struts2之前,我们需要理解MVC模式的基本概念。MVC模式将应用程序分为三个主要组件:模型(Model)、视图(View)和控制器(Controller)。模型处理业务逻辑,视图负责展示数据,而控制器接收用户请求并协调...

Global site tag (gtag.js) - Google Analytics