springMVC Hibernate Validator验证框架的使用

在平时开发中，经常会有一些验证，验证前端输入数据完整性，比如我们的代码中

public void test(@RequestBody LoginRequest request) {
        if (request.getUsername() != null && request.getUsername().length() > 0) {
            // this is logic
        }
    }

如果request有很多参数，或者是一个表单提交，有很多字段，那我们不是要写很多这样的if判断，可是我们看这样的验证大部分都是相同的，唯独就是字段不一样，那有没有什么便捷的方法呢？ 有，就是Hibernate Validateor验证框架，他可以使我们直接使用注解的方式，完成字段验证，加上注解后，剩下的我们只关注自己的逻辑了

怎么使用该验证框架呢

一、使用maven添加包依赖

<dependency>  
       <groupId>org.hibernate</groupId>  
       <artifactId>hibernate-validator</artifactId>  
       <version>5.0.2.Final</version>  
 </dependency>

二、与springMVC的融合

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

    <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        <property name="providerClass" value="org.hibernate.validator.HibernateValidator" />
        <property name="validationMessageSource" ref="messageSource" />
    </bean>

    <bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
        <property name="basenames">
            <list>
                <value>classpath:messages</value>
                <value>classpath:org/hibernate/validator/ValidationMessages</value>
            </list>
        </property>
        <property name="useCodeAsDefaultMessage" value="false" />
        <property name="defaultEncoding" value="UTF-8" />
        <property name="cacheSeconds" value="60" />
    </bean>

property ：validationMessageSource如果不设置，则默认取org.hibernate.validator.ValidatorMessages里面的内容

javax.validation.constraints.AssertFalse.message = must be false
javax.validation.constraints.AssertTrue.message  = must be true
javax.validation.constraints.DecimalMax.message  = must be less than ${inclusive == true ? 'or equal to ' : ''}{value}
javax.validation.constraints.DecimalMin.message  = must be greater than ${inclusive == true ? 'or equal to ' : ''}{value}
javax.validation.constraints.Digits.message      = numeric value out of bounds (<{integer} digits>.<{fraction} digits> expected)
javax.validation.constraints.Future.message      = must be in the future
javax.validation.constraints.Max.message         = must be less than or equal to {value}
javax.validation.constraints.Min.message         = must be greater than or equal to {value}
javax.validation.constraints.NotNull.message     = may not be null
javax.validation.constraints.Null.message        = must be null
javax.validation.constraints.Past.message        = must be in the past
javax.validation.constraints.Pattern.message     = must match "{regexp}"
javax.validation.constraints.Size.message        = size must be between {min} and {max}

org.hibernate.validator.constraints.CreditCardNumber.message = invalid credit card number
org.hibernate.validator.constraints.Email.message            = not a well-formed email address
org.hibernate.validator.constraints.Length.message           = length must be between {min} and {max}
org.hibernate.validator.constraints.NotBlank.message         = may not be empty
org.hibernate.validator.constraints.NotEmpty.message         = may not be empty
org.hibernate.validator.constraints.Range.message            = must be between {min} and {max}
org.hibernate.validator.constraints.SafeHtml.message         = may have unsafe html content
org.hibernate.validator.constraints.ScriptAssert.message     = script expression "{script}" didn't evaluate to true
org.hibernate.validator.constraints.URL.message              = must be a valid URL
org.hibernate.validator.constraints.br.CNPJ.message          = invalid Brazilian corporate taxpayer registry number (CNPJ)
org.hibernate.validator.constraints.br.CPF.message           = invalid Brazilian individual taxpayer registry number (CPF)
org.hibernate.validator.constraints.br.TituloEleitor.message = invalid Brazilian Voter ID card number

同时还可以设置自己的，如上面例子中，在classpath下新建message.properties，以key value形式

user.not.empty = 用户名不能为空

三、现在相关配置完成，可以开始我们的编码了

1、新建一个message.properties

username.empty=用户名不能为空

比如：我现在有一个用户注册，首先建一个RegisterBean

@NotEmpty(message = "${username.empty}")

private String userName;

2、在Controller里面验证使用

@RequestMapping("/register")

public CommonResp register(@Valid @RequestBody RegisterBean register,  BindingResult bingingresult) {

      // 如果验证不通过，错误信息会在BindingResult这个对象中

    if (bingingresult.hasErrors()) {

              return CommonResp(ErrorCode.xxx,  bingingresult.getErrors().get(0).getDefaultMessage());

    }

}

这样就可以进行验证了。

JSR-303只是一个规范，而Spring也没有对这一规范进行实现，那么当我们在SpringMVC中需要使用到JSR-303的时候就需要我们提供一个对JSR-303规范的实现，Hibernate Validator是实现了这一规范的，这里我将以它作为JSR-303的实现来讲解SpringMVC对JSR-303的支持。        JSR-303的校验是基于注解的，它内部已经定义好了一系列的限制注解，我们只需要把这些注解标记在需要验证的实体类的属性上或是其对应的get方法上。

JSR-303原生支持的限制有如下几种