Spring MVC 的 xml 配置详解

Spring mvc 配置

配置DispatcherServlet 前端控制器

DispatcherServlet是前端控制器设计模式的实现，提供Spring Web MVC的集中访问点，而且负责职责的分派，而且与Spring IoC容器无缝集成，从而可以获得Spring的所有好处。
DispatcherServlet拦截匹配的请求，把拦截下来的请求，依据某某规则分发到目标Controller(我们写的Action)来处理，拦截匹配规则需要自定义。

在web.xml中配置DispatcherServlet

<servlet>
     <servlet-name>mvc-dispatcher</servlet-name>
     <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
     <load-on-startup>1</load-on-startup>
 </servlet>
 <servlet-mapping>
     <servlet-name>mvc-dispatcher</servlet-name>
     <url-pattern>/*</url-pattern>
 </servlet-mapping>

• servlet-name 拦截器名称
• load-on-startup 容器初始化时启动拦截器
• url-pattern 拦截路径

DispatcherServlet默认使用WebApplicationContext作为上下文，Spring默认配置文件为“/WEB-INF/[servlet名字]-servlet.xml”,
所以本例中的配置文件路径为“/WEB-INF/mvc-dispatcher-servlet.xml”

DispatcherServlet也可以配置自己的初始化参数，覆盖默认配置：

参数	描述
contextClass	实现WebApplicationContext接口的类，当前的servlet用它来创建上下文。如果这个参数没有指定， 默认使用XmlWebApplicationContext。
contextConfigLocation	WebApplicationContext 上下文的配置xml，支持“*”通配和“,”分割来配置多个配置文件
namespace	WebApplicationContext命名空间。默认值是[server-name]-servlet。

因此我们可以通过添加初始化参数来加载指定的配置文件，此处配置文件路径为“/spring-servlet-config.xml”

<servlet>
    <servlet-name>chapter2</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring-mvc.xml</param-value>
    </init-param>
</servlet>

配置Spring MVC 上下文

spring-mvc.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"  
 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.2.xsd  
      http://www.springframework.org/schema/context   
      http://www.springframework.org/schema/context/spring-context-3.2.xsd  
      http://www.springframework.org/schema/mvc  
      http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd">  
	<!-- 静态资源映射,可以配置多个 -->	
	<mvc:resources mapping="/resources/**" location="/resources/" />
	<mvc:resources mapping="/src/**" location="/src/" />
	<mvc:default-servlet-handler />
	
	<!-- controller扫描 -->	
	<context:component-scan base-package="com.sas.webapp.web" />
	<context:component-scan base-package="com.sas.webapp.wap" />
	<context:component-scan base-package="com.sas.core.controller" />
	
	<!-- 开启注解扫描-->	
	<mvc:annotation-driven>
		<mvc:message-converters>
			<bean class="org.springframework.http.converter.FormHttpMessageConverter" />
		</mvc:message-converters>
	</mvc:annotation-driven>
	<!-- 未解读-->	
	<bean class="org.springframework.web.servlet.view.BeanNameViewResolver">
		<property name="order" value="1" />
	</bean>

	<bean id="viewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
		<property name="order" value="2" />
		<property name="suffix" value=".ftl" />
		<property name="contentType" value="text/html; charset=UTF-8" />
		<property name="exposeRequestAttributes" value="true" />
		<property name="exposeSessionAttributes" value="true" />
		<property name="exposeSpringMacroHelpers" value="true" />
		<property name="cache" value="true" />
	</bean>

	<bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
		<property name="templateLoaderPath" value="/WEB-INF/views/" />
		<property name="freemarkerSettings">
			<props>
				<prop key="template_update_delay">0</prop><!-- 10 minutes -->
				<prop key="default_encoding">UTF-8</prop>
				<prop key="locale">zh_cn</prop>
				<prop key="number_format">0.##########</prop>
				<prop key="url_escaping_charset">UTF-8</prop>
				<!-- <prop key="template_exception_handler"> com.sas.backend.util.FreeMarkerExceptionHandler 
					</prop> -->
			</props>
		</property>
	</bean>

	<bean name="/hessianservice"  class="org.springframework.remoting.caucho.HessianServiceExporter">
         <property name="service" ref="hessianServerService"/>
         <property name="serviceInterface" value="com.sas.core.service.HessianService"/>
    </bean>
    
	<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"></bean>

	<bean id="json" class="org.springframework.web.servlet.view.json.MappingJackson2JsonView">
		<property name="disableCaching" value="true" />
	</bean>

	<bean id="freemarkTemplateResolver"   class="com.sas.core.spring.FreemarkTemplateResolver"  />
	
</beans>

1.Spring MVC静态文件处理

如何你的DispatcherServlet拦截*.do这样的URL，就不存在访问不到静态资源的问题。
问题是现在基本不会使用.do或者.jsp这样的URL后缀，通常为以下两种

• < url-pattern>/</url-pattern> 会匹配到/login这样的路径型url，不会匹配到模式为*.jsp这样的后缀型url
• < url-pattern>/*</url-pattern> 会匹配所有url：路径型的和后缀型的url(包括/login,.jsp,.js和*.html等)

如果你的DispatcherServlet拦截“/”，或者更甚至拦截“/*”，那么静态资源也会被拦截，报404错误
为可以正常访问静态文件，提供以下3中解决方案

方案一：激活Tomcat的defaultServlet来处理静态文件

<servlet-mapping>     
    <servlet-name>default</servlet-name>    
    <url-pattern>*.jpg</url-pattern>       
</servlet-mapping>      
<servlet-mapping>         
    <servlet-name>default</servlet-name>      
    <url-pattern>*.js</url-pattern>      
</servlet-mapping>      
<servlet-mapping>          
    <servlet-name>default</servlet-name>         
    <url-pattern>*.css</url-pattern>        
</servlet-mapping> 

要配置多个，每种文件配置一个
要写在DispatcherServlet的前面， 让 defaultServlet先拦截，这个就不会进入spring了

各大web应用服务器的DefaultServlet的名字

服务器	默认拦截器名
Tomcat, Jetty, JBoss, and GlassFish	“default”
Google App Engine	“_ah_default”
Resin	“resin-file”
WebLogic	“FileServlet”
WebSphere	“SimpleFileServlet”

方案二： 在spring3.0.4以后版本提供了＜mvc:resources＞标签

mvc:resources 的使用方法：

<!-- 对静态资源文件的访问 -->      
<mvc:resources mapping="/images/**" location="/images/" />   

• mapping：映射到ResourceHttpRequestHandler进行处理
• location：指定静态资源的位置.可以是web application根目录下、jar包里，这样可以把静态资源压缩到jar包中
• cache-period：可以使得静态资源进行web cache cop

如果出现下面的错误，可能是没有配置<mvc:annotation-driven />的原因。
报错

WARNING: No mapping found for HTTP request with URI [/mvc/user/findUser/lisi/770] 
in DispatcherServlet with name 'springMVC'

使用<mvc:resources/>元素,把mapping的URI注册到SimpleUrlHandlerMapping的urlMap中,
key为mapping的URI pattern值,而value为ResourceHttpRequestHandler,
这样就巧妙的把对静态资源的访问由HandlerMapping转到ResourceHttpRequestHandler处理并返回,所以就支持classpath目录,jar包内静态资源的访问.
另外需要注意的一点是,不要对`SimpleUrlHandlerMapping设置defaultHandler.因为对static uri的defaultHandler就是ResourceHttpRequestHandler,否则无法处理static resources request.

方案三 ，使用＜mvc:default-servlet-handler＞标签

<mvc:default-servlet-handler/>
会把"/*" url,注册到SimpleUrlHandlerMapping的urlMap中,把对静态资源的访问由HandlerMapping转到org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler处理并返回.
DefaultServletHttpRequestHandler使用就是各个Servlet容器自己的默认Servlet.
补充说明：多个HandlerMapping的执行顺序问题：

DefaultAnnotationHandlerMapping 的order属性值是：0
<mvc:resources/ >自动注册的 SimpleUrlHandlerMapping 的order属性值是： 2147483646
<mvc:default-servlet-handler/>自动注册 的SimpleUrlHandlerMapping 的order属性值是： 2147483647

spring会先执行order值比较小的。当访问一个a.jpg图片文件时，先通过 DefaultAnnotationHandlerMapping来找处理器，一定是找不到的，我们没有叫a.jpg的Action。再按order值升序找，由于最后一个 SimpleUrlHandlerMapping 是匹 "/*"的，所以一定会匹配上，再响应图片。

2.Spring MVC 重要接口 HttpMessageConverter 消息解析器

在SpringMVC的 Controller层经常会用到@RequestBody和@ResponseBody，通过这两个注解，可以在Controller中直接使用Java对象作为请求参数和返回内容，而完成这之间转换作用的便是HttpMessageConverter。
源码就不贴了，这里直接开讲
HttpMessageConverter接口提供了5个方法：

• canRead：判断该转换器是否能将请求内容转换成Java对象
• canWrite：判断该转换器是否可以将Java对象转换成返回内容
• getSupportedMediaTypes：获得该转换器支持的MediaType类型
• read：读取请求内容并转换成Java对象
• write：将Java对象转换后写入返回内容

其中read和write方法的参数分别有有HttpInputMessage和HttpOutputMessage对象，这两个对象分别代表着一次Http通讯中的请求和响应部分，可以通过getBody方法获得对应的输入流和输出流。

继承体系

当前SpringMVC中已经默认提供了相当多的转换器，如上图，其中常用的有：

名称	作用	读支持MediaType	写支持MediaType
ByteArrayHttpMessageConverter	数据与字节数组的相互转换	/	application/octet-stream
StringHttpMessageConverter	数据与String类型的相互转换	text/*	text/plain
FormHttpMessageConverter	表单与MultiValueMap的相互转换	application/x-www-form-urlencoded	application/x-www-form-urlencoded
SourceHttpMessageConverter	数据与javax.xml.transform.Source的相互转换	text/xml和application/xml	text/xml和application/xml
MarshallingHttpMessageConverter	使用Spring的Marshaller/Unmarshaller转换XML数据	text/xml和application/xml	text/xml和application/xml
MappingJackson2HttpMessageConverter	使用Jackson的ObjectMapper转换Json数据	application/json	application/json
MappingJackson2XmlHttpMessageConverter	使用Jackson的XmlMapper转换XML数据	application/xml	application/xml
BufferedImageHttpMessageConverter	数据与java.awt.image.BufferedImage的相互转换	Java I/O API支持的所有类型	Java I/O API支持的所有类型

spring提供了标签<mvc:annotation-driven/>用来开启注解配置，
在讲解mvc:annotation-driven/这个配置之前，我们先了解下Spring的消息转换机制。@ResponseBody这个注解就是使用消息转换机制，最终通过json的转换器转换成json数据的。

下面开始分析<mvc:annotation-driven/>这句配置:
配置了这个标签后，Spring分别实例化了RequestMappingHandlerMapping，ConfigurableWebBindingInitializer，RequestMappingHandlerAdapter等诸多类。

其中RequestMappingHandlerMapping和RequestMappingHandlerAdapter这两个类比较重要。

RequestMappingHandlerMapping处理请求映射的，处理@RequestMapping跟请求地址之间的关系。
RequestMappingHandlerAdapter是请求处理的适配器，也就是请求之后处理具体逻辑的执行，关系到哪个类的哪个方法以及转换器等工作，这个类是我们讲的重点，其中它的属性messageConverters是接下来的重点。

私有方法:getMessageConverters

从代码中我们可以，RequestMappingHandlerAdapter设置messageConverters的逻辑：

1.如果mvc:annotation-driven节点有子节点message-converters，那么它的转换器属性messageConverters也由这些子节点组成。

message-converters的子节点配置如下：

<mvc:annotation-driven>
  <mvc:message-converters>
    <bean class="org.example.MyHttpMessageConverter"/>
    <bean class="org.example.MyOtherHttpMessageConverter"/>
  </mvc:message-converters>
</mvc:annotation-driven>

2.message-converters子节点不存在或它的属性register-defaults为true的话，加入其他的转换器：ByteArrayHttpMessageConverter、StringHttpMessageConverter、ResourceHttpMessageConverter等。

我们看到这么一段：
spring支持jackson和gson解析

HttpMessageConverter接口就是Spring提供的http消息转换接口。

所以使用<mvc:annotation-driven>开启注解扫描后，就自动配置了这些个消息解析器，如果要自定义消息解析器，可以这样配置

<!-- 开启注解扫描->	
<mvc:annotation-driven>
	<mvc:message-converters>
		<bean class="org.springframework.http.converter.FormHttpMessageConverter" />
	</mvc:message-converters>
</mvc:annotation-driven>

然而个人感觉还是多此一举

剩余未解读

Spring 配置 properties的多种方法

1.PropertyPlaceholderConfigurer

PropertyPlaceholderConfigurer是个bean工厂后置处理器的实现，也就是 BeanFactoryPostProcessor接口的一个实现。PropertyPlaceholderConfigurer可以将上下文（配置文 件）中的属性值放在另一个单独的标准Java Properties文件中去。在 xml 文件中用${key}替换指定的properties文件中的值。这样的话，只需要对properties文件进 行修改，而不用对 xml 配置文件进行修改。

配置PropertyPlaceholderConfigurer的bean对象，依赖注入properties

方法一：

<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="locations">
        <value>classpath:shop.properties</value>
    </property>
    <property name="properties">
        <value>classpath:mybatis.properties</value>
    </property>
</bean>

方法二：
其中order属性代表其加载顺序，而ignoreUnresolvablePlaceholders为是否忽略不可解析的 Placeholder，如配置了多个PropertyPlaceholderConfigurer，则需设置为true

<bean id="propertyConfigurer"  class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
     <property name="order" value="0"/>
     <property name="ignoreUnresolvablePlaceholders" value="true"/>
     <property name="locations">
         <list>
             <value>classpath:shop.properties</value>
             <value>classpath:mybatis.properties</value>
         </list>
     </property>
 </bean>

2.＜context:property-placeholder＞标签

Spring3中提供了一种简便的方式来注入properties文件
就是<content:property-placeholder>标签
只需要在spring的配置文件中添加一句：

<context:property-placeholder ignore-unresolvable="true" location="classpath:myshop.properties"/>

如果要注入多个properies，可以加入通配符来实现

<context:property-placeholder location="classpath:conf/conf*.properties"/>  

或者在路径之间加上逗号

<context:property-placeholder location="classpath:conf/myshop.properties，classpath:conf/mybatis.properties"/>  

3.注意点

配置多个properties文件时，如果文件内有相同的属性，不同配置方式得到的结果不同

• 使用PropertyPlaceholderConfigurer配置的，先配的文件的同名属性会覆盖后配的
• 使用<context:property-placeholder>配置的，后配的文件的同名属性会覆盖前配的

最好不要在properties文件中配置相同的属性名!

PS:博文仅作为个人学习笔记，如有错误欢迎指正~
更多内容详见：笔记分类导航目录