使用 Jib 從 Google App Engine Java 應用程式遷移至 Cloud Run

1. 總覽

本系列程式碼研究室 (可自行調整進度的實作教學課程) 旨在協助 Google App Engine (標準) Java 開發人員完成一系列遷移作業，以便將應用程式改為新一代應用程式。按照這些步驟操作，您就能更新應用程式，讓應用程式更具可攜性，並決定將應用程式容器化，以便在 Cloud Run (Google Cloud 的容器代管服務，也是 App Engine 的姊妹服務) 和其他容器代管服務中執行。

本教學課程將教您如何使用 Jib 將 App Engine 應用程式容器化，以便部署至 Cloud Run 全代管服務。您可以透過 Jib 建立 Docker 映像檔。Docker 是業界的知名平台，用於在容器中開發、傳送及執行應用程式。

除了說明從 App Engine 遷移至 Cloud Run 的必要步驟，您還會瞭解如何將 Java 8 App Engine 應用程式升級至 Java 17。

如果您的應用程式大量使用 App Engine 的舊版套裝組合服務或其他 App Engine 功能，建議您先從這些服務套裝組合中移除服務，或是更換這些功能，再遷移至 Cloud Run。如果您需要更多時間來研究遷移選項，或是想暫時繼續使用舊版套裝組合服務，可以升級至較新的執行階段，繼續存取 App Engine 套裝組合服務 (適用於 Java 11/17)。當應用程式更具可攜性後，請回到本程式碼研究室，瞭解如何將指示套用至應用程式。

在接下來的研究室中

• 使用 Cloud Shell
• 啟用 Cloud Run、Artifact Registry 和 Cloud Build API
• 使用 Jib 和 Cloud Build 將應用程式容器化
• 將容器映像檔部署至 Cloud Run

軟硬體需求

• Google Cloud Platform 專案：已啟用 GCP 帳單帳戶，且已啟用 App Engine
• 熟悉常見的 Linux 指令
• 具備開發和部署 App Engine 應用程式的基本知識
• 您想遷移至 Java 17 並部署至 Cloud Run 的 Java 8 Servlet 應用程式 (這可以是 App Engine 上的應用程式，或僅為來源)

問卷調查

您要如何使用這個教學課程？

只閱讀 閱讀並完成練習

您對使用 Java 的體驗評價為何？

新手 中級 熟練

請評估你使用 Google Cloud 服務的體驗。

新手 中級 熟練

2. 背景

App Engine 和 Cloud Functions 等平台式服務 (PaaS) 系統可為您的團隊和應用程式提供許多便利功能，例如讓系統管理員和開發人員專注於建構解決方案。有了無伺服器平台，應用程式就能視需要自動擴充，並透過按量計費的收費方式縮減至零，以便控管成本，還能使用各種常見的開發語言。

不過，容器的彈性也相當吸引人。容器可讓您選擇任何語言、任何程式庫和任何二進位檔，因此可同時享有無伺服器運算的便利性和容器的彈性。這就是 Cloud Run 的用途。

瞭解如何使用 Cloud Run 不在本程式碼研究室的範圍內；詳情請參閱 Cloud Run 說明文件。本課程的目標是讓您熟悉如何為 Cloud Run (或其他容器代管服務) 容器化 App Engine 應用程式。開始使用前，請務必瞭解幾個注意事項，主要的使用者體驗會略有不同。

在本程式碼研究室中，您將瞭解如何建構及部署容器。學習重點：

• 使用 Jib 將應用程式容器化
• 從 App Engine 設定遷移
• 並視需要定義 Cloud Build 的建構步驟。

這項作業會移除特定 App Engine 專屬功能。如果您不想採用這個做法，仍可升級至 Java 11/17 執行階段，同時將應用程式保留在 App Engine 上。

3. 設定/預先作業

1. 設定專案

在本教學課程中，您將在全新專案中使用 appengine-java-migration-samples 存放區中的範例應用程式。請確認專案具備有效的帳單帳戶。

如果您想將現有的 App Engine 應用程式移至 Cloud Run，可以改用該應用程式來完成本教學課程。

執行下列指令，為專案啟用必要的 API：

gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com run.googleapis.com

2. 取得基準範例應用程式

請在您自己的機器或 Cloud Shell 中複製範例應用程式，然後前往「baseline」資料夾。

這個範例是用於在 App Engine 上部署的 Java 8 (以 會為基礎) Datastore 應用程式。請按照 README 中的操作說明，瞭解如何為 App Engine 部署作業準備這個應用程式。

3. (選用) 部署基準應用程式

只有在您想確認應用程式在遷移至 Cloud Run 前可在 App Engine 上運作時，才需要執行下列步驟。

請參閱 README.md 中的步驟：

1. 安裝/重新熟悉 gcloud CLI
2. 使用 gcloud init 為專案初始化 gcloud CLI
3. 使用 gcloud app create 建立 App Engine 專案
4. 將應用程式範例部署至 App Engine

./mvnw package appengine:deploy -Dapp.projectId=$PROJECT_ID

