Spring MVC 静态资源处理与拦截策略-优快云博客

本文链接：https://blog.youkuaiyun.com/cws1214/article/details/52502504

本文介绍了如何在Spring MVC中处理静态资源访问，探讨了两种解决方案：一是利用web.xml和DispatcherServlet配置，通过默认servlet处理静态资源；二是Spring MVC自处理并提供优化。文中还提醒了在配置时避免错误导致堆栈溢出的问题，并给出了实际应用中的拦截器配置示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

静态资源访问映射：

在前几年的web开发中，url通常是以.do、.action、.xhtml等等作为结尾，现在是Rest的时代，这样的url显得非常ugly。老版本的Spring MVC不能很好的处理静态资源，所以在web.xml中通常配置DispatcherServlet的url-pattern类似.do、.action这种。因为如果请求映射配置成/的话，Spring MVC将拦截所有的请求（当然包括静态资源的请求），交由Controller处理，显然静态资源的请求到了Controller那里必然会导致no handler mapping的错误。

那么怎么样在配置请求映射为\的情况下，让Spring MVC能拦截所有请求，同时将静态资源的请求交给web服务器来处理呢？在Spring3.0的版本中，Spring的团队给出了两种解决方案。

web.xml中DispatcherServlet配置

<servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>

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

通过上面的配置，让Spring MVC拦截所有的请求。

方案一：`<mvc:default-servlet-handler />`

在springmvc-servlet.xml中配置了<mvc:default-servlet-handler />之后，将在Spring MVC的context中定义一个org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler类，这个类会检查每一个进入DispatcherServlet的url，如果是静态资源的请求，就将该请求转发给web服务器默认的servlet处理，如果是正常的业务请求则交由DispatcherServlet处理。

上文提到web服务器默认的servlet，一般的web服务器默认servlet命名为“default”，因此DefaultServletHttpRequestHandler能找到它并将静态资源请求转发给它处理，如果你所使用的web服务器默认的servlet名称不是“default”，可以通过default-servlet-name属性来指定：

1	<mvc:default-servlet-handler default-servlet-name="xxx" />

附Tomcat的默认servlet命名，tomcat的默认servlet命名可以在{TOMCAT_HOME_DIR}/conf/web.xml中找到：

<servlet>
    <servlet-name>default</servlet-name>
    <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
    <init-param>
        <param-name>debug</param-name>
        <param-value>0</param-value>
    </init-param>
    <init-param>
        <param-name>listings</param-name>
        <param-value>false</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

方案二：`<mvc:resources />`

<mvc:default-servlet-handler />将静态资源请求交给web服务器默认servlet处理，而<mvc:resources />更牛逼，由Spring MVC自行处理静态资源请求，并且提供一些优化的手段。

<mvc:resources />允许将静态资源存放在任意的位置，WEB-INF，类路径等等，通过location属性指定静态资源的位置即可，打破了传统web容器静态资源只能放在根路径下的限制。

而且，<mvc:resources />根据Google page speed,yahoo yslow等浏览器优化原则对静态资源请求进行优化。比如可以通过cacheSeconds属性指定静态资源的缓存时间，充分利用客户端浏览器的缓存来提升响应能力，在response中根据配置设置响应报文头属性。

在springmvc-servlet.xml中配置如下：

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

以上配置将web根路径映射为resources路径。假如根路径下有images,js目录，images里面有1.jpg,js里面有index.js等文件，则可以通过/resources/images/1.jpg和/resources/js/index.js访问这两个静态资源。

实践

在实践中，方案一中的default-servlet-name千万不可配置错误，否则将会报错：

1
2
3

Caused by:

org.springframework.web.util.NestedServletException: Request processing failed; nested exception is java.lang.IllegalStateException: A RequestDispatcher could not be located for the default servlet 'dsa'

如果将default-servlet-name和我们web.xml中的servlet-name混为一谈的话，将default-servlet-name设置为servlet-name，将会出现java.lang.StackOverflowError的堆栈溢出错误。

拦截器配置:

web.xml设置：（/拦截所有请求）

<servlet>
    <servlet-name>dispatcher</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/dispatcher.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
 
