对于最新的稳定版本,请使用 Spring Boot 3.5.5! |
传统部署
Spring Boot 支持传统部署以及更现代的部署形式。 本部分回答有关传统部署的常见问题。
创建可部署的战争文件
由于 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 容器依赖项标记为已提供。
如果您使用 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 的compileOnly 配置。
除其他限制外,compileOnly 依赖项不在测试类路径上,因此任何基于 Web 的集成测试都失败。 |
如果您使用 Spring Boot 构建工具插件,则将嵌入的 servlet 容器依赖项标记为提供会生成一个可执行的 war 文件,其中包含打包在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
注释,请使用类似于以下示例中所示的代码:
-
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
只是一个SpringApplicationContext
.
通常,任何已经有效的东西都应该在这里工作。
您可能稍后可以删除一些 bean,让 Spring Boot 为它们提供自己的默认值,但在您需要这样做之前,应该可以让一些东西正常工作。
静态资源可以移动到/public
(或/static
或/resources
或/META-INF/resources
) 在类路径根目录中。
这同样适用于messages.properties
(Spring Boot 在类路径的根目录中自动检测到)。
Spring 的原版用法DispatcherServlet
并且 Spring Security 不需要进一步更改。
如果您的应用程序中有其他功能(例如,使用其他 servlet 或过滤器),您可能需要向Application
context,通过替换web.xml
如下:
-
一个
@Bean
类型Servlet
或ServletRegistrationBean
将该 bean 安装在容器中,就好像它是<servlet/>
和<servlet-mapping/>
在web.xml
. -
一个
@Bean
类型Filter
或FilterRegistrationBean
行为类似(作为<filter/>
和<filter-mapping/>
). -
一
ApplicationContext
可以在 XML 文件中添加@ImportResource
在你的Application
. 或者,可以在几行中重新创建已经大量使用的注释配置的情况,如@Bean
定义。
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 或可执行应用程序启动,则需要在
|
应用程序可以分为多个类别:
-
Servlet 3.0+ 应用程序,没有
web.xml
. -
具有
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>