5. 確認應用程式在 App Engine 上執行，不會出現任何問題

4. 建立 Artifact Registry 存放區

將應用程式容器化後，您需要推送及儲存映像檔。在 Google Cloud 中，建議您使用 Artifact Registry 來執行這項操作。

使用 gcloud 建立名為 migration 的存放區，如下所示：

gcloud artifacts repositories create migration --repository-format=docker \
--description="Docker repository for the migrated app" \
--location="northamerica-northeast1"

請注意，這個存放區使用 docker 格式類型，但目前有幾個可用的存放區類型。

到目前為止，您已有 App Engine 基準應用程式，Google Cloud 專案也已準備好將應用程式遷移至 Cloud Run。

4. 修改應用程式檔案

如果您的應用程式大量使用 App Engine 的舊版套裝組合服務、設定或其他 App Engine 專屬功能，建議您在升級至新執行階段時繼續存取這些服務。本程式碼研究室將針對已使用獨立服務的應用程式，或可透過重構來使用獨立服務的應用程式，示範遷移路徑。

1. 升級至 Java 17

如果您的應用程式使用 Java 8，請考慮升級至 11 或 17 等較新 LTS 候選版，以便跟上安全性更新並取得新的語言功能。

請先更新 pom.xml 中的屬性，加入下列項目：

<properties>
    <java.version>17</java.version>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
</properties>

這會將專案版本設為 17，並告知編譯器外掛程式您想要存取 Java 17 語言功能，以及希望編譯的類別與 Java 17 JVM 相容。

2. 加入網路伺服器

App Engine 和 Cloud Run 之間有許多差異，在兩者之間遷移時，請務必考量這些差異。兩者的差別在於，雖然 App Engine 的 Java 8 執行階段可為託管的應用程式提供及管理 Jetty 伺服器，但 Cloud Run 卻不需要。我們將使用 Spring Boot 向我們提供網路伺服器和 JDK 容器。

新增下列相依項目：

<dependencies>
<!-- ... -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
       <version>2.6.6</version>
       <exclusions>
           <!-- Exclude the Tomcat dependency -->
           <exclusion>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-tomcat</artifactId>
           </exclusion>
       </exclusions>
   </dependency>
   <!-- Use Jetty instead -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-jetty</artifactId>
       <version>2.6.6</version>
   </dependency>
<!-- ... -->
</dependencies>

Spring Boot 會預設嵌入 Tomcat 伺服器，但這個範例會排除該構件，並使用 Jetty，盡量減少遷移後的預設行為差異。我們也可以設定 Jetty 版本，與 App Engine 提供的版本相符。

<properties>
    <java.version>17</java.version>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
    <jetty.version>9.4.46.v20220331</jetty.version>
</properties>

3. 設定 Spring Boot

雖然 Spring Boot 不需修改即可重複使用 WhatsApp，但這項功能需要進行一些設定才能偵測。

在 com.example.appengine 套件中建立下列 MigratedServletApplication.java 類別：

package com.example.appengine;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@ServletComponentScan
@SpringBootApplication
@EnableAutoConfiguration
public class MigratedServletApplication {
    public static void main(String[] args) {
        SpringApplication.run(MigratedServletApplication.class, args);
    }
}

請注意，這包括 @ServletComponentScan 註解，該註解會在 目前套件中尋找任何 @WebServlets，並讓這些元素如預期般可用。

4. 將應用程式封裝為 JAR

雖然您可以使用 Jib 從戰爭開始將應用程式容器化，但將應用程式封裝為可執行的 JAR 會比較容易。這項作業不需要太多設定，特別是對於使用 Maven 做為建構工具的專案而言，因為 JAR 封裝是預設行為。

移除 pom.xml 檔案中的 packaging 標記：

<packaging>war</packaging>

接著，請新增 spring-boot-maven-plugin：

<plugins>
<!-- ... -->
  <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <version>2.6.6</version>
  </plugin>
<!-- ... -->
</plugins>

5. 遷移 App Engine 設定、服務和依附元件

如程式碼研究室一開始所述，Cloud Run 和 App Engine 的設計目的是提供不同的使用者體驗。App Engine 提供的某些功能 (例如 Cron 和 工作佇列 服務) 需要手動重新建立，我們會在後續模組中詳細說明。

範例應用程式不會使用舊版套裝組合服務，但使用者所擁有應用程式的使用者可參閱下列指南：

• 從服務套件遷移，找出合適的獨立服務。
• 將 XML 設定檔遷移至 YAML，適用於想在 App Engine 上遷移至 Java 11/17 執行階段的使用者。

由於您將從現在開始部署至 Cloud Run，因此可以移除 appengine-maven-plugin：

<plugin>
 <groupId>com.google.cloud.tools</groupId>
 <artifactId>appengine-maven-plugin</artifactId>
 <version>2.4.1</version>
 <configuration>
   <!-- can be set w/ -DprojectId=myProjectId on command line -->
   <projectId>${app.projectId}</projectId>
   <!-- set the GAE version or use "GCLOUD_CONFIG" for an autogenerated GAE version -->
   <version>GCLOUD_CONFIG</version>
 </configuration>
