在 App Engine 彈性環境中建立 Java 應用程式

在 App Engine 彈性環境中建立 Java 應用程式

區域 ID

REGION_ID 是 Google 根據您在建立應用程式時選取的地區所指派的縮寫代碼。此代碼不對應至國家/地區或省份，即使部分區域 ID 可能與常用的國家/地區和省份代碼相似。如果是 2020 年 2 月後建立的應用程式，App Engine 網址會包含 REGION_ID.r。如果是這段時間前建立的現有應用程式，網址可選擇是否包含地區 ID。

進一步瞭解區域 ID。

確定

注意： 如要將新的 Java 網頁服務部署至 Google Cloud，建議先瞭解 Cloud Run。

本快速入門導覽課程說明如何建立及部署可顯示簡短訊息的應用程式。範例應用程式使用 Java 17 版。

事前準備

本快速入門導覽課程假設您已在本機電腦上安裝 Java SE 17 Development Kit (JDK)。

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build API.

Enable the API

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build API.

Enable the API

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

1. 由於新專案中 Cloud Build 使用服務帳戶的預設行為有所變更，以及預設安全機構政策變更，您可能需要將額外角色授予部署服務帳戶。如要進一步瞭解如何授予特定角色，請參閱疑難排解指南。

其他必要條件

1. 使用您的專案將 App Engine 應用程式初始化，然後選擇地區：

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   收到系統提示時，選取 App Engine 應用程式的存放地區。

   注意：應用程式的地區設定完成後即無法更改。

2. 在本機電腦上安裝下列項目：

   • 下載並安裝 Git。
   • 下載並安裝 Maven 3.5 以上版本。本快速入門導覽課程使用 Apache Maven 3.5 以上的版本，在電腦上建構及執行範例應用程式。

App Engine 位置

App Engine 具有「地區性」，這表示執行應用程式的基礎架構位於特定地區，且由 Google 代管，可為該地區內的所有區域提供備援功能。

選擇應用程式的執行地區時，請將您在延遲時間、可用性和耐用性方面的要求，做為主要考量。一般來說，您可以選擇距離您應用程式使用者最近的地區，但您也應該考慮 App Engine 的可用位置，以及應用程式使用的其他Google Cloud 產品和服務的位置。如果跨多個位置使用服務，可能會影響應用程式的延遲時間和定價。

應用程式的地區設定完成後即無法更改。

注意： 在 App Engine 指令和 Google Cloud 控制台中，稱為 europe-west 和 us-central 的兩個位置，在 Google 說明文件其他位置則分別稱為 europe-west1 和 us-central1。

如果您已建立 App Engine 應用程式，可以透過下列方式查看其區域：

• 請執行 gcloud app describe 指令。

• 在 Google Cloud 控制台中開啟 App Engine 資訊主頁。區域會顯示在頁面頂端附近。

確定

下載 Hello World 應用程式

我們建立了 App Engine 適用的 Hello World 應用程式，方便您快速瞭解如何在 Google Cloud中部署應用程式。

1. 將 Hello World 範例應用程式存放區複製到本機電腦。

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples
   

   您也可以下載 zip 格式的範例，然後解壓縮該檔案。

2. 變更為包含範例程式碼的目錄。

      cd java-docs-samples/flexible/java-17/micronaut-helloworld
   

在本機電腦上執行 Hello World

在本機電腦上執行 Hello World 應用程式：

1. 執行下列指令：

   java -jar target/micronaut-helloworld-0.1.jar

2. 在網路瀏覽器中，輸入下列網址：

   http://localhost:8080

   如果您使用 Cloud Shell，請在工具列中按一下「Web Preview」(網頁預覽)，然後選取「Preview on port 8080」(透過以下通訊埠預覽：8080)。

此時頁面會顯示來自範例應用程式的「Hello World」訊息。請在終端機視窗中，按下 Ctrl+C 鍵來關閉網路伺服器。

在 App Engine 上部署並執行 Hello World

