springmvc使用hibernate-validator校验框架实现后端校验

一、springmvc校验

springmvc使用JSR-303校验规范，JSR-303是javaEE6的规范。

springmvc具体使用hibernate-validator校验框架（和hibernate的ORM没有关系），hibernate-validator基于javabean的属性校验。

二丶实现步骤

① 添加jar包支持 本例使用hibernate-validator 4.3.0.Final版本 maven的pom文件引入以下内容即可

<!-- https://mvnrepository.com/artifact/org.hibernate/hibernate-validator -->
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>4.3.0.Final</version>
</dependency>

jboss-logging和validation-api为其依赖。

---

② 在springmvc的处理器适配器中配置validator：

<mvc:annotation-driven  validator="validator"/>

定义validator的bean

<!-- 定义校验器 -->
    <bean id="validator"
        class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        <!-- 校验器 -->
        <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:CustomerValidationMessages</value>
            </list>
        </property>
        <!-- 资源文件编码格式 -->
        <property name="fileEncodings" value="utf-8"/>
        <!-- 对资源文件内容缓存时间，秒 -->
        <property name="cacheSeconds" value="120"/>
    </bean>

---

③ 在需要校验的javaben实体类中添加相关校验注解，此处以Items这个po类为例

public class Items {

    @Size(min=1,max=30,message="{item.name.length}",groups={ItemsValidationForEdit.class})
    @NotNull(message="{item.name.notnull}",groups={ItemsValidationForEdit.class})
    private String name;

    private String pic;
    @NotNull(message="{item.createdate.notnull}",groups={ItemsValidationForEdit.class})
    private Date createtime;

相关的校验规则由注解名称即可理解，这里解释下注解内的属性含义。
message为出现错误时的提示信息，groups为将我们的校验器分组，因为po类是共用的，可能同一个字段在不同的场景下有不同的校验需求，所以将其分组，在controller中进行校验时，可指定分组，来进行校验。
分组groups中的XXX.class为定义的一个“空的interface”，没有含义，仅仅只是为了分组。

在po类中利用注解进行校验分类和定义后，可以在后台进行校验，一般选择在service层，因为判断数据合法性属于业务需求，可是在有些情况下，对于用户的体验性来说，如果在controller就进行数据合法性校验，如果不合法可以直接返回，不调用service，响应稍微快些，用户体验好。所以此例中在controller层进行校验。

---

④ 在后台通过注解校验

// 修改商品提交
    @RequestMapping("/saveItems")
    public String saveItems(Model model, Integer id,
            @Validated(value = { ItemsValidationForEdit.class}) Items item,
            BindingResult bindingResult) throws Exception {
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            model.addAttribute("allErrors", allErrors);
            return "editItem";
        }
        // 更新
        itemsService.updateItems(id, item);
        // 返回成功页面
        // 重定向到商品查询
        return "forward:queryItems.action";
    }

controller方法参数中的
@Validated(value = { ItemsValidationForEdit.class}) Items item,
BindingResult bindingResult）
含义为：
对Items这个形参进行校验，选择他其中定义的ItemsValidationForEdit这个分组的校验规则。
注意：如果你需要进行校验，在方法参数中，需要在校验对象的前后加上@Validated和BindingResult bindingResult，他们是成对出现的。

---

顺便贴下hibernate-validator的校验注解

Bean Validation 中内置的 constraint         
@Null   被注释的元素必须为 null    
@NotNull    被注释的元素必须不为 null    
@AssertTrue     被注释的元素必须为 true    
@AssertFalse    被注释的元素必须为 false    
@Min(value)     被注释的元素必须是一个数字，其值必须大于等于指定的最小值    
@Max(value)     被注释的元素必须是一个数字，其值必须小于等于指定的最大值    
@DecimalMin(value)  被注释的元素必须是一个数字，其值必须大于等于指定的最小值    
@DecimalMax(value)  被注释的元素必须是一个数字，其值必须小于等于指定的最大值    
@Size(max=, min=)   被注释的元素的大小必须在指定的范围内    
@Digits (integer, fraction)     被注释的元素必须是一个数字，其值必须在可接受的范围内    
@Past   被注释的元素必须是一个过去的日期    
@Future     被注释的元素必须是一个将来的日期    
@Pattern(regex=,flag=)  被注释的元素必须符合指定的正则表达式    

Hibernate Validator 附加的 constraint    
@NotBlank(message =)   验证字符串非null，且长度必须大于0    
@Email  被注释的元素必须是电子邮箱地址    
@Length(min=,max=)  被注释的字符串的大小必须在指定的范围内    
@NotEmpty   被注释的字符串的必须非空    
@Range(min=,max=,message=)  被注释的元素必须在合适的范围内