[Note]Spring MVC、hibernate validator和i18n(一)

本文是对spring samples中的mvc-basic项目的一个详细的介绍，并对该项目作了一点修改，修改后的项目名字叫SpringMVCBasic。可以作为学习spring mvc的一个入门的tutorial.

 

首先说明如何获取spring samples。其实很简单，只要装好了Subversion，就可以在Windows的控制台中用下面的命令就可以从SpringSource的官方网站上把spring samples下载到当前路径下的spring-samples文件夹中：
svn co https://src.springframework.org/svn/spring-samples spring-samples

 

该项目的目录结构如下：
SpringMVCBasic
    META-INF
    styles
    WEB-INF
        classes
        lib
        messages
        spring
        views
        urlrewrite.xml
        web.xml

 

在文件夹lib中包含的库文件有：

org.springframework.asm-3.0.1.RELEASE.jar org.springframework.beans-3.0.1.RELEASE.jar org.springframework.context-3.0.1.RELEASE.jar org.springframework.core-3.0.1.RELEASE.jar org.springframework.expression-3.0.1.RELEASE.jar org.springframework.web-3.0.1.RELEASE.jar org.springframework.web.servlet-3.0.1.RELEASE.jar	spring的核心库
commons.fileupload-1.2.0.jar commons.io-1.4.0.jar commons.logging-1.1.1.jar	fileupload和io是用于文件上传的库，在本项目用不到 logging是实现spring使用的日志功能的库
jstl-api-1.2.jar jstl-impl-1.2.jar	jstl标签库
urlrewrite-3.2.0.jar	urlrewrite使用的库
javax.annotation-1.0.0.jar	JSR-250库。该项目并没有使用JSR-250中的标记，如@Resource等，所以本项目可以不需要该库
javax.validation-1.0.0.GA.jar	JSR-303库。该项目使用JSR-303中的标记来完成validation
hibernate-validator-4.0.2.GA.jar log4j-1.2.14.jar slf4j-api-1.5.6.jar slf4j-log4j12-1.5.6.jar	hibernate validator库。hibernate validator完整地实现了JSR-303，是实现validation的最佳选择。后面三个文件是hibernate validator使用的日志系统
joda.time-1.6.0.jar	除了JSR-303，本项目还使用了Spring自带的标记来对日期型数据格式进行验证，joda.time是默认的实现该验证功能的库

 

本文先从项目的配置文件开始：

