`

Spring MVC 学习笔记 十 使用jsr 303进行校验

 
阅读更多

可访问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中直接对输入结果进行验证

Spring MVC在使用了<mvc:annotation-driven> 后，如果路径中有jsr 303的实现，将自动提供对jsr 303验证方式的支持。
一：使用hibernate validator进行数据验证
   选择的是hibernate validator,因此需要修改pom.xml增加对hibernate validator的支持。

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

 

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

 

	@NotEmpty
	private String userName;
	@Email
	private String email;

 

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

	@RequestMapping("/valid")
	public String valid(@ModelAttribute("vm") @Valid ValidModel vm, BindingResult result) {
		if (result.hasErrors()) {
			return "validResult";
		}

		return "helloworld";
	}

 增加显示验证结果的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>

 

二：自定义jsr 303格式的annotation
参考hibernate validator 4 reference 手册中3.1节，增加一个自定义要求输入内容为定长的annotation验证类
新增annotation类定义

@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 {};
}

 

及具体的验证实现类如下 

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,如下

	<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 注入。

	<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的引用

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

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

	@FixLength(length=11)
	private String mobileNO;

  在前端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中直接对输入结果进行验证 

	@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按钮进行调用测试。

分享到：
| Spring MVC 学习笔记 十一 data binding
评论
发表评论

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

相关推荐

    Spring3.0学习笔记

    4. **JSR-303数据验证**：Spring 3.0集成了JSR-303标准，提供了对Java Bean验证的支持，通过`@Valid`注解可以实现表单验证，增强了数据校验的能力。 5. **MVC框架改进**：Spring 3.0的Web MVC框架得到了显著增强，...

    SpringMvc学习笔记

    - Validation校验：使用JSR 303/349提供的数据校验机制，确保输入数据的有效性。 - 异常处理器：定义全局异常处理器，统一处理系统异常，提升代码健壮性。 - RESTful支持：通过HTTP动词（GET、POST、PUT、DELETE...

    springmvc学习笔记

    本学习笔记将深入探讨Spring MVC的核心概念、配置、控制器、视图解析、数据绑定、异常处理等关键知识点。 1. **核心概念** - **DispatcherServlet**：Spring MVC 的核心组件，负责接收请求并分发到相应的处理器。 ...

    springmvc笔记分享主要是编程和网页开发方向.rar

    笔记可能会介绍如何处理表单提交，使用 @ModelAttribute 注解接收表单数据，以及如何配合 JSR-303 验证框架进行数据校验。 最后，笔记可能会涵盖异常处理、国际化、拦截器等高级话题。例如，自定义异常处理器可以...

    笔记_springmvc_

    - JSR 303/JSR 349提供的Bean Validation进行数据校验。 9. **上传下载** - 使用MultipartFile处理文件上传，可配合Commons MultipartResolver实现多文件上传。 - 对于文件下载，可以通过Response对象设置相应头...

    Spring_Note.zip

    4. **JSR-303/JSR-349 Bean Validation**：Spring 3集成了Bean Validation框架，提供了数据验证的能力，可以方便地通过注解进行校验。 5. **RESTful支持**：Spring 3增强了对RESTful风格的Web服务的支持，通过`@...

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

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

    SpringMVC笔记.zip

    - 使用JSR-303或Hibernate Validator进行数据校验。 11. **国际化与本地化**： - 使用`LocaleResolver`和`MessageSource`支持多语言。 12. **视图层优化**： - Thymeleaf、FreeMarker等模板引擎可以提供更优雅...

    狂神说springmvc笔记.zip

    SpringMVC提供数据绑定功能，可以自动将请求参数绑定到模型对象，同时支持JSR-303/JSR-349的Bean Validation进行数据校验。 5. **视图技术**： SpringMVC支持多种视图技术，如JSP、FreeMarker、Thymeleaf等。视图...

    吴天雄--SpringMVC笔记.doc

    - JSR303 支持：SpringMVC 支持参数校验标准，提高数据验证的便利性。 - 开发效率：Struts2 的 OGNL 表达式简化页面开发，但执行效率不一定高于 JSTL。 4. **SpringMVC 中的关键组件** - **DispatcherServlet**...

    狂神springmvc 笔记，同b站课程

    - 数据验证：使用Hibernate Validator或JSR 303进行数据校验。 7. **异常处理**： - 定制异常处理：自定义异常处理器，统一处理业务异常和系统异常。 - 全局异常处理：使用@ControllerAdvice注解进行全局异常...

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