关于Spring初始化配置中的dispatcherServlet的配置问题

Posted 2020-09-30

前几年的web开发中，url通常是以.do、.action、.xhtml等等作为结尾，所以在web.xml中通常配置DispatcherServlet的url-pattern类似.do、.action结尾，这样的配置方式导致dispatcherServlet只会拦截*do或者*.action结尾，当然这样的方式不会带来任何问题，例如：

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

付出的代价就是我们的url中必然带着*.do这类东东，但是现在是Rest的时代，这样的url显得非常ugly。但如果使用如下的配置方式

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

这样的配置方式使得Spring拦截了所有请求，这样的话导致Spring在老版本的情况下无法很好的处理静态资源，例如 我们要请求URL为：http://localhost:8080/webapp/test.png，这样由于dispatcherServlet的请求映射配置成/，Spring MVC将拦截所有的请求（当然包括静态资源的请求），交由Controller处理，显然静态资源的请求到了Controller那里必然会导致no handler mapping的错误。

但是新版本的Spring框架在需要完成REST风格的URL上面做了系列改动，我们可以在配置中使用如下的配置方式，可以很好的处理静态资源了，但是在配置方面会略有改动，目前是有如下三种方式:

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

首先说明Tomcat是有一个默认的Servlet的，是配置在$catalina/conf/web.xml里面的，我们可以看到

1. <servlet>  

2.       <servlet-name>default</servlet-name>  

3.       <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>  

4.       <init-param>  

5.           <param-name>debug</param-name>  

6.           <param-value>0</param-value>  

7.       </init-param>  

8.       <init-param>  

9.           <param-name>listings</param-name>  

10.           <param-value>false</param-value>  

11.       </init-param>  

12.       <load-on-startup>1</load-on-startup>  

13.   </servlet>  

而我们的静态资源可以交由这个tomcat默认的Servlet处理，对应的我们要在本地的web.xml中配置

<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了，我想性能是最好的吧。

方案二： 在spring3.0.4以后版本提供了<mvc:resources>

<mvc:resources >的使用方法：

1. <mvc:resources location="/,classpath:/META-INF/publicResources/" mapping="/resources/**"/>  

以上配置将Web根路径"/"及类路径下 /META-INF/publicResources/ 的目录映射为/resources路径。假设Web根路径下拥有images、js这两个资源目录,在images下面有bg.gif图片，在js下面有test.js文件，则可以通过 /resources/images/bg.gif 和 /resources/js/test.js 访问这二个静态资源。 

假设WebRoot还拥有images/bg1.gif 及 js/test1.js，则也可以在网页中通过 /resources/images/bg1.gif 及 /resources/js/test1.js 进行引用

说明：<mvc:resources />更进一步，由Spring MVC框架自己处理静态资源，并添加一些有用的附加值功能。 

首先，<mvc:resources />允许静态资源放在任何地方，如WEB-INF目录下、类路径下等，你甚至可以将javascript等静态文件打到JAR包中。通过location属性指定静态资源的位置，由于location属性是Resources类型，因此可以使用诸如"classpath:"等的资源前缀指定资源位置。传统Web容器的静态资源只能放在Web容器的根路径下，<mvc:resources />完全打破了这个限制。 

其次，<mvc:resources />依据当前著名的Page Speed、YSlow等浏览器优化原则对静态资源提供优化。你可以通过cacheSeconds属性指定静态资源在浏览器端的缓存时间，一般可将该时间设置为一年，以充分利用浏览器端的缓存。在输出静态资源时，会根据配置设置好响应报文头的Expires 和 Cache-Control值。 

在接收到静态资源的获取请求时，会检查请求头的Last-Modified值，如果静态资源没有发生变化，则直接返回303相应状态码，提示客户端使用浏览器缓存的数据，而非将静态资源的内容输出到客户端，以充分节省带宽，提高程序性能。

方法3.采用<mvc:default-servlet-handler /> 

<mvc:default-servlet-handler />

在springMVC-servlet.xml中配置<mvc:default-servlet-handler />后，会在Spring MVC上下文中定义一个org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler，它会像一个检查员，对进入DispatcherServlet的URL进行筛查，如果发现是静态资源的请求，就将该请求转由Web应用服务器默认的Servlet处理，如果不是静态资源的请求，才由DispatcherServlet继续处理。

一般Web应用服务器默认的Servlet名称是"default"，因此DefaultServletHttpRequestHandler可以找到它。如果你所有的Web应用服务器的默认Servlet名称不是"default"，则需要通过default-servlet-name属性显示指定：

<mvc:default-servlet-handler default-servlet-name="所使用的Web服务器默认使用的Servlet名称" />

但是要注意几个问题：

1.第二和第三方案可以一起在项目中使用

2.第三种方案中配置了 <mvc:default-servlet-handler/> 解决了静态资源调用的问题时，而原来@RequestMapping(value="/path1") 配置的URL地址 不能正使用了，解决方案是需要在springmvc.xml 中在配置一下 <mvc:annotation-driven/> 原因如下

①. 当两种标签都没有的时候，框架默认注册的有AnnotationMethodHandlerAdapter这个bean，所以能够处理@RequestMapping这个注解。

②. 但是只配置了<mvc:default-servlet-handler/>时所注册的两个bean都不能处理@RequestMapping注解，因此无法找到相应的Controller，进而无法进行访问路径的映射，

           ③. 当两种标签都有的时候，<mvc:annotation-driven/>会注册一个RequestMappingHandlerAdapter的bean，这个bean能够处理@RequestMapping这个注解。