传统部署

Spring Boot 支持传统部署以及更现代的部署形式。本节回答了关于传统部署的常见问题。

创建可部署的 War 文件

由于 Spring WebFlux 不严格依赖于 servlet API，并且应用程序默认部署在嵌入式 Reactor Netty 服务器上，因此 WebFlux 应用程序不支持 War 部署。

生成可部署 War 文件的第一步是提供一个 SpringBootServletInitializer 子类并重写其 configure 方法。这样做利用了 Spring Framework 的 servlet 3.0 支持，并允许你在 servlet 容器启动应用程序时对其进行配置。通常，你应该更新应用程序的主类以扩展 SpringBootServletInitializer，如下例所示

  • Java

  • Kotlin

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

@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer {

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

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

}
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.builder.SpringApplicationBuilder
import org.springframework.boot.runApplication
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer

@SpringBootApplication
class MyApplication : SpringBootServletInitializer() {

	override fun configure(application: SpringApplicationBuilder): SpringApplicationBuilder {
		return application.sources(MyApplication::class.java)
	}

}

fun main(args: Array<String>) {
	runApplication<MyApplication>(*args)
}

下一步是更新你的构建配置，使你的项目生成 War 文件而不是 Jar 文件。如果你使用 Maven 和 spring-boot-starter-parent（它为你配置了 Maven 的 War 插件），你只需要修改 pom.xml，将打包类型更改为 war，如下所示

<packaging>war</packaging>

如果你使用 Gradle，你需要修改 build.gradle，为项目应用 war 插件，如下所示

apply plugin: 'war'

过程中的最后一步是确保嵌入式 servlet 容器不会干扰 War 文件要部署到的 servlet 容器。为此，你需要将嵌入式 servlet 容器依赖项标记为 provided（已提供）。

如果你使用 Maven，以下示例将 servlet 容器（本例中为 Tomcat）标记为 provided：

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

如果你使用 Gradle，以下示例将 servlet 容器（本例中为 Tomcat）标记为 provided：

dependencies {
	// ...
	providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
	// ...
}
推荐使用 providedRuntime 而不是 Gradle 的 compileOnly 配置。除了其他限制之外，compileOnly 依赖项不在测试 classpath 中，因此任何基于 web 的集成测试都会失败。

如果你使用 Spring Boot 构建工具插件，将嵌入式 servlet 容器依赖项标记为 provided 会生成一个可执行 War 文件，其中 provided 依赖项打包在 lib-provided 目录中。这意味着除了可以部署到 servlet 容器之外，你还可以使用命令行中的 java -jar 来运行你的应用程序。

将现有应用程序转换为 Spring Boot

要将现有的非 web Spring 应用程序转换为 Spring Boot 应用程序，请替换创建你的 ApplicationContext 的代码，并将其替换为调用 SpringApplication 或 SpringApplicationBuilder。Spring MVC web 应用程序通常可以先创建可部署 War 应用程序，然后再将其迁移为可执行 War 或 Jar。

要通过扩展 SpringBootServletInitializer（例如，在名为 Application 的类中）并添加 Spring Boot @SpringBootApplication 注解来创建可部署 War，可以使用类似于以下示例的代码

  • Java

  • Kotlin

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

@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer {

	@Override
	protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
		// Customize the application or call application.sources(...) to add sources
		// Since our example is itself a @Configuration class (through
		// @SpringBootApplication)
		// we actually do not need to override this method.
		return application;
	}


}
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.builder.SpringApplicationBuilder
import org.springframework.boot.runApplication
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer

@SpringBootApplication
class MyApplication : SpringBootServletInitializer() {

	override fun configure(application: SpringApplicationBuilder): SpringApplicationBuilder {
		// Customize the application or call application.sources(...) to add sources
		// Since our example is itself a @Configuration class (through @SpringBootApplication)
		// we actually do not need to override this method.
		return application
	}

}

请记住，无论你放在 sources 中的是什么，都仅仅是一个 Spring ApplicationContext。通常，任何已经可以工作的东西在这里也应该可以工作。你可能稍后会移除一些 Bean，并让 Spring Boot 提供自己的默认配置，但在这样做之前，应该可以先让一些东西跑起来。

静态资源可以移动到 classpath 根目录下的 /public（或 /static、/resources 或 /META-INF/resources）中。messages.properties 也同样适用（Spring Boot 会自动检测 classpath 根目录下的该文件）。