</plugin>

5. 容器化應用程式

此時，您可以直接從原始碼手動將應用程式部署至 Cloud Run。這是一個非常實用的選項，可在幕後使用 Cloud Build 提供免動手部署體驗。我們會在後續單元中更詳細說明來源部署作業。

或者，如果您需要進一步控管應用程式的部署方式，可以定義 cloudbuild.yaml 檔案，明確列出您要執行的建構步驟：

1. 定義 cloudbuild.yaml 檔案

在與 pom.xml 相同的層級建立以下 cloudbuild.yaml 檔案：

steps:
  # Test your build
  - name: maven:eclipse-temurin
    entrypoint: mvn
    args: ["test"]
  # Build with Jib
  - name: maven:eclipse-temurin
    entrypoint: mvn
    args: [ "compile", "com.google.cloud.tools:jib-maven-plugin:3.2.1:build", "-Dimage=northamerica-northeast1-docker.pkg.dev/PROJECT_ID/migration/visitors:jib"]
  # Deploy to Cloud Run
  - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
    entrypoint: gcloud
    args: [ 'run', 'deploy', 'visitors', '--image', 'northamerica-northeast1-docker.pkg.dev/PROJECT_ID/migration/visitors:jib', '--region', 'northamerica-northeast1', '--allow-unauthenticated']

在我們告知 Cloud Build 執行這些步驟後，系統會：

1. 使用 ./mvnw test 執行測試
2. 使用 Jib 建構映像檔、將映像檔推送至 Artifact 登錄檔並加上標記
3. 使用 gcloud run deploy 將映像檔部署至 Cloud Run

請注意，‘visitors' 會以所需的服務名稱提供給 Cloud Run。–allow-unauthenticated 旗標可讓使用者不必驗證就能造訪 webapp。請務必在 cloudbuild.yaml 檔案中將 PROJECT_ID 替換為專案 ID。

接下來，請新增下列 IAM 政策繫結，允許 Cloud Build 服務帳戶存取 Artifact Registry：

export PROJECT_ID=$(gcloud config list --format 'value(core.project)')
export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)" )

gcloud projects add-iam-policy-binding $PROJECT_ID \
--member=serviceAccount:$[e-mail] \
--role=roles/run.admin \
--project=$PROJECT_ID
gcloud iam service-accounts add-iam-policy-binding $[e-mail] \
--member=serviceAccount:$[e-mail] \
--role roles/iam.serviceAccountUser --project=$PROJECT_ID

2. 執行建構程序

您已告知 Cloud Build 所需的建構步驟，現在可以進行一鍵部署作業了。

執行下列指令：

gcloud builds submit

程序完成後，系統會建構容器映像檔、儲存在 Artifact Registry 中，並部署至 Cloud Run。

在本程式碼研究室的結尾，應用程式的外觀應與 java17-and-cloud-run/finish 中的範例相同。

這樣就大功告成囉！您已成功將 Java 8 App Engine 應用程式遷移至 Java 17 和 Cloud Run，現在可以更清楚瞭解切換和選擇代管選項時所需的工作。

6. 摘要/清理

恭喜！您已升級、容器化，並遷移應用程式，教學課程到此結束！

接下來，我們要進一步瞭解 CI/CD 和軟體供應鏈安全防護功能，您現在可透過 Cloud Build 進行部署：

• 使用 Cloud Build 建立自訂建構步驟
• 建立及管理自動建構觸發條件
• 在 Cloud Build 管道中使用隨選掃描功能

選用：清理及/或停用服務

如果您在本教學課程中在 App Engine 上部署範例應用程式，請務必停用應用程式，以免產生費用。當您準備好轉移至下一個程式碼研究室時，可以重新啟用該研究室。停用 App Engine 應用程式後，不會獲得任何流量的費用，不過如果 Datastore 用量超過免費配額，就可能要計費，所以刪除後必須超過限制。

另一方面，如果您不打算繼續遷移作業，並想完全刪除所有內容，可以刪除服務或關閉專案。

7. 其他資源

App Engine 遷移模組程式碼研究室問題/意見回饋

如果您在本程式碼研究室中發現任何問題，請先搜尋您的問題，再提交。搜尋及建立新問題的連結：

• 搜尋問題
• 提出新問題/意見回饋

遷移資源

• 套裝組合 App Engine 服務的遷移選項
• 設定 Cloud Build 的建構觸發條件
• 進一步瞭解如何遷移至 Java 11/17

線上資源

以下是與本教學課程相關的線上資源：

App Engine

• App Engine 說明文件
• App Engine 定價和配額資訊
• 比較第一代和第二代平台
• 對舊版執行階段的長期支援

其他雲端資訊

• Google Cloud「Always Free」級別
• Google Cloud CLI (gcloud CLI)
• 所有 Google Cloud 說明文件

影片

• 無伺服器遷移站
• 無伺服器 Expeditions
• 訂閱 Google Cloud Tech
• 訂閱 Google Developers

授權

這項內容採用的授權為 Creative Commons 姓名標示 2.0 通用授權。