SpringMVC实体验证

       随着Rest服务的不断流行，Rest请求地址被捕获后，可以通过Rest地址直接向后台发送请求。因此后台数据验证就有了必要性。hibernate validator是对JSR 349 - Bean Validation 1.1验证API的一个实现。以下是基于SpringMVC和hibernate validator对后台数据验证的实现。

1.配置Spring MVC文件

 

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:p="http://www.springframework.org/schema/p"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
            http://www.springframework.org/schema/context
         	http://www.springframework.org/schema/context/spring-context-4.0.xsd
         	http://www.springframework.org/schema/mvc
        	http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
    <!-- 配置需要扫描的类，不扫描用@Service或Repository声明的类，统一使用ApplicationContext中的 -->
    <context:component-scan base-package="com">
    	<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>
    	<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Repository"/>
    </context:component-scan>
    <!-- 按照entity的名称分别指定国际化文件的位置-->
	<bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource"> 
       <property name="defaultEncoding" value="UTF-8"/> 
       <property name="basenames"> 
           <bean class="com.MessagesGenerator" factory-method="getMessagesByClassPath">
       			<constructor-arg value="classpath:messages/message*.xml"/>
       		</bean> 
       </property> 
   </bean>
   <!-- setting validation implementor,actually HibernateValidator is java validation interface default implementor-->
   <bean id="globalValidator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"> 
       <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/> 
       <property name="validationMessageSource" ref="messageSource"/> 
   </bean>
    <mvc:annotation-driven validator="globalValidator">
    	<mvc:message-converters register-defaults="true">
			<!-- 将StringHttpMessageConverter的默认编码设为UTF-8 -->
			<bean class="org.springframework.http.converter.StringHttpMessageConverter">
		    	<constructor-arg value="UTF-8" />
			</bean>
			<!-- 将Jackson2HttpMessageConverter的默认格式化输出设为true -->
			<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <property name="prettyPrint" value="true"/>
            </bean>			
  		</mvc:message-converters>
    </mvc:annotation-driven>
    <!-- 容器默认的DefaultServletHandler处理 所有静态内容与无RequestMapping处理的URL-->
	<mvc:default-servlet-handler />
    <!-- 根据类型查找HandlerMapping -->
    <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping" />
	<!-- 返回逻辑视图解析，将逻辑视图名称解析为文件路径 -->
	<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
		<property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
		<property name="prefix" value="/" />
		<property name="suffix" value=".jsp"></property>
	</bean>
</beans>

使用MessagesGenerator扫描路径：classpath:messages/message*.xml下，所有以message开头的国际化文件。

package com;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.util.StringUtils;
public class MessagesGenerator {
	/**
	 * 使用ano注解获取所有的文件路径
	 * @param path
	 * @return
	 * @throws IOException
	 */
	public static List<String> getMessagesByClassPath(String path) throws IOException{
		if(!StringUtils.hasLength(path)||!path.startsWith("classpath")){
			return new ArrayList<String>();
		}
		
		List<String> messages = new ArrayList<String>() ;
		ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver() ;
		Resource[] resources = resolver.getResources(path) ;
		String tempPath = null ;
		for (Resource resource : resources) {
			if(!resource.getFile().exists()){
				continue;
			}
			tempPath = resource.getFile().getPath() ;
			tempPath = tempPath.substring(tempPath.indexOf("classes\\")+8,tempPath.lastIndexOf(".")) ;
			messages.add("classpath:"+tempPath) ;
		}
		return messages ;
	}
}

 

 2.Customer实体对象

 

package com.entity;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.validation.constraints.NotNull;
import com.fasterxml.jackson.annotation.JsonFormat;

@Entity
public class Customer {
	//不使用自动生成ID的方式
	@Id
	private int id ;
	
	@NotNull(message="{costomer_name_not_null}")
	private String name ;
	
	private int age ;
	
	//使用jackson的json注解声明Date类型的格式
	@JsonFormat(pattern="yyyy-MM-dd")
	private Date birthday ;
	
	@Column(name="bank_deposit")
	private double bankDeposit ;
	
        .....省略set和get方法
}

3.国际化提示文件，message_customer.xml放到class目录的bundle文件夹下，内容如下：

<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">  
<properties>  
    <comment>客户信息</comment>  
    <entry key="costomer_name_not_null">不能为空</entry>
</properties> 

 使用xml文件，而不是用properties文件原因：1.xml文件在操作系统中更容易编辑；2.xml文件可读性比较强。3.将xml文件根据实体名称分别存储，便于维护。

 

4.Controller类

package com.controller;
import javax.validation.Valid;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import com.entity.Customer;

@Controller
@RequestMapping("/customer/")
public class CustomerController {
	
	/**
	 * 使用@Valid注解声明需要验证的实体类，BindingResult封装了验证的结果
	 */
	@RequestMapping("validate")
	@ResponseBody
	public String validateCustomer(@Valid Customer customer,BindingResult bindingResult){
		if(bindingResult.hasErrors()){
			System.out.println("错误->"+bindingResult.getAllErrors().get(0).getDefaultMessage());
			return bindingResult.getAllErrors().get(0).getDefaultMessage() ;
		}
		
		return "OK";
	}
}

 

 Spring与hibernate validator相关reference文件见附件。