SpringMVC中5种放行静态资源的处理方式

SpringMVC中5种放行静态资源的处理方式

1、前言

Tomcat服务器有一个全局web配置文件web.xml，其中定义了一个名为default的DefaultServlet，其映射路径为"/"，表示可以访问任何除.jsp、.jspx结尾的文件。

当在项目中使用SpringMVC技术配置了前端控制器DispatcherServlet的请求映射路径为"/"，会优先项目的web配置环境，此时tomcat服务器中web.xml的名为default的DefaultServlet将不起作用。DispatcherServlet会过滤所有请求并通过处理器映射器进行解析，再经过处理器适配器匹配到指定的处理器进行相应处理；当请求的是一个静态资源时，请求解析的结果几乎不可能匹配任何一个有意义处理器，所以就会访问失败。（因为处理器映射的路径总是会区别于静态资源的访问路径）。

总而言之，在没经过静态资源放行的springmvc工程中，访问步骤如下：

1. 到当前工程下查找是否有匹配的DispatcherServlet的url-pattern，由于设置的路径为"/"，故而除了.jsp请求以外的请求都通过，进入处理器映射器解析请求url；
2. 根据解析结果适配处理器：
   • 若适配失败，则报404错误，资源未找到；
   • 若适配成功，则执行处理器方法并返回成功的资源；

2、3种经典方式（推荐）

SpringMVC给出了3种处理静态资源的方式。其中2种是xml的配置方式，1种是注解的配置方式。

2.1 、xml配置方式1：使用标签<mvc:resources />

在SpringMVC的核心配置文件springmvc.xml中配置（仅适用于springmvc3.0.4以后的版本）:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <context:component-scan base-package="xxx.xxx.controller"/>
    <!-- 静态资源放行
        方式1：使用标签<mvc:resources/>指定需要放行的路径映射与文件目录
    -->
    <mvc:resources mapping="/js/**" location="/js/"/>
    <mvc:resources mapping="/css/**" location="/css/"/>
    <mvc:resources mapping="/pages/**" location="/pages/"/>
    <mvc:resources mapping="/plugins/**" location="/plugins/"/>
</beans>

2.2、xml配置方式2：使用标签<mvc:default-servlet-handler />

在SpringMVC的核心配置文件springmvc.xml中配置:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <context:component-scan base-package="xxx.xxx.controller"/>
    <!-- 静态资源放行
        方式2：tomcat默认的DefaultServlet处理静态资源
        条件：必须开启mvc注解支持，即须配置<mvc:annotation-driven  />
        优先项目内的web.xml的配置，会优先执行DispatcherServlet；
        若匹配不到，则按照tomcat服务器的web.xml中设置的默认DefaultServlet（名为default）尝试访问。
    -->
    <mvc:default-servlet-handler />
    <!-- 开启mvc注解支持 -->
    <mvc:annotation-driven  />
   
</beans>

特别注意：

1. 此方式有效的前提条件是必须开启mvc注解支持，否则DispatcherServlet的映射会无效，所有的请求会按照tomcat中默认的servlet进行映射。
2. 开启mvc注解支持的方式有两种：
   • xml标签配置：在mvc核心容器springmvc.xml中配置<mvc:annotation-driven />即可。
   • 注解配置：在mvc核心容器SpringMvcConfig.java类上添加注解@EnableWebMvc即可。

2.3、注解的配置方式

SpringMVC中提供了注解配置的接口WebMvcConfigurationSupport，专门负责提供项目中需要的springmvc配置的特定功能支持，包括且不仅仅包括了静态资源放行的功能接口、拦截器接口、视图控制器接口等。开发人员只需继承此类并加载到springmvc核心容器即可。

这里定义一个SpringMvcConfigSupport类继承WebMvcConfigurationSupport类。

package com.xxx.config;

import com.yu.controller.interceptor.LoginInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

/**
 * 用于补充springmvc的配置
 * 通常用于静态资源放行、拦截器、视图控制器等的功能配置
 * 使用注解@Configuration将其标记为一个配置类，在Springmvc核心容器中可通过扫描包加载到
 */
@Configuration
public class SpringMvcConfigSupport extends WebMvcConfigurationSupport {

    @Autowired
    private HandlerInterceptor loginInterceptor;

    /**
     * 配置静态资源放行
     * 等同于在xml中配置<mvc:resources mapping="" location=""/>
     * @param registry
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
    }

}

3、其他2种方式（不推荐）

3.1、在web.xml文件中激活Tomcat的名为default的Servlet来处理静态文件（冗杂）

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

可配置多个要放行的静态资源，工程下有多少种格式的静态文件就需要配置多少个servlet映射,比较冗杂。

特别注意：

这些映射必须写在DispatcherServlet映射配置之前，让名为default的Servlet先拦截，否则就会优先进入到springmvc的DispatcherServlet拦截中，致使访问失败。

3.2、修改DispatcherServlet的映射url为*.do或*.action(不灵活，遗弃)

<!-- 设置springmvc的前端控制器 -->
  <servlet>
    <servlet-name>dispatchServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>dispatchServlet</servlet-name>
    <url-pattern>*.do</url-pattern>
  </servlet-mapping>

这种方式规定访问路径必须带有后缀，往往使用*.do或*.action或*.html等方式，才能进入spingmvc的拦截，即便可以处理静态资源的访问，但是对于其他的请求有很大的限制要求，且无法处理rest风格的请求方式，显得很不灵活。

4、参考资料

springmvc三种放行静态资源的方案_别抢我蓝buff的博客-CSDN博客