如要將您的應用程式部署到 App Engine 彈性環境：

1. 在 java-17/micronaut-helloworld 目錄執行下列指令，以部署 Hello World 應用程式：

   mvn clean package appengine:deploy

2. 啟動瀏覽器，並前往 https://PROJECT_ID.REGION_ID.r.appspot.com 查看應用程式

   gcloud app browse

   ，其中 PROJECT_ID 是您的專案 ID。 Google Cloud

此時，顯示 Hello World 訊息的頁面是由在 App Engine 執行個體上運作的網路伺服器提供。

恭喜！您已成功將第一個 App Engine 應用程式部署至 App Engine 彈性環境！

如果部署應用程式時發生錯誤，請參閱疑難排解提示。

請參閱下列各節，瞭解清除所用資源的資訊，並取得相關後續步驟的連結。

清除所用資源

如要避免支付費用，您可以刪除 Google Cloud 專案，這樣系統就會停止對該專案使用的所有資源計費。

注意：刪除專案會造成以下結果：

• 專案中的所有內容都會遭到刪除。 如果您使用現有專案來進行本文中的工作，刪除專案將一併刪除其中已完成的所有工作。
• 自訂的專案 ID 會消失。當您之前建立這個專案時，可能建立了想要在日後使用的自訂專案 ID。如要保留使用該專案 ID 的網址 (例如 appspot.com 網址)，請刪除在該專案中選取的資源，而不是刪除整個專案。

如果打算探索多種架構、教學課程或快速入門導覽課程，重複使用專案有助於避免超出專案配額限制。

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

後續步驟

瞭解整個平台

現在您已瞭解如何開發及部署 App Engine 應用程式，接著可進一步探索 Google Cloud。您已安裝 Google Cloud CLI，因此擁有能與 Cloud SQL、Cloud Storage、Firestore 等產品互動的工具。

瞭解 App Engine 彈性環境

以下是一些可協助您瞭解 App Engine 的主題：

• App Engine 總覽
• 要求轉送
• 處理要求
• 管理執行個體

Hello World 程式碼審查

Hello World 是再簡單不過的 App Engine 應用程式，只包含一項服務、只有一種版本，且所有程式碼都位於應用程式的根目錄中。本節將詳細說明每個應用程式檔案。

HelloControllerTest.java

HelloControllerTest.java 檔案會指定網址模式來描述應用程式接聽要求的位置，並且使用「Hello World」訊息來回應任何要求。

/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.example.appengine;

import static org.junit.Assert.assertEquals;

import io.micronaut.context.ApplicationContext;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.client.HttpClient;
import io.micronaut.runtime.server.EmbeddedServer;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;

public class HelloControllerTest {
  private static EmbeddedServer server;
  private static HttpClient client;

  @BeforeClass
  public static void setupServer() {

    server = ApplicationContext.run(EmbeddedServer.class);

    client = server.getApplicationContext().createBean(HttpClient.class, server.getURL());
  }

  @AfterClass
  public static void stopServer() {
    if (client != null) {
      client.stop();
    }
    if (server != null) {
      server.stop();
    }
  }

  @Test
  public void testHelloWorldResponse() {
    String response = client.toBlocking().retrieve(HttpRequest.GET("/"));
    assertEquals("Hello World!", response);
  }
}

app.yaml

app.yaml 檔案說明應用程式的下列設定：

• 設定 env: flex，指出應用程式使用 App Engine 彈性環境。

