使用IntelliJ部署支持tomcat的嵌入式春启动应用程序

Question

我有一个基于弹簧引导的应用程序，使用嵌入式tomcat。在通过mvn spring-boot:run目标进行部署时，没有问题，但在使用intelliJ spring启动插件进行部署时，遇到了问题。重要的是，我们已经修改了默认的pom，将我们的应用程序变成了一个war，可以部署到一个完整的tomcat传统部署中，但是在开发模式下，最好只使用嵌入式tomcat部署应用程序。问题是，在尝试从intelliJ运行spring引导应用程序时，我们基本上以这条消息结束。

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，让我们使用入门-启动示例，并应用为传统部署提出的更改(第一个链接)，我们将有以下文件

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插件时不运行。

Answer 1

Note -这个答案引用了V1.5.6的Spring文档(当前版本)

分析：

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

provided --这与compile非常相似，但表示您希望JDK或容器在运行时中提供依赖关系。例如，在为构建web应用程序时，您将将对Servlet和相关Java的依赖设置为provided范围，因为web容器提供了这些类。此范围仅在编译和测试类路径上可用，且不可传递。

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

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

结论与解决方案：

所以这是一个类路径配置问题。正如您所提到的，对于战争包装或传统部署，您应该排除嵌入式servlet容器。但是，为了能够在开发过程中运行该应用程序，您需要嵌入式容器。

作为解决方案或解决方案，您至少有以下两个选项：

1)从spring-boot-starter-tomcat依赖项声明中删除<scope>provided</scope>。如果您愿意，您可以完全删除该依赖项，如spring-boot-starter-web，但最好还是离开它并添加注释，这样在发布时不会忘记它

2)使用IJ的一个巧妙的技巧，它可以让您在发布产品之前更容易地取消对provided的评论，这就是保持现在的依赖性，并添加一个可以从IJ激活的maven dev配置文件。这样，默认情况下它将是provided，并且可以安全地打包到war中，并且只有在开发和手动激活概要文件时才会包含它。添加配置文件后，重新导入您的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。