Spring DispatcherServlet 和 Spring Security 的普通用法不需要进一步更改。如果你的应用程序中有其他特性（例如，使用其他 servlet 或 filter），你可能需要在 Application 上下文中添加一些配置，通过替换 web.xml 中的那些元素，如下所示

一旦 War 文件可以正常工作，你可以通过在 Application 中添加一个 main 方法使其成为可执行文件，如下例所示

  • Java

  • Kotlin

	public static void main(String[] args) {
		SpringApplication.run(MyApplication.class, args);
	}
fun main(args: Array<String>) {
	runApplication<MyApplication>(*args)
}

如果你打算将应用程序作为 War 或可执行应用程序启动，你需要在一个方法中共享 builder 的自定义配置，该方法需要可供 SpringBootServletInitializer 回调以及 main 方法使用，类似于以下类

  • Java

  • Kotlin

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

@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer {

	@Override
	protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
		return customizerBuilder(builder);
	}

	public static void main(String[] args) {
		customizerBuilder(new SpringApplicationBuilder()).run(args);
	}

	private static SpringApplicationBuilder customizerBuilder(SpringApplicationBuilder builder) {
		return builder.sources(MyApplication.class).bannerMode(Banner.Mode.OFF);
	}

}
import org.springframework.boot.Banner
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.builder.SpringApplicationBuilder
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer

@SpringBootApplication
class MyApplication : SpringBootServletInitializer() {

	override fun configure(builder: SpringApplicationBuilder): SpringApplicationBuilder {
		return customizerBuilder(builder)
	}

	companion object {

		@JvmStatic
		fun main(args: Array<String>) {
			customizerBuilder(SpringApplicationBuilder()).run(*args)
		}

		private fun customizerBuilder(builder: SpringApplicationBuilder): SpringApplicationBuilder {
			return builder.sources(MyApplication::class.java).bannerMode(Banner.Mode.OFF)
		}

	}

}

应用程序可能属于多种类别

  • 没有 web.xml 的 Servlet 3.0+ 应用程序。

  • 带有 web.xml 的应用程序。

  • 带有上下文层次结构的应用程序。

  • 没有上下文层次结构的应用程序。

所有这些都应该适合转换，但每种情况可能需要略微不同的技术。

如果 Servlet 3.0+ 应用程序已经使用了 Spring Servlet 3.0+ 初始化器支持类，那么转换起来可能会相当容易。通常，现有的 WebApplicationInitializer 中的所有代码都可以移到 SpringBootServletInitializer 中。如果你的现有应用程序有多个 ApplicationContext（例如，如果使用了 AbstractDispatcherServletInitializer），那么你可能可以将所有上下文源合并到一个 SpringApplication 中。你可能遇到的主要复杂情况是合并不起作用，并且你需要维护上下文层次结构。有关示例，请参阅关于构建层次结构的条目。包含特定于 web 特性的现有父上下文通常需要拆分，以便所有 ServletContextAware 组件都在子上下文中。

尚未是 Spring 应用程序的应用程序可能可以转换为 Spring Boot 应用程序，前面提到的指南可能会有所帮助。但是，你可能仍然会遇到问题。在这种情况下，我们建议在 Stack Overflow 上提出带有 spring-boot 标签的问题。

将 WAR 部署到 WebLogic

要将 Spring Boot 应用程序部署到 WebLogic，你必须确保你的 servlet 初始化器直接实现了 WebApplicationInitializer（即使你扩展的基类已经实现了它）。

WebLogic 的典型初始化器应类似于以下示例

  • Java

  • Kotlin

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.web.WebApplicationInitializer;

@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer implements WebApplicationInitializer {

}
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer
import org.springframework.web.WebApplicationInitializer

@SpringBootApplication
class MyApplication : SpringBootServletInitializer(), WebApplicationInitializer

如果你使用 Logback，你还需要告诉 WebLogic 优先使用打包的版本，而不是随服务器预安装的版本。你可以通过添加一个包含以下内容的 WEB-INF/weblogic.xml 文件来实现：

<?xml version="1.0" encoding="UTF-8"?>
<wls:weblogic-web-app
	xmlns:wls="http://xmlns.oracle.com/weblogic/weblogic-web-app"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
		https://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsd
		http://xmlns.oracle.com/weblogic/weblogic-web-app
		https://xmlns.oracle.com/weblogic/weblogic-web-app/1.4/weblogic-web-app.xsd">
	<wls:container-descriptor>
		<wls:prefer-application-packages>
			<wls:package-name>org.slf4j</wls:package-name>
		</wls:prefer-application-packages>
	</wls:container-descriptor>
</wls:weblogic-web-app>