菜鸟之路——Spring MVC（八）静态资源

  一、前言

   在SpringMVC中常用的就是Controller与View。但是我们常常会需要访问静态资源，如html,js,css，image等。如果将DispatcherServlet请求映射配置为”/”，则Spring MVC将捕获Web容器所有的请求，包括静态资源的请求，Spring MVC会将它们当成一个普通请求处理，因此找不到对应处理器将导致错误。如配置文件如下：

 

<!-- Processes application requests -->
    <servlet>
        <servlet-name>appServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring/appServlet/servlet-context.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
        
    <servlet-mapping>
        <servlet-name>appServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

 

  部署项目后程序加载或用浏览器访问时出现类似的警告， WARN [org.springframework.web.servlet.PageNotFound] -<No mapping found for HTTP request with URI [/sandDemo001/images/1.jpg] in DispatcherServlet with name 'spring'>。
  原因在于：<servlet-mapping>的<url-pattern>/</url-pattern>把所有的请求都交给spring去处理了，而所有available的请求url都是在Constroller里使用类似@RequestMapping(value = "/login/{user}", method = RequestMethod.GET)这样的注解配置的，这样的话对js/css/jpg/gif等静态资源的访问就会得不到。

  二、访问静态资源的解决方法

  前两种方法首先要在声明 beans的xmlns里面加入 xmlns:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation=http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd （根据版本决定）

 采用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名称" /> 

  要注意的是：配置文件中必须有添加：

<mvc:annotation-driven/>

 

  否则发现访问@RequestMapping("/path1/path2")不能访问，报错WARNING: No mapping found for HTTP request with URI [/mvc/user/findUser/lisi/770] in DispatcherServlet with name 'springMVC'。原因在于：当两种标签都没有的时候，框架默认注册的有AnnotationMethodHandlerAdapter这个bean，能够处理@RequestMapping这个注解，但是只配置了<mvc:default-servlet-handler/>时，会缺少AnnotationMethodHandlerAdapter这个bean，进而无法进行访问路径的映射。当两种标签都有的时候，<mvc:annotation-driven/>会注册一个RequestMappingHandlerAdapter的bean，这个bean能够处理@RequestMapping这个注解。

  采用mvc:resources

  mvc:default-servlet-handler 将静态资源的处理经由Spring MVC框架交回Web应用服务器处理。而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相应状态码，提示客户端使用浏览器缓存的数据，而非将静态资源的内容输出到客户端，以充分节省带宽，提高程序性能。

  需要注意的是，使用<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.

  配置时，可在springMVC-servlet中添加如下配置：

<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 进行引用。

  补充说明：多个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 是匹配 "/**"的，所以一定会匹配上，就可以响应图片。

  使用前两种方法在访问静态资源时，如果有匹配的全局拦截器，就会走拦截器。如果在拦截中实现权限检查，要注意过滤这些对静态文件的请求。

 用tomcat自带的defaultServlet

  比如，在web.xml里添加如下的配置：

 

<servlet-mapping>
     <servlet-name>default</servlet-name>
     <url-pattern>*.css</url-pattern>
</servlet-mapping>
 
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.gif</url-pattern>
 </servlet-mapping>
    
 <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>

  要写在DispatcherServlet的前面，让 defaultServlet先拦截请求，这样请求就不会进入Spring了。  

 

  主要还是推荐前两种方法。

 

SpringMVC 拦截器不拦截静态资源的方法：https://www.cnblogs.com/mophy/p/8465598.html