雲原生時代高效能Java框架—Quarkus（二）

東溪陳姓少年發表於2020-07-24
Java框架

——— *構建Quarkus本地映象、容器化部署Quarkus專案*

Quarkus系列博文

概覽

上一篇文章主要介紹了Quarkus以及給Quarkus提供“神力”的Java虛擬機器GraalVM，並演示瞭如何安裝GraalVM以及Quarkus的初步用法。本文將主要指向Quarkus的“亮點”——本地化應用程式。

以下是本文的兩個目標：

  • 將Quarkus開發的Java應用程式編譯成本地可執行檔案。
  • 將本地可執行檔案打包到容器中。

注：在本文中本地可執行檔案又稱本地映象，二者意思相同。

環境準備

以下為本文所演示時的環境配置

  • Intellij IDEA
  • Maven
  • GraalVM 20.1.0
  • Docker

接下來需要安裝GraalVM的一個擴充套件——“native-image“，此擴充套件用於將Java程式編譯成本地可執行檔案，我們執行以下命令：

gu install native-image

執行以下命令，檢視擴充套件是否已安裝：

$ native-image --version

img

生成本地可執行檔案

生成本地可執行檔案的步驟如下圖：

img

IDEA開啟上一篇文章建立的專案，並開啟控制檯，執行maven命令：

./mvnw package -Pnative

控制檯輸出以下內容：

[INFO] Scanning for projects...
...
[INFO] Building untitled 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
... 
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running com.example.ExampleResourceTest
2020-07-19 22:24:08,962 INFO  [io.quarkus] (main) Quarkus 1.6.0.Final on JVM started in 1.085s. Listening on: http://0.0.0.0:8081
...
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
...
[INFO] [io.quarkus.deployment.pkg.steps.NativeImageBuildStep] Running Quarkus native-image plugin on GraalVM Version 20.1.0 (Java Version 11.0.7)
...
[INFO] [io.quarkus.deployment.QuarkusAugmentor] Quarkus augmentation completed in 93802ms
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:45 min
[INFO] Finished at: 2020-07-19T22:25:44+08:00
[INFO] ------------------------------------------------------------------------

開啟專案中的target資料夾

img

可以看到其中有個重要的檔案:XXX-runner，它是一個對JVM不依賴的本地可執行檔案，我們可以執行他來啟動應用程式。

$ ./target/untitled-1.0-SNAPSHOT-runner

img

成功啟動應用程式，並且啟動速度非常快?！

對比

在這裡我們可以對比本地可執行檔案與傳統基於jvm啟動速度的對比

執行如下命令，生成傳統應用程式的jar檔案：

./mvnw package

分別執行本地可執行檔案和jar檔案：

img

速度差異非常的懸殊！

相關配置

開啟專案根目錄的pom.xml，可以看到如下配置：

<profiles>
    <profile>
        <id>native</id>
        <properties>
            <quarkus.package.type>native</quarkus.package.type>
        </properties>
    </profile>
</profiles>

我們可以在id為native的profile中配置具體的配置項引數來自定義本地映象（本地可執行檔案）的生成。

如下為quarkus提供的具體配置列表：

Quarkus提供了許多生成本地映象（native-image即本地可執行檔案）的配置項，點選檢視（可左右滑動）。

容器化本地可執行檔案

我們可以很輕鬆的將Java應用程式的jar包進行容器化，當然我們也可以很輕鬆的將上一步生成的本地可執行檔案進行容器化。

容器化本地可執行檔案的步驟如下：

img容器化本地可執行檔案

新增配置

我們要將生成的本地可執行檔案進行容器化，所以需要考慮到本地可執行檔案對環境的相容問題，在這裡所生成的本地可執行檔案的格式應該和docker映象中的環境相容了，而不是我們的本機環境（MacOS，Linux，Windows等等）。因為不同的作業系統支援的本地可執行檔案的格式並不一樣，quarkus在生成本地可執行檔案的時候會根據不同的作業系統環境而選擇不同的可執行檔案格式。

首先我們在專案的src/main/resources/application.properties檔案中新增配置：

quarkus.native.container-runtime=docker

上面配置表明在容器化本地可執行檔案時將基於docker環境，我們也可以基於其他的容器環境，比如podman。

執行以下命令生成相容docker容器環境的本地可執行檔案：

./mvnw package -Pnative -Dquarkus.native.container-build=true

執行以下命令，將本地可執行檔案打包成docker映象：

docker build -f src/main/docker/Dockerfile.native -t quarkus-quickstart/getting-started .

生成完畢，執行以下命令即可啟動該容器：

docker run -i --rm -p 8080:8080 quarkus-quickstart/getting-started

可以看到通過容器方式啟動應用程式速度也很快

img

我們可以看一下這背後的Dockerfile，開啟src/main/docker/Dockerfile.native：

FROM registry.access.redhat.com/ubi8/ubi-minimal:8.1
WORKDIR /work/
RUN chown 1001 /work \
    && chmod "g+rwX" /work \
    && chown 1001:root /work
