SpringBoot Jar包改造为War包

本文介绍如何将Spring Boot应用从Jar包转换为War包进行部署。主要包括修改Pom文件中的打包格式、调整内置Tomcat配置及重写容器类等关键步骤。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一.简介

对于默写特殊的业务场景,我们需要把已有的jar包分为改造为war包进行部署,对jar包的整改不会花费太多的工作量,现在讲改造过程梳理如下:

对于Jar包到War包的改造 ,分为三个步骤:

  • 1.修改打包格式[pom.xml]
  • 2.注销掉内置容器[pom.xml]
  • 3.重写容器类函数[SpringBootServletInitializer]

二.核心

1.修改打包格式

将Pom文件的打包格式有jar改为war 。

<!--<packaging>jar</packaging>-->
<packaging>war</packaging>

2.注释掉Spring自带的tomcat容器

其实不必完全注销掉,主许修改内置tomcat的生命周期即可。

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

3.重写容器类函数

重写的意义在于接入外置容器的请求到当前服务中来,需要需要继承实现外置容器。
新建 ServletInitializer.class文件

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

public class ServletInitializer extends SpringBootServletInitializer {

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

}

到此,jar服务到war的改造完毕,既可以部署到web容器进行测试。

其他

参考: https://blog.youkuaiyun.com/wangshan_1121/article/details/101449293

