对于最新的稳定版本,请使用 Spring Boot 3.5.5! |
部署到云
Spring Boot 的可执行 jar 是为大多数流行的云 PaaS(平台即服务)提供商准备的。 这些提供商往往要求您“自带容器”。 它们管理应用程序进程(不是专门针对 Java 应用程序),因此它们需要一个中间层来使您的应用程序适应云中正在运行的进程的概念。
Heroku 和 Cloud Foundry 这两个流行的云提供商采用了“构建包”方法。
buildpack 将部署的代码包装在启动应用程序所需的任何内容中。
它可能是一个 JDK 和java
、嵌入式 Web 服务器或成熟的应用程序服务器。
构建包是可插拔的,但理想情况下,您应该能够通过尽可能少的自定义来完成。
这减少了不受您控制的功能的占用空间。
它最大限度地减少了开发环境和生产环境之间的差异。
理想情况下,您的应用程序(如 Spring Boot 可执行 jar)将运行所需的一切打包在其中。
在本节中,我们将了解如何在“入门”部分中开发的应用程序在云中启动并运行。
云代工厂
Cloud Foundry 提供默认的 buildpack,如果未指定其他 buildpack,则这些 buildpack 将发挥作用。
Cloud Foundry Java 构建包对 Spring 应用程序(包括 Spring Boot)有出色的支持。
您可以部署独立的可执行 jar 应用程序以及传统的.war
打包的应用程序。
构建应用程序后(例如,通过使用mvn clean package
) 并有安装了cf
命令行工具,使用cf push
命令,替换编译后的路径.jar
.
一定要有使用您的cf
命令行客户端在推送应用程序之前。
以下行显示了使用cf push
部署应用程序的命令:
$ cf push acloudyspringtime -p target/demo-0.0.1-SNAPSHOT.jar
在前面的示例中,我们将acloudyspringtime 无论您给予什么价值cf 作为应用程序的名称。 |
请参阅cf push
文档以获取更多选择。
如果有 Cloud Foundrymanifest.yml
文件存在于同一目录中,则被视为。
此时,cf
开始上传您的应用程序,生成类似于以下示例的输出:
Uploading acloudyspringtime... OK
Preparing to start acloudyspringtime... OK
-----> Downloaded app package (8.9M)
-----> Java Buildpack Version: v3.12 (offline) | https://github.com/cloudfoundry/java-buildpack.git#6f25b7e
-----> Downloading Open Jdk JRE
Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.6s)
-----> Downloading Open JDK Like Memory Calculator 2.0.2_RELEASE from https://java-buildpack.cloudfoundry.org/memory-calculator/trusty/x86_64/memory-calculator-2.0.2_RELEASE.tar.gz (found in cache)
Memory Settings: -Xss349K -Xmx681574K -XX:MaxMetaspaceSize=104857K -Xms681574K -XX:MetaspaceSize=104857K
-----> Downloading Container Certificate Trust Store 1.0.0_RELEASE from https://java-buildpack.cloudfoundry.org/container-certificate-trust-store/container-certificate-trust-store-1.0.0_RELEASE.jar (found in cache)
Adding certificates to .java-buildpack/container_certificate_trust_store/truststore.jks (0.6s)
-----> Downloading Spring Auto Reconfiguration 1.10.0_RELEASE from https://java-buildpack.cloudfoundry.org/auto-reconfiguration/auto-reconfiguration-1.10.0_RELEASE.jar (found in cache)
Checking status of app 'acloudyspringtime'...
0 of 1 instances running (1 starting)
...
0 of 1 instances running (1 starting)
...
0 of 1 instances running (1 starting)
...
1 of 1 instances running (1 running)
App started
祝贺!该应用程序现已上线!
应用程序上线后,您可以使用cf apps
命令,如以下示例所示:
$ cf apps
Getting applications in ...
OK
name requested state instances memory disk urls
...
acloudyspringtime started 1/1 512M 1G acloudyspringtime.cfapps.io
...
一旦 Cloud Foundry 确认您的应用程序已部署,您应该能够在给定的 URI 中找到该应用程序。
在前面的示例中,您可以在以下位置找到它https://acloudyspringtime.cfapps.io/
.
绑定到服务
默认情况下,有关正在运行的应用程序的元数据以及服务连接信息作为环境变量向应用程序公开(例如:$VCAP_SERVICES
).
这种架构决策是由于 Cloud Foundry 的多语言(任何语言和平台都可以作为构建包支持)的性质。
进程范围的环境变量与语言无关。
环境变量并不总是最简单的 API,因此 Spring Boot 会自动提取它们并将数据扁平化为可以通过 Spring 的Environment
抽象,如以下示例所示:
-
Java
-
Kotlin
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
@Component
public class MyBean implements EnvironmentAware {
private String instanceId;
@Override
public void setEnvironment(Environment environment) {
this.instanceId = environment.getProperty("vcap.application.instance_id");
}
// ...
}
import org.springframework.context.EnvironmentAware
import org.springframework.core.env.Environment
import org.springframework.stereotype.Component
@Component
class MyBean : EnvironmentAware {
private var instanceId: String? = null
override fun setEnvironment(environment: Environment) {
instanceId = environment.getProperty("vcap.application.instance_id")
}
// ...
}
所有 Cloud Foundry 属性都以vcap
.
您可以使用vcap
属性来访问应用程序信息(例如应用程序的公共 URL)和服务信息(例如数据库凭据)。
请参阅CloudFoundryVcapEnvironmentPostProcessor
API 文档以获取完整详细信息。
Java CFEnv 项目更适合配置数据源等任务。 |
Kubernetes
Spring Boot 通过检查环境中的"*_SERVICE_HOST"
和"*_SERVICE_PORT"
变量。
您可以使用spring.main.cloud-platform
configuration 属性。
Spring Boot 可帮助您管理应用程序的状态,并使用 Actuator 使用 HTTP Kubernetes Probes 将其导出。
Kubernetes 容器生命周期
当 Kubernetes 删除应用程序实例时,关闭过程同时涉及多个子系统:关闭钩子、注销服务、从负载均衡器中删除实例...... 由于此关闭处理是并行发生的(并且由于分布式系统的性质),因此有一个窗口,在此期间,流量可以路由到也已开始关闭处理的 Pod。
您可以在 preStop 处理程序中配置睡眠执行,以避免将请求路由到已开始关闭的 Pod。 此睡眠时间应足够长,以便新请求停止路由到 Pod,并且其持续时间因部署而异。
如果您使用的是 Kubernetes 1.32 或更高版本,则可以使用 Pod 配置文件中的 PodSpec 配置 preStop 处理程序,如下所示:
spec:
containers:
- name: "example-container"
image: "example-image"
lifecycle:
preStop:
sleep:
seconds: 10
如果您还没有使用 Kubernetes 1.32,您可以使用exec
调用的命令sleep
.
spec:
containers:
- name: "example-container"
image: "example-image"
lifecycle:
preStop:
exec:
command: ["sh", "-c", "sleep 10"]
容器需要有一个 shell 才能工作。 |
一旦预停止钩子完成,SIGTERM 将被发送到容器并开始正常关闭,从而允许完成任何剩余的正在进行的请求。
当 Kubernetes 向 Pod 发送 SIGTERM 信号时,它会等待一个指定的时间,称为终止宽限期(默认值为 30 秒)。
如果容器在宽限期后仍在运行,则会向它们发送 SIGKILL 信号并强制删除。
如果 Pod 关闭所需的时间超过 30 秒,这可能是因为您已将spring.lifecycle.timeout-per-shutdown-phase ,请确保通过设置terminationGracePeriodSeconds 选项。 |
赫罗库
Heroku 是另一个流行的 PaaS 平台。
要自定义 Heroku 构建,您需要提供一个Procfile
,它提供了部署应用程序所需的咒语。
Heroku 分配一个port
,然后确保路由到外部 URI 有效。
您必须将应用程序配置为侦听正确的端口。
以下示例显示了Procfile
对于我们的入门 REST 应用程序:
web: java -Dserver.port=$PORT -jar target/demo-0.0.1-SNAPSHOT.jar
Spring Boot 使-D
参数可作为可从 Spring 访问的属性Environment
实例。
这server.port
配置属性被馈送到嵌入式 Tomcat、Jetty 或 Undertow 实例,然后在启动时使用该端口。
这$PORT
环境变量是由 Heroku PaaS 分配给我们的。
这应该是您需要的一切。
Heroku 部署最常见的部署工作流程是git push
代码到生产环境,如以下示例所示:
$ git push heroku main
这将导致以下结果:
Initializing repository, done.
Counting objects: 95, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (78/78), done.
Writing objects: 100% (95/95), 8.66 MiB | 606.00 KiB/s, done.
Total 95 (delta 31), reused 0 (delta 0)
-----> Java app detected
-----> Installing OpenJDK... done
-----> Installing Maven... done
-----> Installing settings.xml... done
-----> Executing: mvn -B -DskipTests=true clean install
[INFO] Scanning for projects...
Downloading: https://repo.spring.io/...
Downloaded: https://repo.spring.io/... (818 B at 1.8 KB/sec)
....
Downloaded: https://s3pository.heroku.com/jvm/... (152 KB at 595.3 KB/sec)
[INFO] Installing /tmp/build_0c35a5d2-a067-4abc-a232-14b1fb7a8229/target/...
[INFO] Installing /tmp/build_0c35a5d2-a067-4abc-a232-14b1fb7a8229/pom.xml ...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 59.358s
[INFO] Finished at: Fri Mar 07 07:28:25 UTC 2014
[INFO] Final Memory: 20M/493M
[INFO] ------------------------------------------------------------------------
-----> Discovering process types
Procfile declares types -> web
-----> Compressing... done, 70.4MB
-----> Launching... done, v6
https://agile-sierra-1405.herokuapp.com/ deployed to Heroku
To [email protected]:agile-sierra-1405.git
* [new branch] main -> main
您的应用程序现在应该在 Heroku 上启动并运行。 有关更多详细信息,请参阅将 Spring Boot 应用程序部署到 Heroku。
开放
OpenShift 有许多资源描述了如何部署 Spring Boot 应用程序,包括:
亚马逊云科技 (AWS)
Amazon Web Services 提供了多种安装基于 Spring Boot 的应用程序的方法,可以作为传统的 Web 应用程序 (war) 或作为带有嵌入式 Web 服务器的可执行 jar 文件。 选项包括:
-
AWS 弹性 Beanstalk
-
AWS 代码部署
-
AWS 运营工作
-
AWS 云形成
-
AWS 容器注册表
每个都有不同的功能和定价模型。 在本文档中,我们将介绍如何使用 AWS Elastic Beanstalk。
AWS 弹性 Beanstalk
如官方 Elastic Beanstalk Java 指南中所述,部署 Java 应用程序有两个主要选项。 您可以使用“Tomcat 平台”或“Java SE 平台”。
使用 Java SE 平台
此选项适用于生成jar文件并运行嵌入式Web容器的Spring Boot项目。
Elastic Beanstalk 环境在端口 80 上运行一个 nginx 实例,以代理在端口 5000 上运行的实际应用程序。
要配置它,请将以下行添加到您的application.properties
文件:
-
Properties
-
YAML
server.port=5000
server:
port: 5000
上传二进制文件而不是源
默认情况下,Elastic Beanstalk 会上传源代码并在 AWS 中编译它们。
但是,最好上传二进制文件。
为此,请将类似于以下的行添加到您的
|
通过设置环境类型降低成本
默认情况下,Elastic Beanstalk 环境是负载均衡的。 负载均衡器的成本很高。 为避免该成本,请将环境类型设置为“单实例”,如 Amazon 文档中所述。 您还可以使用 CLI 和以下命令创建单实例环境:
|
总结
这是访问 AWS 的最简单方法之一,但还有更多内容需要涵盖,例如如何将 Elastic Beanstalk 集成到任何 CI/CD 工具中,使用 Elastic Beanstalk Maven 插件而不是 CLI 等。 有一篇博客文章更详细地介绍了这些主题。
CloudCaptain 和 Amazon Web Services
CloudCaptain 的工作原理是将 Spring Boot 可执行 jar 或 war 转换为最小的 VM 映像,该映像可以原封不动地部署在 VirtualBox 或 AWS 上。 CloudCaptain 为 Spring Boot 提供了深度集成,并使用 Spring Boot 配置文件中的信息自动配置端口和健康检查 URL。 CloudCaptain 将此信息用于它生成的映像以及它预置的所有资源(实例、安全组、弹性负载均衡器等)。
创建 CloudCaptain 账户后,将其连接到您的 AWS 账户,安装最新版本的 CloudCaptain 客户端,并确保应用程序是由 Maven 或 Gradle 构建的(例如,通过使用mvn clean package
),您可以使用类似于以下的命令将 Spring Boot 应用程序部署到 AWS:
$ boxfuse run myapp-1.0.jar -env=prod
请参阅boxfuse run
文档以获取更多选择。
如果有boxfuse.conf
文件存在于当前目录中,则将其考虑。
默认情况下,CloudCaptain 会激活名为boxfuse 启动时。
如果您的可执行 jar 或 war 包含application-boxfuse.properties 文件中,CloudCaptain 的配置基于它包含的属性。 |
此时,CloudCaptain 会为您的应用程序创建一个映像,上传它,并在 AWS 上配置和启动必要的资源,从而产生类似于以下示例的输出:
Fusing Image for myapp-1.0.jar ...
Image fused in 00:06.838s (53937 K) -> axelfontaine/myapp:1.0
Creating axelfontaine/myapp ...
Pushing axelfontaine/myapp:1.0 ...
Verifying axelfontaine/myapp:1.0 ...
Creating Elastic IP ...
Mapping myapp-axelfontaine.boxfuse.io to 52.28.233.167 ...
Waiting for AWS to create an AMI for axelfontaine/myapp:1.0 in eu-central-1 (this may take up to 50 seconds) ...
AMI created in 00:23.557s -> ami-d23f38cf
Creating security group boxfuse-sg_axelfontaine/myapp:1.0 ...
Launching t2.micro instance of axelfontaine/myapp:1.0 (ami-d23f38cf) in eu-central-1 ...
Instance launched in 00:30.306s -> i-92ef9f53
Waiting for AWS to boot Instance i-92ef9f53 and Payload to start at https://52.28.235.61/ ...
Payload started in 00:29.266s -> https://52.28.235.61/
Remapping Elastic IP 52.28.233.167 to i-92ef9f53 ...
Waiting 15s for AWS to complete Elastic IP Zero Downtime transition ...
Deployment completed successfully. axelfontaine/myapp:1.0 is up and running at https://myapp-axelfontaine.boxfuse.io/
您的应用程序现在应该在 AWS 上启动并运行。
请参阅有关在 EC2 上部署 Spring Boot 应用程序的博客文章以及 CloudCaptain Spring Boot 集成的文档,以开始使用 Maven 构建来运行该应用程序。
天蓝色
本入门指南将指导你将 Spring Boot 应用程序部署到 Azure Spring Cloud 或 Azure 应用服务。
谷歌云
Google Cloud 有多个选项可用于启动 Spring Boot 应用程序。 最容易上手的可能是 App Engine,但您也可以找到在使用 Container Engine 的容器中或在使用 Compute Engine 的虚拟机上运行 Spring Boot 的方法。
如需将您的第一个应用部署到 App Engine 标准环境,请按照本教程作。
或者,App Engine Flex 要求您创建app.yaml
文件来描述应用所需的资源。
通常,您将此文件放入src/main/appengine
,它应该类似于以下文件:
service: "default"
runtime: "java17"
env: "flex"
handlers:
- url: "/.*"
script: "this field is required, but ignored"
manual_scaling:
instances: 1
health_check:
enable_health_check: false
env_variables:
ENCRYPT_KEY: "your_encryption_key_here"
您可以通过将项目 ID 添加到构建配置来部署应用程序(例如,使用 Maven 插件),如以下示例所示:
<plugin>
<groupId>com.google.cloud.tools</groupId>
<artifactId>appengine-maven-plugin</artifactId>
<version>2.4.4</version>
<configuration>
<project>myproject</project>
</configuration>
</plugin>
然后使用mvn appengine:deploy
(您需要先进行身份验证,否则构建失败)。