【亲测可用】Unable to start ServletWebServerApplicationContext due to missing ServletWebServerFactory bean

在使用Spring Boot开发Web应用时，遇到错误信息“Unable to start ServletWebServerApplicationContext due to missing ServletWebServerFactory bean”是一个常见的问题。这通常表明Spring Boot应用未能找到适合的Servlet Web Server工厂来启动其上下文。这篇文章将分析其可能的原因，并提供一些解决方案和代码示例。

错误原因分析

该错误通常出现在以下几种情况下：

1. 缺少相关依赖： Spring Boot的Web应用通常需要添加spring-boot-starter-web依赖，该依赖会自动引入一个嵌入式的Web服务器（比如Tomcat、Jetty或Undertow）。如果错误地排除了这些依赖，应用无法启动。

2. 不正确的自定义配置： 如果你自定义了@SpringBootApplication的配置，可能会影响到默认的Servlet Web Server工厂的创建。

3. 缺少@SpringBootApplication注解： Spring Boot的入口类通常需要有@SpringBootApplication注解。如果这个注解丢失，Spring Boot无法自动配置Servlet Web Server。

解决方案

以下是几个解决该问题的可能方案：

1. 确保添加了必要依赖

在pom.xml中添加spring-boot-starter-web：

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

这将自动引入Tomcat作为嵌入式Web服务器。

2. 检查自定义配置

检查自定义配置类，确保没有错误地排除Servlet Web Server的自动配置。通常情况下，不需要额外的配置。如果你确实需要自定义，确保使用@EnableAutoConfiguration注解。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

3. 确认有入口类及其注解

确保你的启动类正确，且包含@SpringBootApplication注解。例如：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

4. 无法识别的其他配置问题

有时候，其他配置框架（如Spring Cloud、Spring Security等）的不当设置可能会导致该错误。务必仔细检查这些框架的相关配置。

示例代码

以下是一个完整的Spring Boot应用的示例代码，包括必要的依赖和启动类：

1. pom.xml 配置

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

1. 应用启动类

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

总结

通过上述分析与示例代码，可以有效地解决“Unable to start ServletWebServerApplicationContext due to missing ServletWebServerFactory bean”错误。关键在于确保所有必要的依赖、配置和注解都正确设置，避免因小失大。如果上述方法仍未解决问题，建议检查项目的更深层次的配置和依赖。