对于最新的稳定版本,请使用 Spring Boot 3.4.0! |
传统部署
Spring Boot 支持传统部署以及更现代的部署形式。 本节解答了有关传统部署的常见问题。
创建可部署的 war 文件
因为 Spring WebFlux 并不严格依赖于 servlet API,而且应用程序默认部署在嵌入式 Reactor Netty 服务器上,所以 WebFlux 应用程序不支持 War 部署。 |
生成可部署的 war 文件的第一步是提供SpringBootServletInitializer
子类并覆盖其方法。
这样做利用了 Spring Framework 的 servlet 3.0 支持,并允许您在 servlet 容器启动应用程序时对其进行配置。
通常,你应该更新应用程序的主类以扩展SpringBootServletInitializer
,如以下示例所示:configure
-
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 和(为你配置 Maven 的 war 插件),你需要做的就是修改以将打包更改为 war,如下所示:spring-boot-starter-parent
pom.xml
<packaging>war</packaging>
如果使用 Gradle,则需要修改才能将 war 插件应用到项目中,如下所示:build.gradle
apply plugin: 'war'
该过程的最后一步是确保嵌入式 servlet 容器不会干扰 war 文件部署到的 servlet 容器。 为此,您需要将嵌入式 servlet 容器依赖项标记为已提供。
如果使用 Maven,以下示例将 Servlet 容器(在本例中为 Tomcat)标记为已提供:
<dependencies>
<!-- ... -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
<!-- ... -->
</dependencies>
如果使用 Gradle,以下示例将 servlet 容器(在本例中为 Tomcat)标记为已提供:
dependencies {
// ...
providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
// ...
}
providedRuntime 优先于 Gradle 的配置。
除其他限制外,依赖项不在测试 Classpath 上,因此任何基于 Web 的集成测试都会失败。compileOnly compileOnly |
如果使用 Spring Boot Build Tool Plugins,则将嵌入式 servlet 容器依赖项标记为已提供将生成一个可执行的 war 文件,其中提供的依赖项打包在一个目录中。
这意味着,除了可部署到 servlet 容器之外,您还可以在命令行上使用 来运行应用程序。lib-provided
java -jar
将现有应用程序转换为 Spring Boot
要将现有的非 Web Spring 应用程序转换为 Spring Boot 应用程序,请替换创建ApplicationContext
的代码,并将其替换为对SpringApplication或SpringApplicationBuilder
的调用。
Spring MVC Web 应用程序通常适合先创建一个可部署的 war 应用程序,然后再将其迁移到可执行的 war 或 jar 中。
要通过扩展SpringBootServletInitializer
(例如,在名为的类中)并添加 Spring Boot @SpringBootApplication
注释来创建可部署的 war,请使用类似于以下示例所示的代码:Application
-
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
}
}
请记住,无论你放入什么,都只是一个 Spring ApplicationContext
。
通常,任何已经有效的内容都应该在这里工作。
可能有一些 bean 你可以稍后删除,并让 Spring Boot 为它们提供自己的默认值,但是在你需要这样做之前,应该可以让一些东西工作。sources
静态资源可以移动到 Classpath 根目录中(或 or 或 )。
这同样适用于(Spring Boot 在 Classpath 的根目录中自动检测到)。/public
/static
/resources
/META-INF/resources
messages.properties
Spring DispatcherServlet
和 Spring Security 的原版使用应该不需要进一步的更改。
如果您的应用程序中还有其他功能(例如,使用其他 servlet 或过滤器),则可能需要通过替换 中的这些元素来向上下文添加一些配置,如下所示:Application
web.xml
-
Servlet
或ServletRegistrationBean
类型的@Bean
会将该 Bean 安装在容器中,就像它是 和 一样。<servlet/>
<servlet-mapping/>
web.xml
-
Filter
或FilterRegistrationBean
类型的@Bean
的行为类似(如 和 )。<filter/>
<filter-mapping/>
-
XML 文件中的
ApplicationContext
可以通过@ImportResource.
或者,已经大量使用 Comments 配置的情况可以在几行中重新创建@Bean
定义。Application
一旦 war 文件开始工作,你可以通过向 中添加一个方法来使其可执行,如以下示例所示:main
Application
-
Java
-
Kotlin
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
fun main(args: Array<String>) {
runApplication<MyApplication>(*args)
}
如果你打算将应用程序作为 war 或可执行应用程序启动,则需要在
|
应用程序可以分为多个类别:
-
没有 .
web.xml
-
带有 .
web.xml
-
具有上下文层次结构的应用程序。
-
没有上下文层次结构的应用程序。
所有这些都应该适合翻译,但每个可能需要略有不同的技术。
如果 Servlet 3.0+ 应用程序已经使用 Spring Servlet 3.0+ 初始化器支持类,那么它们可能很容易进行翻译。
通常,来自现有WebApplicationInitializer
的所有代码都可以移动到SpringBootServletInitializer
中。
如果你现有的应用程序有多个ApplicationContext
(例如,如果它使用AbstractDispatcherServletInitializer
),那么你也许能够将所有上下文源合并到一个SpringApplication
中。
您可能会遇到的主要复杂情况是,如果合并不起作用,并且您需要维护上下文层次结构。
有关示例,请参阅 building a hierarchy 上的条目。
通常需要分解包含 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>