使用 IntelliJ 部署启用嵌入式 tomcat 的 spring-boot 应用程序

Question

我有一个基于 spring-boot 的应用程序，使用嵌入式 tomcat。通过mvn spring-boot:run 目标部署时我没有问题，但是我尝试使用 intelliJ spring-boot 插件部署时遇到问题。重要说明，我们已经修改了默认的 pom，将我们的应用程序变成了一个可以部署为完整 tomcatTraditional Deployment 的战争，但是在开发模式下，使用嵌入式 tomcat 部署应用程序会更好。问题是，基本上我们在尝试从 intelliJ 运行 spring boot 应用程序时以这条消息结束

Caused by: java.lang.IllegalStateException: Failed to introspect annotated methods on class org.springframework.boot.web.support.SpringBootServletInitializer
    at org.springframework.core.type.StandardAnnotationMetadata.getAnnotatedMethods(StandardAnnotationMetadata.java:163) ~[spring-core-4.3.8.RELEASE.jar:4.3.8.RELEASE]
    at org.springframework.context.annotation.ConfigurationClassParser.retrieveBeanMethodMetadata(ConfigurationClassParser.java:380) ~[spring-context-4.3.8.RELEASE.jar:4.3.8.RELEASE]
    at org.springframework.context.annotation.ConfigurationClassParser.doProcessConfigurationClass(ConfigurationClassParser.java:314) ~[spring-context-4.3.8.RELEASE.jar:4.3.8.RELEASE]
    at org.springframework.context.annotation.ConfigurationClassParser.processConfigurationClass(ConfigurationClassParser.java:245) ~[spring-context-4.3.8.RELEASE.jar:4.3.8.RELEASE]
    at org.springframework.context.annotation.ConfigurationClassParser.parse(ConfigurationClassParser.java:198) ~[spring-context-4.3.8.RELEASE.jar:4.3.8.RELEASE]
    at org.springframework.context.annotation.ConfigurationClassParser.parse(ConfigurationClassParser.java:167) ~[spring-context-4.3.8.RELEASE.jar:4.3.8.RELEASE]
    ... 17 common frames omitted
Caused by: java.lang.NoClassDefFoundError: javax/servlet/ServletContext
    at java.lang.Class.getDeclaredMethods0(Native Method) ~[na:1.8.0_144]
    at java.lang.Class.privateGetDeclaredMethods(Class.java:2701) ~[na:1.8.0_144]
    at java.lang.Class.getDeclaredMethods(Class.java:1975) ~[na:1.8.0_144]
    at org.springframework.core.type.StandardAnnotationMetadata.getAnnotatedMethods(StandardAnnotationMetadata.java:152) ~[spring-core-4.3.8.RELEASE.jar:4.3.8.RELEASE]
    ... 22 common frames omitted
Caused by: java.lang.ClassNotFoundException: javax.servlet.ServletContext
    at java.net.URLClassLoader.findClass(URLClassLoader.java:381) ~[na:1.8.0_144]
    at java.lang.ClassLoader.loadClass(ClassLoader.java:424) ~[na:1.8.0_144]
    at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:335) ~[na:1.8.0_144]
    at java.lang.ClassLoader.loadClass(ClassLoader.java:357) ~[na:1.8.0_144]
    ... 26 common frames omitted

您对为什么会发生这种情况有任何想法吗？我们该如何解决呢？

编辑：

我正在使用 IntelliJ IDEA 2017.2（以防构建是 idea-IU-172.3317.76），作为 SSCCE，让我们使用 getting-started example of spring-boot，并应用建议的更改对于传统部署（第一个链接），我们将拥有以下文件

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<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>org.springframework</groupId>
    <artifactId>gs-spring-boot</artifactId>
    <version>0.1.0</version>
    <packaging>war</packaging>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.6.RELEASE</version>
    </parent>

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

    <properties>
        <java.version>1.8</java.version>
    </properties>


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

</project>

然后我们将有 Application.java

package hello;

import java.util.Arrays;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.support.SpringBootServletInitializer;
import org.springframework.context.ApplicationContext;

@SpringBootApplication
public class Application extends SpringBootServletInitializer {

    public static void main(String[] args) {
        ApplicationContext ctx = SpringApplication.run(Application.class, args);

        System.out.println("Let's inspect the beans provided by Spring Boot:");

        String[] beanNames = ctx.getBeanDefinitionNames();
        Arrays.sort(beanNames);
        for (String beanName : beanNames) {
            System.out.println(beanName);
        }
    }

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }

}

我没有修改 HelloController.java 只是为了完整性：

package hello;

import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMapping;

@RestController
public class HelloController {

    @RequestMapping("/")
    public String index() {
        return "Greetings from Spring Boot!";
    }

}

这个例子使用mvn spring-boot:run运行没有问题，但是使用spring-boot intelliJ的插件时不运行

Answer 1

注意 - 此答案引用了 v 1.5.6.RELEASE（当前版本）的 Spring 文档

---

分析：

从 IJ 运行主类就像从命令行执行应用程序一样。因此，类路径将仅包含 compile 和 runtime 范围的依赖项。 Provided 表示编译期间需要它，但您希望 JDK 或容器在运行时为您的应用程序提供它：

provided 这很像compile，但表示您希望 JDK 或容器在运行时提供依赖项。例如，在为 Java 企业版构建 Web 应用程序时，您可以将 Servlet API 和相关 Java EE API 的依赖设置为范围 provided，因为 Web 容器提供了这些类。此范围仅在编译和测试类路径上可用，并且不可传递。

另一方面，spring-boot-maven-plugin 使用不同的类路径来执行 run 目标：

默认情况下，repackage 和run 目标都将包含项目中定义的任何provided 依赖项。基于引导的项目应将 provided 依赖项视为运行应用程序所需的容器依赖项。

---

结论和解决方案：

所以这是一个类路径配置问题。正如您所提到的，对于war packaging 或traditional deployment，您应该排除嵌入式servlet 容器。但是，为了能够在开发期间运行应用程序，您需要嵌入式容器。

作为解决方案或变通方法，您至少有以下 2 个选项：

1) 从 spring-boot-starter-tomcat 依赖声明中删除 <scope>provided</scope>。如果你愿意，你可以像Tomcat is the default container used by spring-boot-starter-web一样完全删除这个依赖，但也许最好留下它并添加评论，这样你在发布时就不会忘记它

2) 一个与 IJ 一起使用的巧妙技巧，并且可以更容易地在生产发布之前不要忘记取消注释 provided，即保留现在的依赖项，并添加一个 maven dev 可以从 IJ 激活的配置文件。这样，默认情况下它将是provided，并且可以安全地打包到战争中，并且只有在开发和手动激活配置文件时才会包含它。添加配置文件后，重新导入您的 maven 项目，以便您可以选择配置文件：

<profiles>
    <profile>
        <id>dev</id>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </dependency>
        </dependencies>
    </profile>
</profiles>

Answer 2

如果您使用的是 maven 项目，那么您需要添加 javax.servlet-api 依赖项。

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>2.5</version>
    <scope>provided</scope>
</dependency>

你也可以从http://central.maven.org/maven2/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar下载jar