【SpringBoot笔记3】使用外部tomcat容器发布war包

翻译：官方文档第92.1节

注意：

因为Spring WebFlux不直接依赖于Servlet API，应用直接部署到内置的嵌入式Reactor容器Netty Server上，因此Spring WebFlux应用不支持war形式的部署。

通常，SpringBoot提供了内置嵌入式tomcat容器，因此可以直接将SpringBoot应用打包成jar包，并通过java -jar运行。

但是，如果想要将SpringBoot应用打包成war包，并部署到外部tomcat容器中运行，需要以下几步：

  1. 改写应用的启动类Application，使其继承SpringBootServletInitializer，并重写configure方法：
@SpringBootApplication
public class Application extends SpringBootServletInitializer {

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

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
  1. 修改pom.xml配置文件，将jar修改为war：
<packaging>war</packaging>
  1. 确保嵌入式tomcat的jar包在运行时不引入，可以通过指定<scope>provided</scope>实现：
	<!-- 打包成war包时需要在运行时移除嵌入式tomcat包 -->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-tomcat</artifactId>
		<scope>provided</scope>
	</dependency>

<scope>provided</scope>表示这个依赖在编译期和测试期引入，在运行期移除。

需要注意的一点，<build>里面的<finalName>最好和application.properties中的server.servlet.context-path保持一致。

  1. 设置打包生成的war包名：
<!-- 打包生成的war包名 -->
<finalName>app</finalName>
  1. 设置web应用上下文：
server.servlet.context-path=/app