<servlet-mapping>
    <servlet-name>dispatcher</servlet-name>
    <!-- 所有的的请求，都会被DispatcherServlet处理 -->
    <url-pattern>/</url-pattern>
</servlet-mapping>

spring MVC 配置文件拦截规则设置（没有匹配的将不会拦截）：

<!--配置拦截器, 多个拦截器,顺序执行 -->  
    <mvc:interceptors>    
        <mvc:interceptor>    
            <!-- 匹配的是url路径， 如果不配置或/**,将拦截所有的Controller -->  
            <mvc:mapping path="/" />  
            <mvc:mapping path="/account/**" />  <!-- 拦截用户路径 -->
            <mvc:mapping path="/image/**" />  <!-- 拦截图片管理路径 -->
            <mvc:mapping path="/upload/**" />  <!-- 拦截图片下载路径 -->
            <bean class="com.wzw.interceptor.LoginInterceptor"></bean>    <!-- 自定义拦截器路径 -->
        </mvc:interceptor>  
        <!-- 当设置多个拦截器时，先按顺序调用preHandle方法，然后逆序调用每个拦截器的postHandle和afterCompletion方法 -->  
    </mvc:interceptors>

拦截器代码：

package com.wzw.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import com.wzw.entity.Account;
public class LoginInterceptor extends HandlerInterceptorAdapter{
    /**  
     * 在业务处理器处理请求之前被调用  
     * 如果返回false  
     *     从当前的拦截器往回执行所有拦截器的afterCompletion(),再退出拦截器链 
     * 如果返回true  
     *    执行下一个拦截器,直到所有的拦截器都执行完毕  
     *    再执行被拦截的Controller  
     *    然后进入拦截器链,  
     *    从最后一个拦截器往回执行所有的postHandle()  
     *    接着再从最后一个拦截器往回执行所有的afterCompletion()  
     */    
    @Override    
    public boolean preHandle(HttpServletRequest request,    
            HttpServletResponse response, Object handler) throws Exception { 
        String requestUri = request.getRequestURI(); //请求完整路径，可用于登陆后跳转
        String contextPath = request.getContextPath();  //项目下完整路径
        String url = requestUri.substring(contextPath.length()); //请求页面
        System.out.print("发生拦截...");
        System.out.println("来自："+requestUri+"的请求");
        Account user =  (Account)request.getSession().getAttribute("account");   
        if(user == null){  //判断用户是否存在，不存在返回登录界面，继续拦截，存在通过拦截，放行到访问页面
            /**
             * 拦截目录下请求，是否为ajax请求
             *   是：无需登录，直接访问（因为我是用于首页的ajax登录请求）
             *   否：跳转至登录界面
             */
            if (request.getHeader("x-requested-with") != null && request.getHeader("x-requested-with").equalsIgnoreCase("XMLHttpRequest")){ 
                //如果是ajax请求响应头会有，x-requested-with  
                System.out.print("发生ajax请求...");
                return true;
                //response.setHeader("sessionstatus", "timeout");//在响应头设置session状态  
            }else{
                System.out.print("返回主页...");
                request.getRequestDispatcher("/index.do").forward(request, response);//转发到登录界面 
            }  
            return false;  
        }else  
            return true;     
    }    
    
    /** 
     * 在业务处理器处理请求执行完成后,生成视图之前执行的动作    
     * 可在modelAndView中加入数据，比如当前时间 
     */  
    @Override    
    public void postHandle(HttpServletRequest request,    
            HttpServletResponse response, Object handler,    
            ModelAndView modelAndView) throws Exception {     
        if(modelAndView != null){  //加入当前时间    
            modelAndView.addObject("var", "测试postHandle"); 
        }    
    }    
    
    /**  
     * 在DispatcherServlet完全处理完请求后被调用,可用于清理资源等   
     *   
     * 当有拦截器抛出异常时,会从当前拦截器往回执行所有的拦截器的afterCompletion()  
     */    
    @Override    
    public void afterCompletion(HttpServletRequest request,    
            HttpServletResponse response, Object handler, Exception ex)    
            throws Exception {    
    }    
}