Spring Boot 应用程序五种部署方式

翻译自 Deploying Spring Boot Applications[1]


原作者 Murat Artim[2]


翻译水平有限,有些地方可能翻译的不太准确,敬请谅解,也欢迎在评论区提出修改建议

可以使用各种方法将 Spring Boot 应用程序部署到生产系统中。在本文中,我们将通过以下 5 种方法来部署 Spring Boot 应用程序:

  • 使用 Java Archive (JAR) 作为独立应用程序进行部署
  • 将 Web Application Archive (WAR) 部署到 servlet 容器中
  • 在 Docker 容器中部署
  • 部署在 NGINX Web 服务器后面 - 直接设置
  • 部署在 NGINX Web 服务器后面 - 容器化设置


1. 使用 Java Archive (JAR) 作为独立应用程序进行部署

Spring Boot 应用程序可以轻松打包到 JAR 文件中,并作为独立应用程序进行部署。这是通过 spring-boot-maven-plugin 这个插件完成的。一旦 Spring 项目通过

Spring Initializr[3] 创建为 Maven 项目,插件就会自动添加到 pom.xml 中。

<code><build>
<plugins>
<plugin>
<groupid>org.springframework.boot/<groupid>
<artifactid>spring-boot-maven-plugin/<artifactid>
/<plugin>
/<plugins>
/<build>/<code>

要将应用程序打包在单个 jar 文件中,需要在项目目录下运行 maven 命令 mvn package。这将把应用程序打包到一个可执行的 jar 文件中,该文件包含所有依赖项(包括嵌入式 servlet 容器 ,如果它是一个 Web 应用程序)。要运行 jar 文件,请使用以下标准 JVM 命令 java -jar <jar-file-name>.jar。/<jar-file-name>


2. 将 Web Application Archive (WAR) 部署到 servlet 容器中

可以将 Spring Boot 应用程序打包到 WAR 文件中,以部署到现有的 servlet 容器(例如 Tomcat,Jetty 等)中。可以按如下方式完成:

在 pom.xml 文件中,通过 <packaging> war packaging> 指定为 WAR 包。这会将应用程序打包成 WAR 文件(而不是 JAR)。在第二步,将 Tomcat(servlet 容器)依赖关系的范围设置为 provided(以便它不会部署到 WAR 文件中):/<packaging>

<code><dependency>
<groupid>org.springframework.boot/<groupid>
<artifactid>spring-boot-starter-tomcat/<artifactid> <scope>provided/<scope>
/<dependency>/<code>

通过继承 SpringBootServletInitializer 并重写 configure 方法来初始化 Tomcat 所需的 Servlet 上下文,如下所示:

<code>@SpringBootApplication
public class DemoApp extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(DemoApp.class);
}
public static void main(String[] args) {
SpringApplication.run(DemoApp.class, args);
}
}/<code>

要将应用程序打包到 war 文件中,请在项目目录下运行标准 maven 命令mvn clean package。这将生成可以部署到 servlet 容器中的 WAR 包。要在现有 Tomcat 容器中运行应用程序,请将生成的 WAR 文件复制到tomcat/webapps/目录。


3. 在 Docker 容器中部署

在将应用程序部署到 Docker 容器之前,我们首先要将应用程序打包在 JAR 文件中。之前已经解释了这个过程,因此我假设我们有一个 jar 文件。

在第一步,我们需要构建一个容器镜像。为此,我们首先在项目根目录中创建一个 Dockerfile 文件,如下所示:

<code># latest oracle openjdk is the basis 将最新的oracle openjdk作为基础
FROM openjdk:oracle
# copy jar file into container image under app directory 将jar文件复制到容器镜像的app目录
COPY target/demoApp.jar app/demoApp.jar

# expose server port accept connections 暴露服务端口接收连接
EXPOSE 8080
# start application 运行应用程序
CMD ["java", "-jar", "app/demoApp.jar"]/<code>

请注意,在上面的代码片段中,我们假设应用程序 JAR 文件“demoApp.jar”位于项目的 target 目录下。我们还假设嵌入式 servlet 端口是 8080(这是 Tomcat 的默认情况)。

我们现在可以使用以下命令构建 Docker 镜像(Dockerfile 所在的位置):

<code>docker image build -t demo-app:latest ./<code>

其中 -t 是要构建的镜像的名称和标记。构建镜像后,我们可以通过以下方式创建和运行容器:

<code>docker container run -p 8080:8080 -d --name app-container demo-app/<code>

其中-p将主机端口(映射)到容器端口(在这种情况下,两者都是 8080)。选项-d(detach)是指在后台运行容器,- name指定容器的名称。


4. 部署在 NGINX Web 服务器后面 - 直接设置

为实际生产配置 servlet 容器(例如 Tomcat 或 Jetty )(即在端口 80 上运行,没有 root 用户和使用 SSL)可能不是直接的(但可行)。因此,建议在 Spring Boot 应用程序前使用 Web 服务器(如 Nginx)。这可以通过两种方式完成: 直接设置或容器设置。在本节中,我们将演示直接设置。

在直接设置中,我们直接在 localhost 上运行 Nginx Web 服务器和 Spring Boot 应用程序(当然在不同的端口上)。我们让 Ngnix 代理 REST 请求到 Spring Boot 应用程序。为了这:

