SpringMVC学习笔记六：使用 hibernate-validator注解式数据校验

对客户端传过来的参数，在使用前一般需要进行校验。

SpringMVC框架内置了Validator验证接口，但是实现起来太麻烦。我们一般使用 hibernate-validator进行数据校验。

1：jar包配置

这个校验工具不是spring集成的，所以需要我们手动配置，主要有以下三个：



2：在springmvc配置文件中配置校验器

<!-- 配置校验器 -->
<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">//
<!-- 校验器，使用hibernate校验器 -->
<property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
<!-- 指定校验使用的资源文件，在文件中配置校验错误信息，如果不指定则默认使用classpath下面的ValidationMessages.properties文件 -->
<property name="validationMessageSource" ref="messageSource"/>
</bean>
<!-- 校验错误信息配置文件 -->
<bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
<!-- 资源文件名 -->
<property name="basenames">
<list>
<value>classpath:CustomValidationMessage</value>//配置src目录下的properties错误信息文件
</list>
</property>
<!-- 资源文件编码格式 -->
<property name="fileEncodings" value="utf-8"/>
<!-- 对资源文件内容缓存时间，单位秒 -->
<property name="cacheSeconds" value="120"/>
</bean>

3：在POJO类中需要验证的地方，通过注解指明验证规则

如：

@AssertFalse	被注解的元素必须为false
@AssertTrue	被注解的元素必须为true
@DecimalMax(value)	被注解的元素必须为一个数字，其值必须小于等于指定的最小值
@DecimalMin(Value)	被注解的元素必须为一个数字，其值必须大于等于指定的最小值
@Digits(integer=, fraction=)	被注解的元素必须为一个数字，其值必须在可接受的范围内
@Future	被注解的元素必须是日期，检查给定的日期是否比现在晚
@Max(value)	被注解的元素必须为一个数字，其值必须小于等于指定的最小值
@Min(value)	被注解的元素必须为一个数字，其值必须大于等于指定的最小值
@NotNull	被注解的元素必须不为null
@Null	被注解的元素必须为null
@Past(java.util.Date/Calendar)	被注解的元素必须过去的日期，检查标注对象中的值表示的日期比当前早
@Pattern(regex=, flag=)	被注解的元素必须符合正则表达式，检查该字符串是否能够在match指定的情况下被regex定义的正则表达式匹配
@Size(min=, max=)	被注解的元素必须在制定的范围(数据类型:String, Collection, Map and arrays)
@Valid	递归的对关联对象进行校验, 如果关联对象是个集合或者数组, 那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验
@CreditCardNumber	对信用卡号进行一个大致的验证
@Email	被注释的元素必须是电子邮箱地址
@Length(min=, max=)	被注解的对象必须是字符串的大小必须在制定的范围内
@NotBlank	被注解的对象必须为字符串，不能为空，检查时会将空格忽略
@NotEmpty	被注释的对象必须为空(数据:String,Collection,Map,arrays)
@Range(min=, max=)	被注释的元素必须在合适的范围内 (数据：BigDecimal, BigInteger, String, byte, short, int, long and 原始类型的包装类 )
@URL(protocol=, host=, port=, regexp=, flags=)	被注解的对象必须是字符串，检查是否是一个有效的URL，如果提供了protocol，host等，则该URL还需满足提供的条件

4：在controller中对需要验证的参数进行验证，并捕获验证结果

在需要校验的pojo参数前边添加@Validated，后边添加BindingResult bindingResult来接收校验出错信息。值得注意的是：@Validated和BindingResult bindingResult是配对出现，并且形参顺序是固定的（一前一后）。这样就可以顺利接收到错误信息了。



5：分组校验

分组校验的意思是：定义POJO时，通过注解定义了不同属性的校验规则了。当在不同的controller中有请求处理函数以该pojo类对象作为参数时，假设controller1中的只需验证pojo的name属性非空即可，而controller2则需要验证pojo的所有属性。那怎么才能让这个pojo满足不同的controller的校验需求呢？

我们可以通过“标记”的思想来实现分组校验，例如：为不同的属性带上标记，在controller中指明什么标记的属性需要验证。那么怎么标记呢？使用一个空接口即可。

首先，定义一个标记接口：

public interface ValidGroup1 {

//接口中不需要定义任何方法，仅仅是对不同的校验规则进行分组

}

然后，在定义pojo类时，为属性进行“标记”，标记的实现是为分组属性赋值



最后，在controller中要验证pojo参数时，通过value值指明是要验证哪个分组标记的pojo属性的值。