<think>我们有一个Spring Boot Cloud项目,目前以jar方式运行,现在需要改为war方式运行。主要步骤括修改项目结构、配置、以及处理内嵌容器相关的问题。以下是详细步骤: ### 步骤1: 修改项目打方式 在Maven的`pom.xml`文件中,将打方式从`jar`改为`war`: ```xml <packaging>war</packaging> ``` ### 步骤2: 排除内嵌Tomcat的依赖(可选,根据部署环境决定) 如果你计划将war部署到外部Tomcat服务器,那么需要排除内嵌Tomcat的依赖,以避免冲突。在`pom.xml`中添加以下配置: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <!-- 排除内嵌Tomcat --> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> </exclusion> </exclusions> </dependency> ``` 如果你还需要使用JSP,那么需要额外添加`javax.servlet`依赖: ```xml <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <scope>provided</scope> </dependency> ``` ### 步骤3: 修改启动类 Spring Boot的启动类需要继承`SpringBootServletInitializer`并重写`configure`方法。这样可以让Spring Boot应用在外部Tomcat容器中启动。 修改你的启动类(通常命名为`Application`或`*Application`): ```java @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); } } ``` ### 步骤4: 配置外部Tomcat(如果需要) 确保你有一个外部Tomcat服务器。将生成的war放入Tomcat的`webapps`目录下,然后启动Tomcat。 ### 步骤5: 处理Spring Cloud相关配置 Spring Cloud应用通常需要服务发现(如Nacos)、配置中心等。在外部容器中运行时,需要注意以下几点: 1. **端口配置**:在外部Tomcat中运行时,应用会使用Tomcat的端口(如8080),而不是在`application.properties`中配置的`server.port`。因此,你需要在Tomcat的配置中设置端口。 2. **上下文路径**:在外部Tomcat中,应用的上下文路径由war文件名决定(除非你在Tomcat中配置了特定的上下文路径)。例如,如果war文件名为`myapp.war`,那么访问路径为`http://localhost:8080/myapp`。在Spring Cloud应用中,如果涉及到服务注册,需要确保注册的服务地址正确(括上下文路径)。可以通过配置`server.servlet.context-path`来设置,但在外部容器中,这个设置可能会被覆盖。建议在外部容器中设置上下文路径,或者在应用内部通过`application.properties`设置,但要注意外部容器可能会忽略它。 3. **配置文件**:确保你的配置文件(如`application.properties`或`bootstrap.properties`)中关于服务发现和配置中心的地址是正确的,并且能够从外部容器环境中访问到(如Nacos服务器地址)。 ### 步骤6: 构建和部署 使用Maven命令构建war: ```bash mvn clean package ``` 然后将生成的war文件(位于`target`目录下)复制到Tomcat的`webapps`目录中,启动Tomcat即可。 ### 注意事项 - **内嵌容器与外部容器的区别**:在外部容器中运行时,一些内嵌容器相关的配置(如`server.port`)将不再生效,由外部容器管理。 - **Spring Cloud Config**:如果你的应用是配置中心客户端,确保在外部容器中运行时能够正确连接到配置中心(如Nacos)。在`bootstrap.properties`中配置的配置中心地址需要正确。 - **日志**:检查日志配置(如Logback),确保在外部容器中日志能够正确输出到指定位置。 ### 示例项目结构 一个典型的Maven项目结构如下: ``` src ├── main │ ├── java │ │ └── com/example │ │ └── Application.java # 修改后的启动类 │ └── resources │ └── application.properties pom.xml # 修改打方式为war,并排除内嵌Tomcat ``` ### 相关问题 1. 在外部Tomcat中部署Spring Boot应用时,如何处理静态资源路径? 2. 如何为Spring Boot War配置多个环境(如dev, test, prod)? 3. 在外部Tomcat中运行Spring Cloud应用,服务注册的IP和端口不正确怎么办?</think>### Spring Boot Cloud 项目从 Jar 改为 War 运行的方法和步骤 将 Spring Boot Cloud 项目从 Jar 改为 War 运行主要涉及以下关键步骤,这些步骤确保应用能在外部 Tomcat 等 Servlet 容器中正常运行: #### 步骤 1: 修改 Maven 打方式 在 `pom.xml` 中: 1. 修改打类型为 `war`: ```xml <packaging>war</packaging> ``` 2. 排除内嵌 Tomcat 依赖(避免冲突): ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <!-- 排除内嵌Tomcat --> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> </exclusion> </exclusions> </dependency> ``` 3. 添加 Servlet API 依赖: ```xml <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <scope>provided</scope> </dependency> ``` #### 步骤 2: 修改 Spring Boot 启动类 继承 `SpringBootServletInitializer` 并重写 `configure` 方法: ```java @SpringBootApplication @EnableDiscoveryClient // 保留Nacos服务发现 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); } } ``` > 关键点:`SpringBootServletInitializer` 是适配外部容器的入口类[^2] #### 步骤 3: 调整配置文件 在 `application.properties`/`application.yml` 中: 1. 禁用内嵌 Tomcat 的自动配置: ```yaml spring: main: web-application-type: servlet # 显式声明为Servlet应用 ``` 2. 确保服务注册地址正确(Nacos 配置): ```yaml spring: cloud: nacos: discovery: server-addr: ${NACOS_HOST:localhost}:8848 ``` #### 步骤 4: 处理 Spring Cloud 特殊配置 1. **服务注册问题**: 确保 `bootstrap.yml` 中的配置兼容外部容器,Nacos 会通过心跳机制自动更新服务地址[^1]。 2. **上下文路径配置**: 在 `server.servlet.context-path` 设置的应用路径可能被外部容器覆盖,建议通过 Tomcat 的 `context.xml` 配置。 #### 步骤 5: 构建与部署 1. 使用 Maven 构建 WAR : ```bash mvn clean package -DskipTests ``` 2. 部署到 Tomcat: - 将生成的 `*.war` 文件放入 `$TOMCAT_HOME/webapps/` - 启动 Tomcat:`$TOMCAT_HOME/bin/startup.sh` #### 验证要点 1. **日志检查**: 启动后检查 `catalina.out` 日志,确认 Spring Cloud 组件(如 Nacos)初始化成功。 2. **服务注册验证**: 登录 Nacos 控制台,查看服务是否正常注册(注意 IP 应为部署服务器的实际 IP)。 3. **API 测试**: 通过 Swagger 或 Postman 测试接口,确认路径为: `http://服务器IP:Tomcat端口/项目名(war文件名)/api-path` > **注意**:Spring Cloud 本身是规范而非具体实现,改为 War 部署不会影响其微服务能力[^2]。但需确保外部容器版本与 JDK 8 兼容(如 Tomcat 8.5+)。 ### 常见问题解决 - **服务注册 IP 错误**:在 `bootstrap.yml` 中显式指定 IP: ```yaml spring: cloud: nacos: discovery: ip: 192.168.1.100 # 实际服务器IP ``` - **静态资源404**:确保资源路径含项目上下文,如:`/project-name/resource.css`
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Freedom3568

技术域不存在英雄主义,不进则退

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值