1. 前言
Spring Boot 版本: 2.4.4
SpringBoot官方文档——Create a Deployable War File
SpringBoot的 Web模块 默认内嵌了Tomcat作为Servlet容器,因此,我们可以直接编写SpringBoot 启动类,直接通过启动类,一键开启Tomcat服务,确实是 nb plus!!!
但是,有些情况下,我们的Tomcat服务器,需要另外专门部署,会更好维护,此时,我们就考虑排除SpringBoot 的 Web模块中的Tomcat依赖,进而可以将SpringBoot应用部署到外部的Tomcat容器中。
2 修改步骤
2.1 修改打包方式(jar -> war)
<!-- 这里打成war包 若打jar,需将war改为jar -->
<packaging>war</packaging>
2.2 排除 SprignBoot的Web模块中的Tomcat依赖
2.2.1 将嵌入的Tomcat依赖方式改成 provided
修改 pom.xml 文件,将嵌入的Tomcat依赖方式改成provided(编译、测试时将依赖的包加入本工程的classpath,运行时不加入,可以理解成运行时不使用Spring Boot 自带的Tomcat),确保嵌入式servlet容器不干扰war文件所部署到的servlet容器。
<!--SpringBoot 的 Web模块内嵌的tomcat依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<!-- 编译、测试时将依赖的包加入本工程的classpath,运行时不加入,可以理解成运行时不使用Spring Boot 自带的Tomcat -->
<scope>provided</scope>
</dependency>
注意:
将SpringBoot的Web模块 提供的嵌入式servlet容器依赖关系标记为provided时,将生成可执行的war文件,其中提供的依赖关系打包在 lib-provided 的目录中。
这意味着,除了可以部署到servlet容器之外,还可以通过在命令行上使用java -jar运行该应用程序。
2.2.2 直接排除Web模块中的Tomcat依赖
排除内嵌的Tomcat依赖
<!-- SpringBoot的web模块 依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<!-- 排除SpringBoot的web模块默认内嵌的Servlet容器 Tomcat-->
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
由于排除了Tomcat依赖,没有了servlet实现,因此,需要引入servlet依赖
<!-- servlet 依赖 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
<!--<scope>provided</scope>-->
</dependency>
注意:
Spring Boot 必须在Servlet 3.0规范以上容器中运行。
2.3 修改启动类,并重写初始化方法
如果打算以 war 或 jar (可执行应用程序) 的形式启动应用程序,则需要使用SpringBootServletInitializer回调可用的configure方法和类似于以下类的main方法中的共享方法来共享构建器的自定义项:
2.3.1 官方文档的写法
@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);
}
}
或者
@SpringBootApplication
public class Application extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return configureApplication(builder);
}
public static void main(String[] args) {
configureApplication(new SpringApplicationBuilder()).run(args);
}
private static SpringApplicationBuilder configureApplication(SpringApplicationBuilder builder) {
return builder.sources(Application.class).bannerMode(Banner.Mode.OFF);
}
}
2.3.2 第二種方式
在SpringBoot中我们平常用main方法启动的方式,都有一个SpringBootApplication的启动类,类似代码如下:
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
而我们现在需要类似于web.xml的配置方式来启动spring应用,为此,我们在Application类的同级添加一个SpringBootStartApplication类,其代码如下:
// 修改启动类,继承 SpringBootServletInitializer 并重写 configure 方法
public class SpringBootStartApplication extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
// 注意这里一定要指向原先用main方法执行的Application启动类
return builder.sources(Application.class);
}
}
注意事项:
使用外部Tomcat部署访问的时候,application.properties(或者application.yml)中配置的
server.port =
server.servlet.context-path =
将失效,请使用,tomcat,webapps下项目名进行访问。
为了防止应用上下文所导致的项目访问资源载入不到的问题,
建议pom.xml档案中
<build>
<!-- 应与项目的context-path保持一致 -->
<finalName>war包名稱</finalName>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
- 如果设置就会按照你自己设定的名字作为包名