將 Spring Boot 應用程式部署至 App Engine 標準環境

1. 事前準備

您可以輕鬆建立、維護及擴充 App Engine 應用程式，因應流量和資料儲存空間需求變化。使用 App Engine 就不需要維護伺服器。只要上傳應用程式，就能開始使用。

App Engine 應用程式會根據傳入的流量自動調度資源。負載平衡、微服務、授權、SQL 和 NoSQL 資料庫、記憶體快取、流量拆分、記錄、搜尋、版本管理、推出和復原，以及安全性掃描，均受原生支援且高度可自訂。

App Engine 標準環境和 App Engine 彈性環境支援多種程式設計語言，包括 Java、Python、PHP、NodeJS 和 Go。這兩種環境可讓開發人員充分彈性地控制應用程式的行為。每個環境都有各自的優點。詳情請參閱「選擇 App Engine 環境」。

您將學會如何將 Spring Boot 應用程式部署至 App Engine 標準環境。標準環境會在無人使用時將資源調度降至零，並在有人使用時自動調度資源！

必要條件

• 熟悉 Java 程式設計語言和工具
• 瞭解標準 Linux 文字編輯器，例如 Vim、Emacs 和 nano

執行步驟

• 如何在 App Engine 上建立 Spring Boot Java 應用程式

軟硬體需求

• 具備 Google Cloud 專案
• 瀏覽器，例如 Google Chrome

2. 設定和需求條件

自修實驗室環境設定

1. 登入 Google Cloud 控制台，然後建立新專案或重複使用現有專案。如果沒有 Gmail 或 Google Workspace 帳戶，請先建立帳戶。

• 專案名稱是這個專案參與者的顯示名稱。這是 Google API 未使用的字元字串。你隨時可以更新。
• 專案 ID 在所有 Google Cloud 專案中都是不重複的，而且設定後即無法變更。Cloud 控制台會自動產生專屬字串，通常您不需要在意該字串為何。在大多數程式碼研究室中，您需要參照專案 ID (通常標示為 PROJECT_ID)。如果您不喜歡產生的 ID，可以產生另一個隨機 ID。你也可以嘗試使用自己的名稱，看看是否可用。完成這個步驟後就無法變更，且專案期間會維持不變。
• 請注意，有些 API 會使用第三個值，也就是「專案編號」。如要進一步瞭解這三種值，請參閱說明文件。

注意：專案 ID 在全域中是唯一的，選定後就無法再供他人使用。您是該 ID 的唯一使用者。即使專案已刪除，ID 也無法再次使用

注意：如果使用 Gmail 帳戶，可以將預設位置設為「沒有機構」。如果你使用 Google Workspace 帳戶，請選擇適合貴機構的位置。

2. 接著，您需要在 Cloud 控制台中啟用帳單，才能使用 Cloud 資源/API。完成這個程式碼研究室的費用不高，甚至可能完全免費。如要關閉資源，避免在本教學課程結束後繼續產生費用，請刪除您建立的資源或專案。Google Cloud 新使用者可參加 $300 美元的免費試用計畫。

Cloud Shell

您將使用 Cloud Shell，這是 Google Cloud 中執行的指令列環境。

啟用 Cloud Shell

1. 在 Cloud 控制台，點選「啟用 Cloud Shell」 圖示 。

如果您是首次啟動 Cloud Shell，系統會顯示中繼畫面，說明這個指令列環境。如果出現中繼畫面，請按一下「繼續」。

佈建並連至 Cloud Shell 預計只需要幾分鐘。

這部虛擬機器已載入所有必要的開發工具，並提供永久的 5 GB 主目錄，而且可在 Google Cloud 運作，大幅提升網路效能並強化驗證功能。本程式碼研究室幾乎所有工作都可在瀏覽器上完成。

連至 Cloud Shell 後，您應該會看到驗證已完成，專案也已設為獲派的專案 ID。

2. 在 Cloud Shell 中執行下列指令，確認您已通過驗證：

gcloud auth list

