`

SpringMVC 使用JSR-303进行校验 @Valid

SpringSpringMVCJAVA@Valid验证 
阅读更多

 

一、准备校验时使用的JAR

     

  说明：

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

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

 

------------------------------------------------------------------------------------------------

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

Java代码 复制代码  收藏代码
Java代码  收藏代码
  1. @NotEmpty  
  2. private String userName;  
  3. @Email  
  4. private String email;  


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

Java代码 复制代码  收藏代码
Java代码  收藏代码
  1. @RequestMapping("/valid")  
  2. public String valid(@ModelAttribute("vm") [color=red]@Valid[/color] ValidModel vm, BindingResult result) {  
  3.     if (result.hasErrors()) {  
  4.         return "validResult";  
  5.     }  
  6.   
  7.     return "helloworld";  
  8. }  


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

Jsp代码 复制代码  收藏代码
Jsp代码  收藏代码
  1. <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%>  
  2.   
  3. <html>  
  4. <head>  
  5. <title>Reservation Form</title>  
  6. <style>  
  7. .error {  
  8.     color: #ff0000;  
  9.     font-weight: bold;  
  10. }  
  11. </style>  
  12. </head>  
  13.   
  14. <body>  
  15.     <form:form method="post" modelAttribute="vm">  
  16.         <form:errors path="*" cssClass="error" />  
  17.         <table>  
  18.             <tr>  
  19.                 <td>Name</td>  
  20.                 <td><form:input path="userName" />  
  21.                 </td>  
  22.                 <td><form:errors path="userName" cssClass="error" />  
  23.                 </td>  
  24.             </tr>  
  25.             <tr>  
  26.                 <td>email</td>  
  27.                 <td><form:input path="email" />  
  28.                 </td>  
  29.                 <td><form:errors path="email" cssClass="error" />  
  30.                 </td>  
  31.             </tr>  
  32.       
  33.             <tr>  
  34.                 <td colspan="3"><input type="submit" />  
  35.                 </td>  
  36.             </tr>  
  37.         </table>  
  38.     </form:form>  
  39. </body>  
  40. </html>  


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

Java代码 复制代码  收藏代码
Java代码  收藏代码
  1. @Target( { METHOD, FIELD, ANNOTATION_TYPE })  
  2. @Retention(RUNTIME)  
  3. @Constraint(validatedBy = FixLengthImpl.class)  
  4. public @interface FixLength {  
  5.   
  6.     int length();  
  7.     String message() default "{net.zhepu.web.valid.fixlength.message}";  
  8.   
  9.     Class<?>[] groups() default {};  
  10.   
  11.     Class<? extends Payload>[] payload() default {};  
  12. }  


及具体的验证实现类如下

Java代码 复制代码  收藏代码
Java代码  收藏代码
  1. public class FixLengthImpl implements ConstraintValidator<FixLength, String> {  
  2.     private int length;  
  3.     @Override  
  4.     public boolean isValid(String validStr,  
  5.             ConstraintValidatorContext constraintContext) {  
  6.         if (validStr.length() != length) {  
  7.             return false;  
  8.         } else {  
  9.             return true;  
  10.         }  
  11.     }  
  12.   
  13.     @Override  
  14.     public void initialize(FixLength fixLen) {  
  15.         this.length = fixLen.length();  
  16.     }  
  17. }  


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

Xml代码 复制代码  收藏代码
  1.   
Xml代码  收藏代码
  1. <bean id="messageSource"  
  2.     class="org.springframework.context.support.ReloadableResourceBundleMessageSource"  
  3.     p:fallbackToSystemLocale="true" p:useCodeAsDefaultMessage="false"  
  4.     p:defaultEncoding="UTF-8">  
  5.     <description>Base message source to handle internationalization  
  6.     </description>  
  7.     <property name="basenames">  
  8.         <list>  
  9.             <!-- main resources -->  
  10.             <value>classpath:valid/validation</value>  
  11.         </list>  
  12.     </property>  
  13. </bean>  


表示spring 将从路径valid/validation.properties中查找对于的message。
新增valid bean 引用新增的messageSource bean，表示valid message将从messageSource bean 注入。

Xml代码 复制代码  收藏代码
Xml代码  收藏代码
  1. <bean id="validator"  
  2.     class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"  
  3.     p:validationMessageSource-ref="messageSource">  
  4.     <description>Enable the bean validation provider, and configure it to  
  5.         use the messageSource when resolving properties</description>  
  6. </bean>  



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

Xml代码 复制代码  收藏代码
Xml代码  收藏代码
  1. <mvc:annotation-driven validator="validator" />  



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

Java代码 复制代码  收藏代码
Java代码  收藏代码
  1. @FixLength(length=11)  
  2. private String mobileNO;  


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

Jsp代码 复制代码  收藏代码
Jsp代码  收藏代码
  1. <tr>  
  2.     <td>mobileno</td>  
  3.     <td><form:input path="mobileNO" />  
  4.     </td>  
  5.     <td><form:errors path="mobileNO" cssClass="error" />  
  6.     </td>  
  7. </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代码 复制代码  收藏代码
Java代码  收藏代码
  1. @RequestMapping("/validJson1")  
  2. @ResponseBody  
  3. public JsonResult processSubmitjson(@RequestBody ValidModel vm,  
  4.         HttpServletRequest request) {  
  5.     JsonResult jsonRst = new JsonResult();  
  6.       
  7.     Set<ConstraintViolation<ValidModel>> set = validator.validate(vm);  
  8.     for (ConstraintViolation<ValidModel> violation : set) {  
  9.   
  10.         String propertyPath = violation.getPropertyPath().toString();  
  11.         ;  
  12.         String message = violation.getMessage();  
  13.         log.error("invalid value for: '" + propertyPath + "': "  
  14.                 + message);  
  15.     }         
  16.     if (!set.isEmpty()){  
  17.         jsonRst.setSuccess(false);  
  18.         jsonRst.setMsg("输入有误!");  
  19.         return jsonRst;  
  20.     }  
  21.   
  22.     jsonRst.setSuccess(true);  
  23.     jsonRst.setMsg("输入成功!");  
  24.     return jsonRst;  
  25. }  




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

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

Java代码 复制代码  收藏代码
Java代码  收藏代码
  1. @RequestMapping("/validJson2")  
  2.  @ResponseBody  
  3.  public JsonResult testJson4(@RequestBody @Valid ValidModel vm){  
  4.     log.info("handle json for valid");  
  5.     return new JsonResult(true,"return ok");      
  6.  }  


这里没有对输入值做任何验证，所有的验证都在AOP中完成。
修改pom.xml增加对AOP相关类库的引用。

Xml代码 复制代码  收藏代码
Xml代码  收藏代码
  1. <dependency>  
  2.     <groupId>org.aspectj</groupId>  
  3.     <artifactId>aspectjweaver</artifactId>  
  4.     <version>1.6.11</version>  
  5. </dependency>  
  6.   
  7. <dependency>  
  8.     <groupId>cglib</groupId>  
  9.     <artifactId>cglib</artifactId>  
  10.     <version>2.2.2</version>  
  11. </dependency>  
  12.   
  13. <dependency>  
  14.     <groupId>org.springframework</groupId>  
  15.     <artifactId>spring-aop</artifactId>  
  16.     <version>${org.springframework.version}</version>  
  17. </dependency>  


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

Xml代码 复制代码  收藏代码
Xml代码  收藏代码
  1. <!-- enable Spring AOP support -->  
  2. <aop:aspectj-autoproxy proxy-target-class="true" />  


最后，新增AOP类

Java代码 复制代码  收藏代码
Java代码  收藏代码
  1. public class CustomerValidatorAOP {  
  2.   private Validator validator;  
  3.    
  4.   @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")  
  5.   private void controllerInvocation() {  
  6.   }  
  7.    
  8.   @Around("controllerInvocation()")  
  9.   public Object aroundController(ProceedingJoinPoint joinPoint) throws Throwable {  
  10.    
  11.     MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();  
  12.     Method method = methodSignature.getMethod();  
  13.     Annotation[] annotationList = method.getAnnotations();  
  14.    /* for(Annotation anno:annotationList){ 
  15.         System.out.println(ResponseBody.class.isInstance(anno)); 
  16.     } 
  17. */  
  18.     Annotation[][] argAnnotations = method.getParameterAnnotations();  
  19.     String[] argNames = methodSignature.getParameterNames();  
  20.     Object[] args = joinPoint.getArgs();  
  21.    
  22.     for (int i = 0; i < args.length; i++) {  
  23.       if (hasRequestBodyAndValidAnnotations(argAnnotations[i])) {  
  24.         Object ret = validateArg(args[i], argNames[i]);  
  25.         if(ret != null){  
  26.             return ret;  
  27.         }  
  28.       }  
  29.     }  
  30.    
  31.     return joinPoint.proceed(args);  
  32.   }  
  33.    
  34.   private boolean hasRequestBodyAndValidAnnotations(Annotation[] annotations) {  
  35.     if (annotations.length < 2)  
  36.       return false;  
  37.    
  38.     boolean hasValid = false;  
  39.     boolean hasRequestBody = false;  
  40.    
  41.     for (Annotation annotation : annotations) {  
  42.       if (Valid.class.isInstance(annotation))  
  43.         hasValid = true;  
  44.       else if (RequestBody.class.isInstance(annotation))  
  45.         hasRequestBody = true;  
  46.    
  47.       if (hasValid && hasRequestBody)  
  48.         return true;  
  49.     }  
  50.     return false;  
  51.   }  
  52.    
  53.   
  54.   private JsonResult validateArg(Object arg, String argName) {  
  55.     BindingResult result = getBindingResult(arg, argName);  
  56.     validator.validate(arg, result);  
  57.     if (result.hasErrors()) {  
  58.       JsonResult jsonresult = new JsonResult();  
  59.       jsonresult.setSuccess(false);  
  60.       jsonresult.setMsg("fail");  
  61.       return jsonresult;  
  62.     }  
  63.     return null;  
  64.   }  
  65.    
  66.   private BindingResult getBindingResult(Object target, String targetName) {  
  67.     return new BeanPropertyBindingResult(target, targetName);  
  68.   }  
  69.    
  70.   @Required  
  71.   public void setValidator(Validator validator) {  
  72.     this.validator = validator;  
  73.   }  


这里只考虑了输入为json格式的情况，仅仅作为一种思路供参考，实际使用时需要根据项目具体情况进行调整。
可通过修改后的helloworld.jsp中的json valid test2按钮进行调用测试。

 

原文：http://starscream.iteye.com/blog/1068905

分享到：
| Spring验证的错误返回------BindingResult
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    SpringMVC 使用JSR-303进行校验 @Valid示例

    以上所述，是SpringMVC使用JSR-303进行校验的详细知识点，包括了校验时需要添加的依赖、如何在Java Bean中定义校验规则、控制器中如何触发和处理校验、以及如何在前端页面中展示校验结果。掌握了这些知识点，开发者...

    SpringMVC使用JSR-303进行验证Bean.docx

    本篇文章将详细介绍如何在SpringMVC中使用JSR-303进行Bean验证。 首先，我们需要引入JSR-303的实现库。通常使用的是Hibernate Validator，它是JSR-303规范的一个成熟实现。在不使用Maven的情况下，我们需要下载`...

    springmvc使用JSR-303进行数据校验实例

    在上述代码中，@Valid注解告诉SpringMVC在调用validate方法时需要进行JSR-303校验。BindingResult是Spring的一个接口，它紧跟在@Valid注解的参数之后，用于收集校验产生的错误。如果校验失败，我们将返回错误页面的...

    springmvc 使用hibernate-validator校验包

    本文将深入探讨如何在Spring MVC项目中集成并使用Hibernate Validator来实现高效、强大的数据校验功能。 一、 Hibernate Validator简介 Hibernate Validator是Hibernate组织开发的一个开源项目，它是JSR 380（Java...

    SpringMVC JSR303数据校验DEMO(附:JSR303的JAR包)

    总的来说，SpringMVC与JSR303的结合使得开发者能够方便地对用户输入进行校验，提高了应用的安全性和用户体验。通过合理的注解配置，可以有效地防止非法数据进入数据库，同时也能提供友好的错误提示，增强应用程序的...

    SpringMVC-demo - examples

    `@Valid` 注解配合 `JSR-303` 验证规则，可以实现数据的校验。 7. **异常处理** 通过全局异常处理器，如 `@ControllerAdvice` 和 `@ExceptionHandler` 注解，我们可以统一处理应用程序中抛出的异常，提供友好的...

    hibernate-validator-5.1.0.zip

    然后，我们可以在控制器的方法参数上使用JSR-303注解，比如`@Validated`或`@Valid`，SpringMVC会自动调用Hibernate Validator进行验证。 四、数据校验实例 以下是一个简单的例子，展示如何使用`@NotNull`和`@Size`...

    SpringMVC杂记(五) JSR303数据验证

    在本篇《SpringMVC杂记(五) JSR303数据验证》中，我们将深入探讨SpringMVC框架如何集成并使用JSR303（JavaBeans Validation）来进行数据验证，这是一种强大的验证机制，可以确保应用程序接收到的数据是合法且符合...

    SSM笔记-SpringMVC的数据格式化 、数据校验、错误提示、错误信息国际化、返回json

    SpringMVC支持JSR-303/JSR-349标准的数据校验框架，如Hibernate Validator。通过在模型类的字段上添加验证注解（如`@NotNull`, `@Size`, `@Min`, `@Max`等），可以对用户提交的数据进行校验。在控制器中，使用`@...

    尚硅谷佟刚SpringMVC 4.X视频教程---对应课件信息

    - 使用`@Valid`和JSR-303/JSR-349提供的注解（如`@NotNull`, `@Size`, `@Min`, `@Max`等）进行数据校验。 5. **异常处理** - 可以通过`@ExceptionHandler`注解在Controller中处理特定异常，或者全局配置异常...

    SpringMvc_RestfullAPI

    5. **验证**：SpringMvc支持JSR-303/JSR-349 Bean Validation标准，可以通过`@Valid`和`@Validated`注解进行数据校验。 6. **拦截器**：`HandlerInterceptor`接口可以用来实现预处理和后处理逻辑，比如权限检查、...

    springmvc简单完整例子

    - Spring MVC提供了数据校验功能，可以使用JSR-303/JSR-349的`@Valid`和`@Constraints`注解对输入数据进行验证。 10. **国际化与主题**： - Spring MVC支持多语言和主题切换，通过消息资源文件和`LocaleResolver`...

    SpringMVC个人学习代码

    - 使用`@Valid`配合`javax.validation`进行数据校验，如JSR-303/JSR-349。 4. **异常处理**： - 可以通过`@ExceptionHandler`注解自定义异常处理方法，或者在配置中全局处理异常。 - 使用`@ControllerAdvice`...

    SpringMVC使用@Valid注解进行数据验证的方法

    @Valid注解是Spring MVC提供的一种便捷的数据校验方式，它结合了JSR-303（Java Bean Validation）规范，使得开发者能够方便地在后端进行表单数据验证。 首先，要使用@Valid注解，我们需要引入相应的依赖。在Maven...

    SpringMVC入门很简单之数据验证

    SpringMVC提供了多种方式进行数据验证，包括使用JSR-303/JSR-349（Bean Validation）标准以及自定义验证注解。 1. **使用JSR-303/JSR-349 (Bean Validation)** Bean Validation 提供了一种统一的验证API，允许在...

    专题资料（2021-2022年）SpringMVC数据类型转换要点.doc

    2. 数据验证：利用注解式验证，例如使用JSR-303/JSR-349的`@Valid`注解和Hibernate Validator，可以方便地在控制器方法参数上进行验证。 3. 格式化显示：虽然`PropertyEditor`仍可用，但新的API提供了更简单的方法来...

    springMVC3.2实现后台校验

    总的来说，Spring MVC 3.2通过集成JSR 303提供了强大的后台校验功能，使得我们能够便捷地对用户输入进行有效校验，提高了系统的健壮性。同时，自定义校验注解和校验器的机制使我们能更灵活地应对复杂的业务场景。...

    springmvc-val.rar

    这可以通过使用JSR-303/JSR-349的`@Validated`和`@GroupSequence`注解实现。例如，假设我们需要在用户注册时先验证邮箱格式，再验证邮箱是否已存在，可以定义如下校验顺序： ```java public interface ...

    服务器验证1

    下面是使用JSR303进行服务器校验的步骤： 1. 添加hibernate-validator依赖包到pom.xml文件中。 2. 在springmvc.xml文件中注册校验器。 3. 在Controller方法中，使用@Valid注解来启用JSR303验证，并紧接着声明Errors...

    SpringMVC基础jar包

    - SpringMVC还提供了数据验证机制，通过`@Valid`注解配合JSR-303/JSR-349标准的校验注解（如`@NotNull`、`@Size`等），可以在处理请求时自动进行数据验证。 四、异常处理 SpringMVC提供了统一的异常处理机制，可以...

Magicbox
Global site tag (gtag.js) - Google Analytics