SpringBoot 用War部署

最新推荐文章于 2025-01-23 13:36:31 发布

原创最新推荐文章于 2025-01-23 13:36:31 发布 · 440 阅读

1 ·

CC 4.0 BY-SA版权

Java 同时被 3 个专栏收录

75 篇文章

订阅专栏

Spring

26 篇文章

订阅专栏

SpringBoot

7 篇文章

订阅专栏

本文翻译自Spring官方文档，详细介绍了如何将SpringBoot项目转化为可部署的WAR文件，主要内容包括更新构建配置以生成WAR而非JAR，以及确保嵌入式Servlet容器不会干扰目标部署容器。通过修改Maven的pom.xml文件设置scope为provided来实现。按照指南步骤操作后，可将WAR文件部署至Tomcat等Web容器中。

本文主要是英文：https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto-create-a-deployable-war-file的翻译，

少部分是额外的一些说明。

pdf文档是：9.17.1. Create a Deployable War File

guide中：https://spring.io/guides/gs/convert-jar-to-war/ 也和本文有关，但是它这个文章并没有说的很清楚，老外有点偷懒了，标题党了。

正文开始

9.17.1. Create a Deployable War File

首先说明：WebFlux不支持War部署，这是响应式吧，另外一大套，不支持就不支持，我也不用。

第一步：提供SpringBootServletInitializer子类，覆盖configure方法。

这样做使用了Spring框架Servlet3.0支持，让你可以在应用启动的时候配置你的应用。

更新应用的main类为扩展SpringBootServletInitializer，例如下面代码：

@SpringBootApplication
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);
  }
}

第二步：是更新buid配置，这样你的项目会创建一个war而不是jar。

对于用maven的用pom.xml文件来说就很简单了，就是pom文件为

<packaging>war</packaging>

Gradle的我不懂，也就不翻译了。

第三步：也是最后一步是确保嵌入式的servlet 容器不干扰war文件需要部署到的那个容器

也是改pom文件，修改scope。

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

注意：上面的scope 改为了provided。具体的含义看下面我的综合整理的内容。东抄抄西抄超，你不用百度了。

Maven的一个哲学是惯例优于配置(Convention Over Configuration), Maven默认的依赖配置项中，scope的默认值是compile。

scope的分类
compile
默认就是compile，什么都不配置也就是意味着compile。compile表示被依赖项目需要参与当前项目的编译，当然后续的测试，运行周期也参与其中，是一个比较强的依赖。打包的时候通常需要包含进去。

test
scope为test表示依赖项目仅仅参与测试相关的工作，包括测试代码的编译，执行。比较典型的如junit。

runntime
runntime表示被依赖项目无需参与项目的编译，不过后期的测试和运行周期需要其参与。与compile相比，跳过编译而已，

provided
provided意味着打包的时候可以不用包进去，别的设施(Web Container)会提供。事实上该依赖理论上可以参与编译，测试，运行等周期。相当于compile，但是在打包阶段做了exclude的动作。

system
从参与度来说，也provided相同，不过被依赖项不会从maven仓库抓，而是从本地文件系统拿，一定需要配合systemPath属性使用。

这样就会打包为war了，试试吧，然后拷贝到你的tomcat中去，看看会不会运行。