SpringMVC杂记(五) JSR303数据验证 自定义验证规则

http://yingzhuo.iteye.com/blog/1455438

SpringMVC杂记(五) JSR303数据验证

1) 首先JSR303的实现必须加入CLASSPATH

Xml代码

1. <dependency>
2. <groupId>org.hibernate</groupId>
3. <artifactId>hibernate-validator</artifactId>
4. <version>4.2.0.Final</version>
5. </dependency>

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

2) SpringMVC 中的配置

Xml代码

1. <mvc:annotation-driven validator="validator"/>
3. <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" />

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

<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" />

3) 关于JSR303给出的默认标注和Hibernate可以参考 hibernate-validator官方文档
我的 另一篇博客也简要介绍了一下


4) 自己实现验证规则
4.1 自定义元注释

Java代码

1. package com.wicresoft.jpo.demo.validator;
3. import java.lang.annotation.Documented;
4. import java.lang.annotation.ElementType;
5. import java.lang.annotation.Retention;
6. import java.lang.annotation.RetentionPolicy;
7. import java.lang.annotation.Target;
9. import javax.validation.Constraint;
10. import javax.validation.Payload;
12. @Documented
13. @Retention(RetentionPolicy.RUNTIME)
14. @Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD})
15. @Constraint(validatedBy = {BetweenImplForDate.class})
16. public @interface Between {
18. public String message();
20. public String startDate();
22. public String endDate();
24. public String format() default "yyyy-MM-dd";
26. public Class<?>[] groups() default {};
28. Class<? extends Payload>[] payload() default {};
29. }

package com.wicresoft.jpo.demo.validator;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD})
@Constraint(validatedBy = {BetweenImplForDate.class})
public @interface Between {

	public String message();

	public String startDate();

	public String endDate();

	public String format() default "yyyy-MM-dd";

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

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

4.2 验证器实现类

Java代码

1. package com.wicresoft.jpo.demo.validator;
3. import java.text.DateFormat;
4. import java.text.ParseException;
5. import java.text.SimpleDateFormat;
6. import java.util.Date;
8. import javax.validation.ConstraintValidator;
9. import javax.validation.ConstraintValidatorContext;
11. import org.slf4j.Logger;
12. import org.slf4j.LoggerFactory;
14. public class BetweenImplForDate implements ConstraintValidator<Between, Date> {
16. private static final Logger LOGGER = LoggerFactory.getLogger(BetweenImplForDate.class);
18. private Date startDate;
19. private Date endDate;
20. private DateFormat dateFormat;
22. public void initialize(Between annotation) {
23. this.dateFormat = new SimpleDateFormat(annotation.format());
24. try {
25. this.startDate = dateFormat.parse(annotation.startDate());
26. this.endDate = dateFormat.parse(annotation.endDate());
27. } catch (ParseException e) {
28. throw new IllegalArgumentException(e.getMessage(), e);
29. }
30. }
32. public boolean isValid(Date value, ConstraintValidatorContext context) {
33. LOGGER.debug("value = {}", dateFormat.format(value));
34. return (startDate.getTime() <= value.getTime()) && (value.getTime() < endDate.getTime());
35. }
36. }

package com.wicresoft.jpo.demo.validator;

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class BetweenImplForDate implements ConstraintValidator<Between, Date> {

	private static final Logger LOGGER = LoggerFactory.getLogger(BetweenImplForDate.class);

	private Date startDate;
	private Date endDate;
	private DateFormat dateFormat;

	public void initialize(Between annotation) {
		this.dateFormat = new SimpleDateFormat(annotation.format());
		try {
			this.startDate  = dateFormat.parse(annotation.startDate());
			this.endDate    = dateFormat.parse(annotation.endDate());
		} catch (ParseException e) {
			throw new IllegalArgumentException(e.getMessage(), e);
		}
	}

	public boolean isValid(Date value, ConstraintValidatorContext context) {
		LOGGER.debug("value = {}", dateFormat.format(value));
		return (startDate.getTime() <= value.getTime()) && (value.getTime() < endDate.getTime());
	}
}

4.3 添加国际化支持，让错误信息配置在i18n文件里。SpringMVC配置文件改成如下。

Properties代码

1. v.login.birthday=生日不合法，生日应在{startDate}与{endDate}之间。

v.login.birthday=生日不合法，生日应在{startDate}与{endDate}之间。

Xml代码

1. <mvc:annotation-driven conversion-service="conversion-service" validator="validator">
2. <mvc:message-converters register-defaults="false">
3. <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter" />
4. <bean class="org.springframework.http.converter.FormHttpMessageConverter" />
5. <bean class="org.springframework.http.converter.xml.SourceHttpMessageConverter" />
6. <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter" />
7. <bean class="org.springframework.http.converter.StringHttpMessageConverter" />
8. <bean class="com.wicresoft.jpo.demo.http.converter.UTF8StringHttpMessageConverter" />
9. </mvc:message-converters>
10. </mvc:annotation-driven>
12. <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
13. <property name="validationMessageSource" ref="messageSource" />
14. </bean>
16. <bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
17. <property name="defaultEncoding" value="UTF-8" />
18. <property name="basenames">
19. <list>
20. <value>classpath:com/wicresoft/jpo/demo/i18n/v</value>
21. </list>
22. </property>
23. </bean>

<mvc:annotation-driven conversion-service="conversion-service" validator="validator">
	<mvc:message-converters register-defaults="false">
		<bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter" />
		<bean class="org.springframework.http.converter.FormHttpMessageConverter" />
		<bean class="org.springframework.http.converter.xml.SourceHttpMessageConverter" />
		<bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter" />
		<bean class="org.springframework.http.converter.StringHttpMessageConverter" />
		<bean class="com.wicresoft.jpo.demo.http.converter.UTF8StringHttpMessageConverter" />
	</mvc:message-converters>
</mvc:annotation-driven>

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

<bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
	<property name="defaultEncoding" value="UTF-8" />
	<property name="basenames">
		<list>
			<value>classpath:com/wicresoft/jpo/demo/i18n/v</value>
		</list>
	</property>
</bean>

Jsp代码

1. ...
2. <tr>
3. <td>生日</td>
4. <td><form:input path="birthday" /></td>
5. <td><form:errors path="birthday" /></td>
6. </tr>
7. ...

...
<tr>
	<td>生日</td>
	<td><form:input path="birthday" /></td>
	<td><form:errors path="birthday" /></td>
</tr>
...

5) 使用标注

Java代码

1. public class UserRegistForm implements java.io.Serializable {
3. private static final long serialVersionUID = -5471272011192637665L;
5. private String username;
6. private String password;
7. private String sex;
9. @DateTimeFormat(pattern = "yyyy-MM-dd")
10. // message 就是国际化文件中的key
11. @Between(startDate = "1930-01-01", endDate = "2012-12-31", message = "{v.login.birthday}")
12. private Date birthday;
14. private String phoneNumber;
15. private String emailAddress;
16. private List<String> interests = new ArrayList<String>();
18. // getter and setter
19. }

public class UserRegistForm implements java.io.Serializable {

	private static final long serialVersionUID = -5471272011192637665L;

	private String username;
	private String password;
	private String sex;

	@DateTimeFormat(pattern = "yyyy-MM-dd")
	// message 就是国际化文件中的key
	@Between(startDate = "1930-01-01", endDate = "2012-12-31", message = "{v.login.birthday}")
	private Date birthday;

	private String phoneNumber;
	private String emailAddress;
	private List<String> interests = new ArrayList<String>();

	// getter and setter
}

6) 效果图