如何将 Spring Boot 应用程序部署为 WAR？

Spring Boot 是一个用于创建独立的、生产级别的基于 Spring 框架的应用程序的框架。它简化了 Spring 应用的初始设置和开发过程。虽然 Spring Boot 默认支持创建可执行的 JAR 文件，但有时为了适应现有的基础设施或满足特定需求，开发者可能需要将 Spring Boot 应用程序打包成 WAR 文件并部署到传统的 Servlet 容器中，如 Apache Tomcat。

本文将详细介绍如何将一个 Spring Boot 应用程序转换为 WAR 文件，并成功部署到 Tomcat 服务器上。

1. 创建 Spring Boot 项目

首先，我们需要创建一个基础的 Spring Boot 项目。你可以使用 Spring Initializr (https://start.spring.io/) 来快速生成项目结构。选择 Maven 或 Gradle 作为构建工具，并确保包含 Web 和其他必要的依赖项。

2. 修改项目结构以支持 WAR 包

默认情况下，Spring Boot 项目被配置为生成 JAR 文件。要将其转换为 WAR 文件，需要进行以下更改：

• 修改 pom.xml (Maven) 或 build.gradle (Gradle)

对于 Maven 项目，打开 pom.xml 文件，将 <packaging> 标签的值从 jar 改为 war：

<packaging>war</packaging>

对于 Gradle 项目，打开 build.gradle 文件，添加以下配置：

apply plugin: 'war'

• 配置 Spring Boot 的主类

Spring Boot 需要知道哪个类是启动类。如果您的应用程序是 WAR 包，您需要继承 SpringBootServletInitializer 并重写 configure 方法。这样可以确保当应用程序作为 WAR 包部署时，Spring Boot 可以正确地初始化。

import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

public class Application extends SpringBootServletInitializer {
   

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

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

3. 移除内嵌的 Servlet 容器依赖

由于我们打算将应用程序部署到外部的 Servlet 容器中，因此需要移除内嵌的 Servlet 容器依赖（例如 Tomcat）。对于 Maven 项目，可以在 pom.xml 中将 spring-boot-starter-tomcat 的范围设置为 provided：

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

对于 Gradle 项目，可以在 build.gradle 中添加：

dependencies {
   
    providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
}

4. 构建 WAR 文件

现在，您可以使用 Maven 或 Gradle 构建工具来构建 WAR 文件。对于 Maven，运行以下命令：

mvn clean package

对于 Gradle，运行以下命令：

gradle clean war

构建完成后，您将在 target（Maven）或 build/libs（Gradle）目录下找到生成的 WAR 文件。

5. 部署 WAR 文件到 Tomcat

将生成的 WAR 文件复制到 Tomcat 的 webapps 目录下。然后启动 Tomcat 服务器。Tomcat 将自动检测新的 WAR 文件并部署它。

cd /path/to/tomcat/bin
./startup.sh

访问 http://localhost:8080/your-app-name 来检查应用程序是否成功部署。

结论

通过上述步骤，您可以轻松地将一个 Spring Boot 应用程序转换为 WAR 文件并部署到 Tomcat 服务器上。这种方式不仅保持了 Spring Boot 的便捷性和灵活性，还使得应用程序能够与现有的基于 Servlet 容器的基础设施无缝集成。希望本文能帮助您顺利完成这一过程。