浅析JSR303 验证作用、使用及使用场景、spring mvc下使用JSR303

一、JSR-303简介

JSR-303 是 Java EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator。

此实现与 Hibernate ORM 没有任何关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。 

Spring MVC 3.x 之中也大力支持 JSR-303，可以在控制器中对表单提交的数据方便地验证。 

注:可以使用注解的方式进行验证

二、作用及使用场景

 1.JSR 303 用于对Java Bean 中的字段的值进行验证,使得验证逻辑从业务代码中脱离出来。

 2.是一个运行时的数据验证框架，在验证之
4000
后验证的错误信息会被马上返回。

   使用场景：一般用于表单提交页面。

三、准备校验时使用的JAR

validation-api-1.0.0.GA.jar：JDK的接口； 

hibernate-validator-4.2.0.Final.jar是对上述接口的实现； 

log4j、slf4j、slf4j-log4j

四、JSR 303 基本的校验规则

空检查 

@Null 验证对象是否为null 

@NotNull 验证对象是否不为null, 无法查检长度为0的字符串 

@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格. 

@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

Booelan检查 

@AssertTrue 验证 Boolean 对象是否为 true 

@AssertFalse 验证 Boolean 对象是否为 false

长度检查 

@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内 

@Length(min=, max=) Validates that the annotated string is between min and max included.

日期检查 

@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期 

@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期 

@Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定
Pattern.Flag 的数组，表示正则表达式的相关选项。

数值检查 

建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null 

@Min 验证 Number 和 String 对象是否大等于指定的值 

@Max 验证 Number 和 String 对象是否小等于指定的值 

@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度 

@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度 

@Digits 验证 Number 和 String 的构成是否合法 

@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。 

@Range(min=, max=) 被指定的元素必须在合适的范围内 

@Range(min=10000,max=50000,message=”range.bean.wage”) 

@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证) 

@CreditCardNumber信用卡验证 

@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。 

@ScriptAssert(lang= ,script=, alias=) 

@URL(protocol=,host=, port=,regexp=, flags=)

五、案例分析

在使用的时候直接对JavaBean进行注解既可以实现对属性的验证