1.通过 sudo apt-get install nginx 在 Linux 上安装 Nginx Web 服务器

2.使用文本编辑器打开文件/etc/ngnix/sites-available/default

3.比如说,我们有两个 Spring Boot 应用程序需要代理。可以用以下内容替换文件中的 location 块。请注意,可以在此处[4]找到所有 Nginx-Java 配置

<code>location /app1 {
proxy_pass http://localhost:8080;
}
location /app2 {
proxy_pass http://localhost:9000;
}/<code>

基于此,来自 http://localhost/app1/的请求将被定向到 /http://localhost:8080/,来自 http://localhost/app2/的请求将被定向到 /http://localhost:9000/。


4.1 负载均衡

如果您正在运行 Spring Boot 应用程序的多个实例,则可以启用 Nginx 以应用负载均衡。例如,如果我们在端口 8080,8081 和 8082 上运行 3 个 app1 实例。我们可以在这些服务器之间进行负载均衡,如下所示:

打开文件 /etc/ngnix/sites-available/default 并在文件顶部添加以下内容(在服务器内容之前):

<code># configure load-balancing 配置负载均衡
upstream backend {
server localhost:8080;
server localhost:8081;
server localhost:8082;
}/<code>

修改 app1 的 proxy_pass 参数,如下所示:

<code>location /app1 {
proxy_pass http://backend;
}/<code>

基于此,来自 http://localhost/app1/ 的请求将被定向到 /http://localhost:8080/,/http://localhost:8081/或 /http://localhost:8082/的其中之一。


5. 部署在 NGINX Web 服务器后面 - 容器化设置

在容器化设置中,我们将 Nginx Web 服务器和所有 Spring Boot 应用程序部署在单独的 Docker 容器上。我们让 Nginx(在自己的容器中运行)向 Spring Boot 应用程序容器代理 REST 请求。

我们首先将所有 Spring Boot 应用程序打包在 jar 文件中(之前已经解释过)。此时,请注意通过向 application.properties(或 application.yml)文件添加以下代码来为每个 Spring Boot 应用程序设置单个服务器端口和根上下文路径:

<code>server.port=8082
server.servlet.context-path=/search-service
/<code>

然后我们将生成的 jar 包部署在单独的 Docker 容器中(之前也有解释)。

例如,我们部署了四个 Spring Boot 应用程序; 一个“分析服务”实例和三个“搜索服务”实例。搜索服务的三个实例将由 Nginx 负载均衡。我们的基本架构如下所示:


Spring Boot 应用程序五种部署方式

我们基于默认配置创建 Nginx 配置文件 nginx.conf 。我们为每个服务添加负载均衡和代理信息,如下所示:

<code>http {

upstream backend {
server search-service-1:8080;
server search-service-2:8081;
server search-service-3:8082;
}
server {
listen 80 default_server;
listen [::]:80 default_server;
root /var/www/html;
server_name _;
location /search-service {
proxy_pass http://backend/search-service;
}
location /analysis-service {
proxy_pass http://analysis-service:8083/analysis-service;
}
}
}
events { worker_connections 1024; }/<code>

基于此,来自http://localhost/search-service/的请求将被定向到 http://search-service-1:8080/search-service/, /http://search-service-2:8081/search-service/和 http://search-service-3:8082/search-service/,来自 http://localhost/analysis-service/ 的请求将被定向到 http://analysis-service:8083/analysis-service/。

创建配置文件(nginx.conf)后,我们将在 Docker 容器中部署 Nginx Web 服务器。为此,我们创建一个 Dockerfile ,如下所示:

<code># latest nginx 最新的nginx
FROM nginx
# copy custom configuration file 复制自定义配置文件
COPY nginx.conf /etc/nginx/nginx.conf
# expose server port 暴露服务端口
EXPOSE 80
# start server 开启服务
CMD ["nginx", "-g", "daemon off;"]/<code>

我们为 Nginx Web 服务器构建一个 Docker 镜像,如下所示:

<code>docker image build -t custom-nginx:latest ./<code>

构建所有 Docker 镜像后,可以通过在以下 docker-compose.yml 文件上运行docker-compose up命令来部署所有系统:

<code>version: '3.7'
services:
nginx_server:
image: custom-nginx
ports:
- '80:80'
networks:
- demo-network
depends_on:
- "search-service-1"
- "search-service-2"
- "search-service-3"
- "analysis-service"
search-service-1:
image: search-service-1
ports:
- '8080:8080'
networks:
- demo-network
search-service-2:
image: search-service-2
ports:
- '8081:8081'
networks:
- demo-network
search-service-3:
image: search-service-3
ports:
- '8082:8082'
networks:
- demo-network
analysis-service:
image: analysis-service
ports:
- '8083:8083'
networks:
- demo-network
networks:
demo-network:

name: demo-network/<code>

以上,我们演示了部署 Spring Boot 应用程序的五种方法。选择哪种部署方式要基于整体架构以及目标平台的要求,例如安全性和可用资源。

[1] Deploying Spring Boot Applications: https://medium.com/swlh/deploying-spring-boot-applications-15e14db25ff0

[2] Murat Artim: https://medium.com/@muratartim_5366

[3] Spring Initializr: https://start.spring.io/

[4] 此处: https://www.nginx.com/resources/wiki/start/topics/examples/javaservers/


分享到:


相關文章: