原文:https://blog.csdn.net/qq_28867949/article/category/7370730
一、JSR-303简介
JSR-303 是 JAVA EE 6 中的一项子规范,叫做 Bean Validation,官方参考实现是Hibernate Validator。
此实现与 Hibernate ORM 没有任何关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。
Spring MVC 3.x 之中也大力支持 JSR-303,可以在控制器中对表单提交的数据方便地验证。
注:可以使用注解的方式进行验证
二、准备校验时使用的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进行注解既可以实现对属性的验证
1 public class Order { 2 ????// 必须不为 null, 大小是 10 3 ????@NotNull 4 ????@Size(min = 10, max = 10) 5 ????private String orderId; 6 ????// 必须不为空 7 ????@NotEmpty 8 ????private String customer; 9 ????// 必须是一个电子信箱地址10 ????@Email11 ????private String email;12 ????// 必须不为空13 ????@NotEmpty14 ????private String address;15 ????// 必须不为 null, 必须是下面四个字符串‘created‘, ‘paid‘, ‘shipped‘, ‘closed‘其中之一16 ????// @Status 是一个定制化的 contraint17 ????@NotNull18 ????@Status19 ????private String status;20 ????// 必须不为 null21 ????@NotNull22 ????private Date createDate;23 ????// 嵌套验证24 ????@Valid25 ????private Product product;26 ?27 ???// getter 和setter方法28 }
???@NotNull(message = "adultTax不能为空") ???private Integer adultTax; ????@NotNull(message = "adultTaxType不能为空") ???@Min(value = 0, message = "adultTaxType 的最小值为0") ???@Max(value = 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)
意思就是你这个验证的注解不应该对该类型进行注解。
六、 json输入的验证
Spring mvc 3.0.5中对于json格式的输入直接使用@valid标注有问题,目前这个bug还未修复 (见 SPR-6709),预计在3.1 m2版本中会修复。
在此之前,可以通过如下几种方式来对json(或xml)格式的输入来进行验证。
1:在handler method中直接对输入结果进行验证
@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如下
@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相关类库的引用。
<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的支持。
<!-- enable Spring AOP support --> ?<aop:aspectj-autoproxy proxy-target-class="true" /> ?
最后,新增AOP类
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按钮进行调用测试。
七、和SpringMVC的配置
参考·:http://www.php.cn/java-article-372190.html
JSR303 数据检验
原文地址:https://www.cnblogs.com/pingxin/p/p00088.html