public class Order { //
必须不为 null, 大小是 10 @NotNull @Size(min = 10, max = 10) private String orderId; // 必须不为空 @NotEmpty private String
customer; // 必须是一个电子信箱地址 @Email private String email; // 必须不为空 @NotEmpty private String address; // 必须不为 null,
必须是下面四个字符串'created', 'paid', 'shipped', 'closed'其中之一 // @Status 是一个定制化的 contraint @NotNull @Status private String status; // 必须不为 null @NotNull private Date
createDate; // 嵌套验证 @Valid private Product product; // getter 和setter方法 }

又例：

@NotNull(message = "adultTax不能为空") private Integer
adultTax; @NotNull(message = "adultTaxType不能为空") @Min(value = http://blog.csdn.net/xlgen157387/article/details/0, message = "adultTaxType 的最小值为0") @Max(value
= http://blog.csdn.net/xlgen157387/article/details/1, message = "adultTaxType 的最大值为1") private Integer adultTaxType; @NotNull(message = "reason信息不可以为空") @Pattern(regexp
= "[1-7]{1}", message = "reason的类型值为1-7中的一个类型") private String reason;//订单取消原因

六、实例：

public class ValidateTestClass{ @NotNull(message
= "reason信息不可以为空") @Pattern(regexp = "[1-7]{1}", message = "reason的类型值为1-7中的一个类型") private String reason;//订单取消原因 //get、set方法、有参构造方法、无参构造方法、toString方法省略 /**
* 验证参数：就是验证上述注解的完整方法 * @return */ public void validateParams() { //调用JSR303验证工具，校验参数 Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
Set<ConstraintViolation<ValidateTestClass>> violations = validator.validate(this); Iterator<ConstraintViolation<ValidateTestClass>> iter = violations.iterator(); if (iter.hasNext()) { String errMessage = iter.next().getMessage(); throw new ValidationException(errMessage);
} } }

我们可以写一个测试类进行验证：

public class ValidateTestClassValidateTest{
@Test public void validateParam(){ ValidateTestClass validateTestClass = new ValidateTestClass(); validateTestClass .setReason(12); validateTestClass
.validateParams(); //调用验证的方法 } }

ok！这样就可以进行测试。

并且我们在使用的时候一定要注意，对于某一种验证规则是适用于一种数据类型的，简单说来，正则则表达式的验证对象可以为String类型的，但是不可以为Integer类型的数据，那么当我们使用正则表达式进行验证的时候就会出现错误。 

类似于：

javax.validation.UnexpectedTypeException: HV000030:
No validator could be found for type: java.lang.Integer. at org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorManager.verifyResolveWasUnique(ConstraintValidatorManager.java:218)

意思就是你这个验证的注解不应该对该类型进行注解。

七、spring mvc下的JSR303验证：

Spring MVC在使用了<mvc:annotation-driven> 后，如果路径中有jsr 303的实现，将自动提供对jsr 303验证方式的支持。 

一：使用hibernate validator进行数据验证 

   选择的是hibernate validator,因此需要修改pom.xml增加对hibernate validator的支持。 

Xml代码  


<dependency>  

    <groupId>org.hibernate</groupId>  

    <artifactId>hibernate-validator</artifactId>  

    <version>4.1.0.Final</version>  

</dependency>  

    
新增一个测试的pojo bean ,增加jsr 303格式的验证annotation 

Java代码  


@NotEmpty  

private String userName;  

@Email  

private String email;  

在controller 类中的handler method中，对需要验证的对象前增加@Valid 标志 

Java代码  


@RequestMapping("/valid")  

public String valid(@ModelAttribute("vm") [color=red]@Valid[/color] ValidModel vm, BindingResult result) {  

    if (result.hasErrors()) {  

        return "validResult";  

    }  

  

    return "helloworld";  

}  

增加显示验证结果的jsp如下 

Jsp代码  


<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%>  

  

<html>  

<head>  

<title>Reservation Form</title>  

<style>  

.error {  

    color: #ff0000;  

    font-weight: bold;  

}  

</style>  

</head>  

  

<body>  

    <form:form method="post" modelAttribute="vm">  

        <form:errors path="*" cssClass="error" />  

        <table>  

            <tr>  

                <td>Name</td>  

                <td><form:input path="userName" />  

                </td>  

                <td><form:errors path="userName" cssClass="error" />  

                </td>  

            </tr>  

            <tr>  

                <td>email</td>  

                <td><form:input path="email" />  

                </td>  

                <td><form:errors path="email" cssClass="error" />  

                </td>  

            </tr>  

      

            <tr>  

                <td colspan="3"><input type="submit" />  

                </td>  

            </tr>  

        </table>  

    </form:form>  

</body>  

</html>  

访问 http://localhost:8080/springmvc/valid?userName=winzip&email=winzip 查看验证结果。 
二：自定义jsr 303格式的annotation 
参考hibernate validator 4 reference 手册中3.1节，增加一个自定义要求输入内容为定长的annotation验证类 

新增annotation类定义 

Java代码  


@Target( { METHOD, FIELD, ANNOTATION_TYPE })  

@Retention(RUNTIME)  

@Constraint(validatedBy = FixLengthImpl.class)  

public @interface FixLength {  

  

    int length();  

    String message() default "{net.zhepu.web.valid.fixlength.message}";  

  

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

  

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

}  

及具体的验证实现类如下 

Java代码  


public class FixLengthImpl implements ConstraintValidator<FixLength, String> {  

    private int length;  

    @Override  

    public boolean isValid(String validStr,  

            ConstraintValidatorContext constraintContext) {  

        if (validStr.length() != length) {  

            return false;  

        } else {  

            return true;  

        }  

    }  

  

    @Override  

    public void initialize(FixLength fixLen) {  

        this.length = fixLen.length();  

    }  

}  

为使自定义验证标注的message正常显示，需要修改servlet context配置文件，新增messageSource bean,如下 

Xml代码  


<bean id="messageSource"  

    class="org.springframework.context.support.ReloadableResourceBundleMessageSource"  

    p:fallbackToSystemLocale="true" p:useCodeAsDefaultMessage="false"  

    p:defaultEncoding="UTF-8">  

    <description>Base message source to handle internationalization  

    </description>  

    <property name="basenames">  

        <list>  

            <!-- main resources -->  

            <value>classpath:valid/validation</value>  

        </list>  

    </property>  

</bean>  

表示spring 将从路径valid/validation.properties中查找对于的message。 

新增valid bean 引用新增的messageSource bean，表示valid message将从messageSource bean 注入。 

Xml代码  


<bean id="validator"  

    class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"  

    p:validationMessageSource-ref="messageSource">  

    <description>Enable the bean validation provider, and configure it to  

        use the messageSource when resolving properties</description>  

</bean>  

修改 <mvc:annotation-driven> 增加对validator bean的引用 

Xml代码  


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

最后修改之前新增的pojo bean ，新增一个mobileNO属性并增加对自定义标注的引用 

Java代码  


@FixLength(length=11)  

private String mobileNO;  

在前端jsp中也增加新字段的支持 

Jsp代码  


<tr>  

    <td>mobileno</td>  

    <td><form:input path="mobileNO" />  

    </td>  

    <td><form:errors path="mobileNO" cssClass="error" />  

    </td>  

</tr>  

可访问url http://localhost:8080/springmvc/valid?userName=winzip&email=winzip&mobileNO=138188888 
来查看修改的结果。 

三 json输入的验证 

Spring mvc 3.0.5中对于json格式的输入直接使用@valid标注有问题，目前这个bug还未修复 (见 SPR-6709)，预计在3.1 m2版本中会修复。 在此之前，可以通过如下几种方式来对json（或xml）格式的输入来进行验证。 
1：在handler method中直接对输入结果进行验证 

Java代码  


@RequestMapping("/validJson1")  

@ResponseBody  

public JsonResult processSubmitjson(@RequestBody ValidModel vm,  

        HttpServletRequest request) {  

    JsonResult jsonRst = new JsonResult();  

      

    Set<ConstraintViolation<ValidModel>> set = validator.validate(vm);  

    for (ConstraintViolation<ValidModel> violation : set) {  

  

        String propertyPath = violation.getPropertyPath().toString();  

        ;  

        String message = violation.getMessage();  

        log.error("invalid value for: '" + propertyPath + "': "  

                + message);  

    }         

    if (!set.isEmpty()){  

        jsonRst.setSuccess(false);  

        jsonRst.setMsg("输入有误!");  

        return jsonRst;  

    }  

  

    jsonRst.setSuccess(true);  

    jsonRst.setMsg("输入成功!");  

    return jsonRst;  

}  

可通过修改后的helloworld.jsp中的json valid test1按钮进行调用测试。 

2：将此验证逻辑封装为一个AOP，当需验证的对象前有@valid标注和@RequestBody标注时开始验证 

新增handler method如下 

Java代码  


@RequestMapping("/validJson2")  

 @ResponseBody  

 public JsonResult testJson4(@RequestBody @Valid ValidModel vm){  

    log.info("handle json for valid");  

    return new JsonResult(true,"return ok");      

 }  

这里没有对输入值做任何验证，所有的验证都在AOP中完成。 

修改pom.xml增加对AOP相关类库的引用。 

Xml代码  


<dependency>  

    <groupId>org.aspectj</groupId>  

    <artifactId>aspectjweaver</artifactId>  

    <version>1.6.11</version>  

</dependency>  

  

<dependency>  

    <groupId>cglib</groupId>  

    <artifactId>cglib</artifactId>  

    <version>2.2.2</version>  

</dependency>  

  

<dependency>  

    <groupId>org.springframework</groupId>  

    <artifactId>spring-aop</artifactId>  

    <version>${org.springframework.version}</version>  

</dependency>  

修改servet context xml，增加对aop的支持。 

Xml代码  


<!-- enable Spring AOP support -->  

<aop:aspectj-autoproxy proxy-target-class="true" />  

最后，新增AOP类 

Java代码  


public class CustomerValidatorAOP {  

  private Validator validator;  

   

  @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")  

  private void controllerInvocation() {  

  }  

   

  @Around("controllerInvocation()")  

  public Object aroundController(ProceedingJoinPoint joinPoint) throws Throwable {  

   

    MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();  

    Method method = methodSignature.getMethod();  

    Annotation[] annotationList = method.getAnnotations();  

   /* for(Annotation anno:annotationList){ 

        System.out.println(ResponseBody.class.isInstance(anno)); 

    } 

*/  

    Annotation[][] argAnnotations = method.getParameterAnnotations();  

    String[] argNames = methodSignature.getParameterNames();  

    Object[] args = joinPoint.getArgs();  

   

    for (int i = 0; i < args.length; i++) {  

      if (hasRequestBodyAndValidAnnotations(argAnnotations[i])) {  

        Object ret = validateArg(args[i], argNames[i]);  

        if(ret != null){  

            return ret;  

        }  

      }  

    }  

   

    return joinPoint.proceed(args);  

  }  

   

  private boolean hasRequestBodyAndValidAnnotations(Annotation[] annotations) {  

    if (annotations.length < 2)  

      return false;  

   

    boolean hasValid = false;  

    boolean hasRequestBody = false;  

   

    for (Annotation annotation : annotations) {  

      if (Valid.class.isInstance(annotation))  

        hasValid = true;  

      else if (RequestBody.class.isInstance(annotation))  

        hasRequestBody = true;  

   

      if (hasValid && hasRequestBody)  

        return true;  

    }  

    return false;  

  }  

   

  

  private JsonResult validateArg(Object arg, String argName) {  

    BindingResult result = getBindingResult(arg, argName);  

    validator.validate(arg, result);  

    if (result.hasErrors()) {  

      JsonResult jsonresult = new JsonResult();  

      jsonresult.setSuccess(false);  

      jsonresult.setMsg("fail");  

      return jsonresult;  

    }  

    return null;  

  }  

   

  private BindingResult getBindingResult(Object target, String targetName) {  

    return new BeanPropertyBindingResult(target, targetName);  

  }  

   

  @Required  

  public void setValidator(Validator validator) {  

    this.validator = validator;  

  }  

这里只考虑了输入为json格式的情况，仅仅作为一种思路供参考，实际使用时需要根据项目具体情况进行调整。 

可通过修改后的helloworld.jsp中的json valid test2按钮进行调用测试。