SpringMVC解决静态资源无法访问的问题

qingfengmax

已于 2023-04-05 19:13:46 修改

阅读量1.1k

点赞数 2

分类专栏： Spring 文章标签： spring java

于 2023-04-05 18:14:40 首次发布

本文链接：https://blog.csdn.net/qingfengmax/article/details/129973566

版权

Spring 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

在SpringMVC中，当web.xml中的DispatcherServlet的url-pattern设置为"/"时，Controller请求正常访问，但访问静态资源时会出现404的问题。导致这个问题的原因与Tomcat中的DefaultServlet配置的url-pattern有关。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!-- 注册CharacterEncodingFilter，解决POST请求中文乱码问题 -->
    <filter>
        <filter-name>characterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <!-- 设置字符集 -->
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <!-- 处理请求对象的字符集 -->
        <init-param>
            <param-name>forceRequestEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
        <!-- 处理响应对象的字符集 -->
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>

    <!-- 所有请求都先走CharacterEncodingFilter -->
    <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>


    <!-- 注册DispatcherServlet中央调度器 -->
    <servlet>
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 初始化参数 指定SpringMVC配置文件位置 -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
        <!-- 在容器初始化的时候 创建该Servlet -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

一、DefaultServlet介绍

在Tomcat中，是通过DefaultServlet来处理静态资源的，找到Tomcat的web.xml（在Tomcat安装目录下的conf文件夹中），该DefaultServlet用来处理静态资源。

<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>

<!-- The mapping for the default servlet -->
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

二、静态资源无法访问的原因

由于项目的web.xml中DispatcherServlet的url-pattern为"/"，Tomcat配置的DefaultServlet的url-pattern也是"/"，由于就近原则所有的请求都会由 DispatcherServlet 来处理，并不会交给DefaultServlet处理。导致访问静态资源的请求也被 DispatcherServlet 处理，但是DispatcherServlet不具备处理静态的能力，最终导致访问静态资源出现404的问题。

三、解决方案

3.1、添加<mvc:default-servlet-handler/>标签

在SpringMVC的配置文件中添加<mvc:default-servlet-handler/>标签，SpringMVC底层会创建一个 DefaultServletHandler 对象，这个对象会将请求都交给 DefaultServlet 进行处理。添加<mvc:default-servlet-handler/>标签后，访问静态资源是没有问题的，但是访问Controller时，会出现404的问题。

导致这一问题的原因是：DefauletServletHandler将所有的请求都交给了DefaultServlet进行处理，但是DefaultServlet只能处理静态资源，不能处理Controller请求，所以就出现了静态资源访问正常，访问Controller出现404的问题。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans   
       http://www.springframework.org/schema/beans/spring-beans.xsd 
       http://www.springframework.org/schema/context 
       https://www.springframework.org/schema/context/spring-context.xsd 
       http://www.springframework.org/schema/mvc 
       https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 扫描Controller -->
    <context:component-scan base-package="it.demo.controller"/>

    <!-- 处理无法加载静态资源的问题 -->
    <mvc:default-servlet-handler/>


</beans>

3.2、添加<mvc:default-servlet-handler/>和<mvc:annotation-driven/>标签

在SpringMVC的配置文件中添加<mvc:default-servlet-handler/>后，会出现Controller请求出现404的问题，在配置文件中添加<mvc:annotation-driven/>标签后，可以解决这个问题。

添加了<mvc:annotation-driven/>标签后，会先对进入DispatcherServlet的请求进行过滤，判断请求是否有对应的请求处理器（Controller），如果有则交给DispatcherServlet处理，如果没有就交给DefaultServlet进行处理。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans   
       http://www.springframework.org/schema/beans/spring-beans.xsd 
       http://www.springframework.org/schema/context 
       https://www.springframework.org/schema/context/spring-context.xsd 
       http://www.springframework.org/schema/mvc 
       https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 扫描Controller -->
    <context:component-scan base-package="it.demo.controller"/>

    <!-- 处理无法加载静态资源的问题 -->
    <mvc:default-servlet-handler/>

    <!-- 处理添加了default-servlet-handler之后，Controller的请求失效的问题 -->
    <mvc:annotation-driven/>

</beans>

四、总结

1、在SpringMVC中的DispatcherServlet的url-pattern设置为"/"时，会与默认的DefaultServlet冲突，导致无法访问静态资源。在添加<mvc:default-servlet-handler/>标签后，可以解决无法访问静态资源的问题，但会导致Controller请求出现404的问题，还需要添加<mvc:annotation-driven/>标签来解决。

2、<mvc:default-servlet-handler/>需要和<mvc:annotation-driven/>配合使用。

如有不足之处，请在评论区中指出。一起努力，共勉！