web.xml:
<?xml version="1.0" encoding="UTF-8"?> <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> <filter> <filter-name>characterEncodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>UTF-8</param-value> </init-param> <init-param> <param-name>forceEncoding</param-name> <param-value>true</param-value> </init-param> </filter> <filter> <filter-name>UrlRewriteFilter</filter-name> <filter-class>org.tuckey.web.filters.urlrewrite.UrlRewriteFilter</filter-class> </filter> <filter-mapping> <filter-name>characterEncodingFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>UrlRewriteFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <servlet> <servlet-name>Spring MVC Dispatcher Servlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/spring/app-config.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Spring MVC Dispatcher Servlet</servlet-name> <url-pattern>/app/*</url-pattern> </servlet-mapping> </web-app>

其中，org.springframework.web.filter.CharacterEncodingFilter被用来对request和response中的编码强制规定为UTF-8，由于本人是在Ubuntu9.10上使用NetBeans IDE 6.8进行的开发，而且操作系统没有安装中文语言包，所以输入的中文都会被编码为UTF-8，所以对本项目作了此配置。如果有的朋友在运行这个项目后发现有乱码，可以尝试不配置characterEncodingFilter。
org.tuckey.web.filters.urlrewrite.UrlRewriteFilter是用来对用户在访问网站时使用的URL地址进行，使用WEB-INF下的urlrewrite.xml文件进行配置。
org.springframework.web.servlet.DispatcherServlet就是Spring中用于将请求分发给控制器的中心servlet，web.xml中显式地对其Spring配置文件的位置进行了说明，在/WEB-INF/spring目录下的app-config.xml文件。如果不进行说明，那么DispatcherServlet默认使用的配置文件是WEB-INF目录下的XXX-servlet.xml文件，其中的XXX表示DispatcherServlet在web.xml中的servlet-name，如果是这种情况，servlet-name的值最好是一个单词。

下面是urlrewrite.xml文件的内容：
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE urlrewrite PUBLIC "-//tuckey.org//DTD UrlRewrite 3.0//EN" "http://tuckey.org/res/dtds/urlrewrite3.0.dtd"> <urlrewrite default-match-type="wildcard"> <rule> <from>/images/**</from> <to>/images/$1</to> </rule> <rule> <from>/scripts/**</from> <to>/scripts/$1</to> </rule> <rule> <from>/styles/**</from> <to>/styles/$1</to> </rule> <rule> <from>/**</from> <to>/app/$1</to> </rule> <outbound-rule> <from>/app/**</from> <to>/$1</to> </outbound-rule> </urlrewrite>

 

前文提到，本项目的Spring配置文件在/WEB-INF/spring目录下的app-config.xml，下面是该文件的内容：
<?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" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd"> <context:component-scan base-package="bit.tmore.felix.spring.mvcbasic" /> <bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource"> <property name="basename" value="/WEB-INF/messages/messages" /> <property name="cacheSeconds" value="0" /> </bean> <import resource="mvc-config.xml" /> </beans>

component-scan是对指定包(在这里是bit.tmore.felix.spring.mvcbasic)中所有标记有@Componet, @Controller, @Service, @Repository和@Configuration的类进行自动检测、实例化和装配。
org.springframework.context.support.ReloadableResourceBundleMessageSource被用来绑定资源，通常是指.properties文件，属性basename指定了.properties文件所在的位置和名字，本项目的.properties文件是在/WEB-INF/message/目录下的messages*.properties，这里的*是Locale代号，如_zh、_en、_de等，具体的文件内容将在本文的下一节说明。

 

app-config.xml还导入了与其在同一目录下的mvc-config.xml文件，mvc-config.xml文件内容如下：
<?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:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"> <mvc:annotation-driven /> <mvc:view-controller path="/" view-name="welcome"/> <mvc:interceptors> <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor" /> </mvc:interceptors> <bean id="localeResolver" class="org.springframework.web.servlet.i18n.CookieLocaleResolver" /> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/views/"/> <property name="suffix" value=".jsp"/> </bean> </beans>

<mvc:annotation-driven />功能很强大，根据Spring参考文档，mvc:annotation-driven提供的功能有：

• 将org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping和org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter在WebApplicationContext中进行注册，而正是这两个bean完成了把request分配给标注有@Controller的控制器。
• 支持数据绑定过程中的类型转换服务
• 支持数字、日期、时间等数据的格式化
• 支持使用JSR-303的数据验证功能
• 支持XML和JSON的读写

mvc:view-controller的是在WebApplicationContext中注册org.springframework.web.servlet.mvc.ParameterizableViewController，该bean的功能是直接将请求导向到指定的view，而不需要控制器的参与。例如本例直接把用户对“/”的请求导向到名字为welcome的view，由该view产生response

 

org.springframework.web.servlet.i18n.LocaleChangeInterceptor和org.springframework.web.servlet.i18n.CookieLocaleResolver是Spring中解决i18n(internationalization)的两种方案。LocaleChangeInterceptor被用来根据request中的参数来改变Locale，默认使用的参数名是local，也可以指定参数名，例如
<bean id="localeChangeInterceptor" class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor"> <property name="paramName" value="siteLanguage"/> </bean> 
就指定参数名为siteLanguage。CookieLocaleResolver是使用客户端的cookie值来确定Locale.

 

org.springframework.web.servlet.view.InternalResourceViewResolver是用来根据view的名字来寻找应当被解析的页面或资源，本例是根据view的名字从/WEB-INF/views/文件夹下寻找XXX.jsp文件，其中XXX就是view的名字。例如，前文提到用户对“/”的请求会被导向到名字为welcome的view，那么/WEB-INF/views/文件夹下的welcome.jsp文件就会被解析后展现给客户端。关于welcome.jsp文件的内容将在下一节介绍。

 

本节最后要说明的是项目中的styles文件夹中的内容。SpringMVCBasic项目是直接将mvc-basic项目的styles文件夹下的内容拷贝过来，没有作任何修改。