• 指定應用程式使用的執行階段。

  runtime: java
  env: flex
  runtime_config:
    operating_system: ubuntu22
    runtime_version: 17
  handlers:
  - url: /.*
    script: this field is required, but ignored
  
  manual_scaling:
    instances: 1

  • 如要進一步瞭解 Java 執行階段的運作方式，請參閱Java 執行階段一文。

  pom.xml

  Hello World 也具有 pom.xml 檔案，其中包含專案的依附元件和建置目標等資訊。

  <?xml version="1.0" encoding="UTF-8"?>
  <!--
    Copyright 2023 Google LLC
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
         http://www.apache.org/licenses/LICENSE-2.0
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
  -->
  <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example.appengine.flexible</groupId>
    <artifactId>micronaut-helloworld</artifactId>
    <version>0.1</version>
  
    <!--
    The parent pom defines common style checks and testing strategies for our samples.
    Removing or replacing it should not affect the execution of the samples in anyway.
    -->
    <parent>
        <groupId>com.google.cloud.samples</groupId>
        <artifactId>shared-configuration</artifactId>
        <version>1.2.0</version>
    </parent>
  
    <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <exec.mainClass>com.example.appengine.Application</exec.mainClass>
      <maven.compiler.target>11</maven.compiler.target>
      <maven.compiler.source>11</maven.compiler.source>
      <micronaut.version>3.10.3</micronaut.version>
    </properties>
  
    <dependencies>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-inject</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-validation</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-runtime</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-http-client</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>javax.annotation</groupId>
        <artifactId>javax.annotation-api</artifactId>
        <version>1.3.2</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-http-server-netty</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13.2</version>
        <scope>test</scope>
      </dependency>
    </dependencies>
  
    <build>
      <plugins>
        <plugin>
          <groupId>com.google.cloud.tools</groupId>
          <artifactId>appengine-maven-plugin</artifactId>
          <version>2.8.0</version>
          <configuration>
            <projectId>GCLOUD_CONFIG</projectId>
            <version>micronaut-helloworld</version>
          </configuration>
        </plugin>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-shade-plugin</artifactId>
          <version>3.5.1</version>
          <executions>
            <execution>
              <phase>package</phase>
              <goals>
                <goal>shade</goal>
              </goals>
              <configuration>
                <transformers>
                  <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                    <mainClass>${exec.mainClass}</mainClass>
                  </transformer>
                  <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                </transformers>
              </configuration>
            </execution>
          </executions>
        </plugin>
        <plugin>
          <groupId>org.codehaus.mojo</groupId>
          <artifactId>exec-maven-plugin</artifactId>
          <version>3.1.1</version>
          <configuration>
            <executable>java</executable>
            <arguments>
              <argument>-noverify</argument>
              <argument>-XX:TieredStopAtLevel=1</argument>
              <argument>-Dcom.sun.management.jmxremote</argument>
              <argument>-classpath</argument>
              <classpath/>
              <argument>${exec.mainClass}</argument>
            </arguments>
          </configuration>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>3.2.5</version>
        </plugin>
  
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.12.1</version>
            <configuration>
              <encoding>UTF-8</encoding>
              <compilerArgs>
                <arg>-parameters</arg>
              </compilerArgs>
              <annotationProcessorPaths>
                <path>
                  <groupId>io.micronaut</groupId>
                  <artifactId>micronaut-inject-java</artifactId>
                  <version>${micronaut.version}</version>
                </path>
                <path>
                  <groupId>io.micronaut</groupId>
                  <artifactId>micronaut-validation</artifactId>
                  <version>${micronaut.version}</version>
                </path>
              </annotationProcessorPaths>
            </configuration>
            <executions>
              <execution>
                <id>test-compile</id>
                <goals>
                  <goal>testCompile</goal>
                </goals>
                <configuration>
                  <compilerArgs>
                    <arg>-parameters</arg>
                  </compilerArgs>
                  <annotationProcessorPaths>
                    <path>
                      <groupId>io.micronaut</groupId>
                      <artifactId>micronaut-inject-java</artifactId>
                      <version>${micronaut.version}</version>
                    </path>
                    <path>
                      <groupId>io.micronaut</groupId>
                      <artifactId>micronaut-validation</artifactId>
                      <version>${micronaut.version}</version>
                    </path>
                  </annotationProcessorPaths>
                </configuration>
              </execution>
            </executions>
          </plugin>
        </plugins>
  
    </build>
  </project>
  

  • 如要進一步瞭解 pom.xml 檔案，請參閱 Maven 說明文件。