COPY --chown=1001:root target/*-runner /work/application

EXPOSE 8080
USER 1001

CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]

Quarkus使用ubi-minimal映象作為容器的基礎映象，它是一個通用基本映象，Dockerfiles使用基本映象的最小版本來減小生成的映象的大小。

無GraalVM環境下的映象生成

當我們處理一個CI/CD的環境或其他本地無GraalVM的環境時，此時就不能在本地生成本地可執行檔案了。我們可以通過在docker中處理這些操作，在專案的src/main/docker中新增檔案Dockerfile.multistage，並在檔案中新增下面內容：

## Stage 1 : build with maven builder image with native capabilities
FROM quay.io/quarkus/centos-quarkus-maven:20.1.0-java11 AS build
COPY pom.xml /usr/src/app/
RUN mvn -f /usr/src/app/pom.xml -B de.qaware.maven:go-offline-maven-plugin:1.2.5:resolve-dependencies
COPY src /usr/src/app/src
USER root
RUN chown -R quarkus /usr/src/app
USER quarkus
RUN mvn -f /usr/src/app/pom.xml -Pnative clean package

## Stage 2 : create the docker final image
FROM registry.access.redhat.com/ubi8/ubi-minimal
WORKDIR /work/
COPY --from=build /usr/src/app/target/*-runner /work/application

# set up permissions for user `1001`
RUN chmod 775 /work /work/application \
  && chown -R 1001 /work \
  && chmod -R "g+rwX" /work \
  && chown -R 1001:root /work

EXPOSE 8080
USER 1001

CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]

這是一個多階段的映象打包過程，第一階段我們在docekr中構建本地可執行檔案，第二階段再將本地可執行檔案打包成映象。

執行如下命令：

docker build -f src/main/docker/Dockerfile.multistage -t quarkus-quickstart/getting-started .

如上操作將兩個階段的操作整合在一起，並生成了最終的映象。

執行如下命令啟動容器：

docker run -i --rm -p 8080:8080 quarkus-quickstart/getting-started

測試本地可執行檔案

開啟專案中的測試資料夾，可以看到有如下兩個件

img

其中ExampleResourceTest類為普通的Java測試類，他的執行基於JVM。

@QuarkusTest
public class ExampleResourceTest {

    @Test
    public void testHelloEndpoint() {
        given()
            .when().get("/hello")
            .then()
            .statusCode(200)
            .body(is("hello"));
    }

}

上述測試類使用了@QuarkusTest註解，這個註解類似於Spring Boot中的@SpringBootTest，用來在測試前啟動上下文。

而NativeExampleResourceIT則不同，該測試類的程式碼如下：

package com.example;

import io.quarkus.test.junit.NativeImageTest;

@NativeImageTest 1️⃣
public class NativeExampleResourceIT extends ExampleResourceTest 2️⃣{

    // Execute the same tests but in native mode.
}

1️⃣：@NativeImageTest 註解表示此測試類是一個基於本地映象的測試類，在測試之前，從本地可執行檔案啟動應用程式。可執行檔案位置可在Maven的pom.xml中配置（maven-failsafe-plugin的native.image.path屬性）。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-failsafe-plugin</artifactId>
    <version>${surefire-plugin.version}</version>
    <executions>
        <execution>
            <goals>
                <goal>integration-test</goal>
                <goal>verify</goal>
            </goals>
            <configuration>
                <systemPropertyVariables>
                    <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                    <maven.home>${maven.home}</maven.home>
                </systemPropertyVariables>
            </configuration>
        </execution>
    </executions>
</plugin>

2️⃣：這裡的程式碼表示我們擴充套件了之前的測試，但是您也可以自定義實現您自己的測試。

執行本地映象測試和普通測試的方式有差異，本地映象測試需要使用Maven命令來啟動，我們在IDEA控制檯中執行./mvnw verify -Pnative即可啟動本地映象測試。注意：由於我們上一步中在專案的配置檔案中新增了quarkus.native.container-runtime=docker，現在我們需要去掉，否則生成的可執行檔案格式可能和你本機的格式不相容。

[INFO] Scanning for projects...
[INFO] 
[INFO] ------------------------< com.example:untitled >------------------------
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running com.example.NativeExampleResourceIT
Executing [/Users/chengang/IdeaProjects/quarkus-demo/target/untitled-1.0-SNAPSHOT-runner, -Dquarkus.http.port=8081, -Dquarkus.http.ssl-port=8444, -Dtest.url=http://localhost:8081, -Dquarkus.log.file.path=target/target/quarkus.log]
__  ____  __  _____   ___  __ ____  ______ 
 --/ __ \/ / / / _ | / _ \/ //_/ / / / __/ 
 -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \   
--\___\_\____/_/ |_/_/|_/_/|_|\____/___/   
2020-07-23 22:21:09,626 INFO  [io.quarkus] (main) untitled 1.0-SNAPSHOT native (powered by Quarkus 1.6.0.Final) started in 0.019s. Listening on: http://0.0.0.0:8081
2020-07-23 22:21:09,626 INFO  [io.quarkus] (main) Profile prod activated. 
2020-07-23 22:21:09,626 INFO  [io.quarkus] (main) Installed features: [cdi, resteasy]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.3 s - in com.example.NativeExampleResourceIT
[INFO] 
[INFO] Results:
[INFO] 
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] 
[INFO] --- maven-failsafe-plugin:2.22.1:verify (default) @ untitled ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  02:17 min
[INFO] Finished at: 2020-07-23T22:21:11+08:00
[INFO] ------------------------------------------------------------------------
chengang@chengangdeMacBook-Pro quarkus-demo %

測試通過！

總結

本文主要介紹了Quarkus框架的本地化相關操作，我們具體介紹瞭如何將Quarkus專案編譯成本地可執行檔案，隨後又演示瞭如何將生成的可執行檔案打包成Docker映象，最後我們演示瞭如何以本地可執行檔案的形式測試業務程式碼。隨著將Java應用程式編譯成本地映象，Java的效能優勢有了極大的提升。

本文參考：https://quarkus.io/guides/building-native-image

??????????????????

歡迎訪問筆者部落格：blog.dongxishaonian.tech

關注筆者公眾號，推送各類原創/優質技術文章 ⬇️

WechatIMG6

相關文章