Spring Boot中Factory method 'resourceHandlerMapping' threw exception如何解决？

Question

在Spring Boot项目运行时，若遇到“Factory method 'resourceHandlerMapping' threw exception”的错误，通常与静态资源处理配置相关。此问题常见原因包括：1）`spring-boot-starter-web`依赖缺失或版本冲突；2）`WebMvcAutoConfiguration`自动配置被不当覆盖或禁用；3）静态资源路径（如`/static`, `/public`, `/resources`, `/META-INF/resources`）下文件格式或权限异常。 解决方法如下：首先确认`pom.xml`中已正确引入`spring-boot-starter-web`依赖；其次检查是否误添加`@EnableWebMvc`注解，该注解会关闭Spring Boot默认的Web配置，需谨慎使用；最后验证静态资源路径及文件权限是否正常。若问题仍未解决，可尝试通过自定义`ResourceHandlerRegistry`重新配置静态资源映射规则，确保资源路径与访问URL匹配。

Answer 1

1. 问题概述

在Spring Boot项目运行时，若遇到“Factory method 'resourceHandlerMapping' threw exception”的错误，通常与静态资源处理配置相关。以下是可能的原因和解决方案的逐步分析：

• 原因1：`spring-boot-starter-web`依赖缺失或版本冲突。
• 原因2：`WebMvcAutoConfiguration`自动配置被不当覆盖或禁用。
• 原因3：静态资源路径（如`/static`, `/public`, `/resources`, `/META-INF/resources`）下文件格式或权限异常。

2. 检查依赖配置

首先确认`pom.xml`中已正确引入`spring-boot-starter-web`依赖。以下是一个典型的Maven依赖配置示例：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

如果存在多个版本冲突，可以使用Maven Dependency Tree命令来检查依赖树：

mvn dependency:tree -Dverbose

3. 分析注解影响

`@EnableWebMvc`注解会关闭Spring Boot默认的Web配置，因此需要谨慎使用。如果你确实需要自定义Web配置，请确保不完全覆盖默认配置。以下是一个避免完全覆盖的示例：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**")
               .addResourceLocations("classpath:/static/");
    }
}

4. 验证静态资源路径及权限

确保静态资源路径下的文件格式和权限正常。以下是一个常见的静态资源目录结构：

路径	描述
/static	存放CSS、JavaScript、图片等静态资源
/public	类似/static，但更适合公开访问的资源
/resources	用于存放应用级别的资源配置文件
/META-INF/resources	WAR包部署时的默认静态资源路径

5. 自定义静态资源映射规则

如果上述方法仍未解决问题，可以通过自定义`ResourceHandlerRegistry`重新配置静态资源映射规则。以下是一个完整的实现示例：

@Configuration
public class CustomResourceHandlerConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/images/**")
               .addResourceLocations("classpath:/static/images/")
               .setCachePeriod(3600);
        
        registry.addResourceHandler("/js/**")
               .addResourceLocations("classpath:/static/js/");
    }
}

6. 调试流程图

以下是解决此问题的调试流程图：

graph TD
    A[检查依赖] --> B{是否存在冲突}
    B -- 是 --> C[修复依赖]
    B -- 否 --> D[检查注解]
    D --> E{是否使用@EnableWebMvc}
    E -- 是 --> F[调整注解配置]
    E -- 否 --> G[验证静态资源]
    G --> H{路径和权限是否正确}
    H -- 否 --> I[修正路径或权限]
    H -- 是 --> J[自定义静态资源映射]