Spring MVC 静态文件处理

Spring MVC 静态文件处理

问题描述

在部署Spring MVC项目的时候，项目启动了，但是访问不了静态文件。

项目配置

web.xml配置

<servlet>
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
          <param-name>contextConfigLocation</param-name>
          <param-value>classpath*:spring-configs/applicationContext-servlet.xml</param-value>
       </init-param>
       <multipart-config>
         <max-file-size>20M</max-file-size>
         <max-request-size>20M</max-request-size>
         <file-size-threshold>100K</file-size-threshold>
       </multipart-config>
    </servlet>

    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

如上配置后，在访问程序时，dispatcherServlet会拦截所有请求访问，因为在访问 .js，*.jpg等静态文件时，也会被拦截，如果不做额外的配置，是无法访问静态资源的。

解决方案

方案一： 使用各种容器的defaultServlet来处理静态文件

在web.xml文件中使用默认的servlet来处理静态文件，修改后的文件为：

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

<servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

此方案在使用jetty容器时，确实可以解决静态资源访问问题，但是如果使用其他容器，比如Resin，就会有问题，后来排查了一下原因，是由于不同容器，他们的默认servlet的名字不一致导致的，后来查了一下，各个容器对应的默认的servlet名为：

容器	默认servlet名
Tomcat, Jetty, JBoss, and GlassFish	default
Google App Engine	_ah_default
Resin	resin-file
WebLogic	FileServlet
WebSphere	SimpleFileServlet

---

方案二： 使用<mvc:default-servlet-handler/>

在相应的配置文件中添加。
<mvc:default-servlet-handler/>会把 /**url注册到SimpleUrlHandlerMapping类中的 handlerMap 中，如图：

然后dispatcherServlet在根据请求路径获取相应的handler时，会根据最佳匹配原则，

获取到相应的处理类DefaultServletHttpRequestHandler

然后把对静态资源的访问由 HandlerMapping 转到 org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler 处理并返回。
DefaultServletHttpRequestHandler 使用就是各个Servlet 容器自己的默认 Servlet。

备注：上图使用的是jetty容器，因为默认servlet名为default

---

方案三： 使用<mvc:resources/>

<mvc:resources mapping="/static/**" location="/static/"/>

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

如果出现下面的错误，可能是没有配置 <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的handlerMap 中，key 为 mapping 的 URI pattern值,而 value为 ResourceHttpRequestHandler，这样就巧妙的把对静态资源的访问由 HandlerMapping 转到 ResourceHttpRequestHandler 处理并返回，所以就支持 classpath 目录, jar 包内静态资源的访问。

另外需要注意的一点是,不要对 SimpleUrlHandlerMapping 设置 defaultHandler。因为对 static uri 的 defaultHandler 就是ResourceHttpRequestHandler，否则无法处理static resources request.

备注：<mvc:resources/>的编码方式为：

@Configuration
@EnableWebMvc
public class WebConfig extends WebMvcConfigurerAdapter {
    @Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/static/**")
                .addResourceLocations("/static/");
}