指令輸出

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`

注意：gcloud 指令列工具是 Google Cloud 中功能強大的整合式指令列工具，並已預先安裝於 Cloud Shell。你會發現它支援 Tab 鍵自動完成功能。詳情請參閱 gcloud 指令列工具總覽。

3. 在 Cloud Shell 中執行下列指令，確認 gcloud 指令知道您的專案：

gcloud config list project

指令輸出

[core]
project = <PROJECT_ID>

如未設定，請輸入下列指令手動設定專案：

gcloud config set project <PROJECT_ID>

指令輸出

Updated property [core/project].

注意：如果您在 Cloud Shell 以外的環境完成本教學課程，請按照「設定應用程式預設憑證」一文的說明操作。

3. 建立新的 Spring Boot 網頁應用程式

啟動 Cloud Shell 後，您可以使用指令列，透過 Spring Initializr 產生新的 Spring Boot 應用程式。

$ curl https://start.spring.io/starter.tgz \
  -d bootVersion=3.0.5 \
  -d dependencies=web \
  -d type=maven-project \
  -d baseDir=gae-standard-example | tar -xzvf -
$ cd gae-standard-example

4. 更新 Maven pom.xml

您可以透過兩種方式部署 Java 伺服器應用程式：使用 Maven App Engine 外掛程式或 Gradle App Engine 外掛程式，或是部署 war 套件目錄。您將使用 Maven App Engine 外掛程式部署應用程式。

新增 Maven App Engine 外掛程式

更新 pom.xml，加入可簡化部署程序的 Google Cloud 外掛程式。您可以使用 Vim、nano 或 Emacs 編輯檔案。

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" ...>
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>com.google.cloud.tools</groupId>
        <artifactId>appengine-maven-plugin</artifactId>
        <version>2.4.4</version>
        <configuration>
          <version>1</version>
          <projectId>GCLOUD_CONFIG</projectId>
        </configuration>
      </plugin>
      ...
    </plugins>
  </build>
</project>

5. 新增 App Engine 描述元

1. 如要將應用程式部署至 App Engine 標準環境，您必須建立新的 src/main/appengine/app.yaml 描述元檔案。

$ mkdir -p src/main/appengine/
$ touch src/main/appengine/app.yaml

2. 編輯 src/main/appengine/app.yaml 檔案，並新增下列內容：

src/main/appengine/app.yaml

runtime: java17
instance_class: F1

注意：不同執行個體類別可使用的記憶體大小不同。F1 執行個體類別是最小的執行個體。如果是實際工作環境的應用程式，建議使用較大的執行個體來因應工作負載。詳情請參閱 app.yaml 設定檔。

6. 新增控制器

新增在 DemoApplication.java 中傳回 "hello world!" 的控制器。

src/main/java/com/example/demo/DemoApplication.java

package com.example.demo;

...

// Add imports
import org.springframework.web.bind.annotation.*;

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

// Add the controller.
@RestController
class HelloWorldController {
  @GetMapping("/")
  public String hello() {
    return "hello world!";
  }
}

7. 在本機執行應用程式

1. 確認 JAVA_HOME 已設為正確的 JDK 版本：

$ export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64/

2. 您可以使用 Spring Boot 外掛程式啟動 Spring Boot 應用程式：

$ ./mvnw -DskipTests spring-boot:run

3. 應用程式啟動後，請在 Cloud Shell 工具列中按一下「網頁預覽」，然後選取「透過以下通訊埠預覽：8080」。

瀏覽器會開啟分頁，並連線至您啟動的伺服器。

8. 將應用程式部署至 App Engine

1. 首先，請初始化專案，以便執行 App Engine 應用程式。此外，請初始化專案，在美國中部區域執行。

$ gcloud app create --region us-central
You are creating an app for project [...].
WARNING: Creating an App Engine application for a project is irreversible and the region
cannot be changed. More information about regions is at
https://cloud.google.com/appengine/docs/locations

注意：你也可以使用 gcloud app regions list 列出所有可用區域，然後選取其中一個。

2. 然後執行 mvn appengine:deploy，將應用程式部署至 App Engine 標準環境。

$ ./mvnw -DskipTests package appengine:deploy
... first time deploy may take a couple of minutes

注意：首次部署可能需要幾分鐘。在幕後，這項作業會佈建執行階段環境、網路和負載平衡器，並啟動應用程式。

3. 應用程式部署完成後，您可以在網頁瀏覽器中開啟 http://<project-id>.appspot.com 網址，或在 Cloud Shell 中使用下列指令，前往應用程式：

$ gcloud app browse
... [It may print out the URL for your app]

注意：您可以選擇為應用程式購買及使用頂層網域名稱，也可以使用您已註冊的網域名稱。

9. 清除

您無法刪除 App Engine 應用程式，但可以停用。

前往 Google Cloud 控制台中的 App Engine 和 Settings，然後選取 Disable Application：

或者，您也可以刪除整個專案：

$ gcloud projects delete YOUR-PROJECT-ID

10. 恭喜

您已學會編寫第一個 App Engine 網頁應用程式！

瞭解詳情

• 在 Google Cloud 中使用 Java
• App Engine
• Java 程式碼範例