App Engine フレキシブル環境での Java のクイックスタート

Python |Java |Node.js |Go |Ruby |PHP |.NET

このクイックスタートでは、短いメッセージを表示する小さな App Engine アプリケーションを作成する方法について説明します。

始める前に

このサンプルを実行してデプロイする前に、次の手順を行います。

1. GCP Console を使用して新しい GCP プロジェクトを作成し、App Engine アプリケーションを作成して課金を有効にします。
   App Engine に移動

   プロンプトが表示されたら、App Engine アプリケーションを配置するリージョンを選択し、課金を有効にします。

2. 次の前提条件をインストールします。
   1. git をダウンロードしてインストールします。
   2. Google Cloud SDK をダウンロードし、インストールしてから、gcloud ツールを初期化します。
      SDK をダウンロード
   3. このクイックスタートでは、Apache Maven を使用してサンプルアプリの構築、実行、デプロイを行います。Maven のインストールについて詳しくは、Apache Maven および App Engine プラグインを使用するをご覧ください。

App Engine のロケーション

App Engine はリージョナルです。つまり、アプリを実行するインフラストラクチャは特定のリージョンに配置され、そのリージョン内のすべてのゾーンで冗長的に利用できるように Google によって管理されます。

レイテンシ、可用性、耐久性の要件を満たすことが、アプリを実行するリージョンを選択する際の主な要素になります。一般に、アプリのユーザーに最も近いリージョンを選択できますが、アプリで使用されている他の GCP プロダクトやサービスのロケーションを考慮する必要があります。使用するサービスが複数のロケーションにまたがっていると、アプリのレイテンシだけでなく、料金にも影響します。

App Engine は次のリージョンで利用できます。

• northamerica-northeast1（モントリオール）
• us-central（アイオワ）
• us-east1（サウスカロライナ）
• us-east4（バージニア北部）
• southamerica-east1（サンパウロ）*
• europe-west（ベルギー）
• europe-west2（ロンドン）
• europe-west3（フランクフルト）
• asia-northeast1（東京）
• asia-south1（ムンバイ）
• australia-southeast1（シドニー）

* サンパウロ リージョンをご利用のお客様には、すべてのリージョナル プロダクト SLA が引き続き有効です。ただし、北米と南米を対象とするマルチリージョン機能およびクロスリージョン機能は、可用性またはパフォーマンスが一時的に低下する可能性があります。

アプリのリージョンを設定した後で変更することはできません。

App Engine アプリケーションをすでに作成している場合は、gcloud app describe コマンドを実行するか、GCP Console の App Engine ダッシュボードを開くことで、リージョンを表示できます。App Engine アプリケーションのリージョンは http://[YOUR_PROJECT_ID].appspot.com に表示されます。

OK

このクイックスタートは、Java Development Kit 8 がインストール済みであることを前提としています。

Hello World アプリをダウンロードする

Java 用のシンプルな Hello World アプリが用意されています。これを使用することで、App Engine フレキシブル環境へのアプリのデプロイをすぐに試すことができます。次の手順で、コマンドラインから Hello World アプリをローカルマシンにダウンロードします。

サンプルアプリをダウンロードし、アプリのディレクトリに移動するには:

1. Hello World サンプルアプリ レポジトリのクローンをローカルマシンに作成します。

   git clone https://github.com/GoogleCloudPlatform/getting-started-java
   

   あるいは、zip 形式のサンプルをダウンロードして、ファイルを抽出することもできます。

2. サンプルコードが入っているディレクトリに移動します。

   cd getting-started-java/helloworld-servlet
   

ローカルマシンで Hello World を実行する

ローカルのパソコン上で Hello World アプリを実行するには:

1. Jetty Maven プラグインを使用してローカルの Eclipse Jetty ウェブサーバーを起動します。

   mvn jetty:run-exploded
   

2. ウェブブラウザに次のアドレスを入力します。

   http://localhost:8080
   

サンプルアプリから「Hello World」というメッセージがページに表示されます。

ターミナル ウィンドウで Ctrl+C キーを押してウェブサーバーを終了します。

Hello World を App Engine にデプロイして実行する

App Engine フレキシブル環境にアプリをデプロイする手順は次のとおりです。

1. helloworld ディレクトリで次のコマンドを実行し、Hello World アプリをデプロイします。
   

   gcloud config set project YOUR_PROJECT_ID
   mvn appengine:deploy

2. 次のコマンドを実行してブラウザを起動し、http://YOUR_PROJECT_ID.appspot.com でアプリを表示します。
   

   gcloud app browse

今回、Hello World メッセージが表示されるページは、App Engine インスタンスで実行されているウェブサーバーから配信されます。

これで完了です。 App Engine フレキシブル環境に最初の Java アプリをデプロイできました。

クリーンアップの詳細については、以下の説明をご覧ください。また、活用できる次のステップへのリンクも併せてご覧ください。

クリーンアップ

課金されないようにするには、GCP プロジェクトを削除してプロジェクト内のすべてのリソースへの課金を停止します。

注: 複数のチュートリアルとクイックスタートを試行している場合、プロジェクトを削除する代わりに再使用すれば、プロジェクトの割り当て制限超えを回避することができます。
1. Cloud Platform Console で、[プロジェクト] ページに移動します。

   [プロジェクト] ページに移動する

2. プロジェクト名の右側にある、ゴミ箱アイコンをクリックします。
   警告: プロジェクトの削除は、次のような結果になります。

   • 既存のプロジェクトを使った場合、プロジェクトで行っていた、他の作業も削除されます。
   • 削除されたプロジェクトのプロジェクト ID は再使用できません。将来に使う予定のカスタム プロジェクト ID を作成していた場合は、プロジェクト内のリソースを削除するようにしてください。そうすれば、appspot.com URL のような、プロジェクト ID を使う URL をそのまま利用することができます。

次のステップ

プラットフォーム全体について学ぶ

App Engine アプリの開発とデプロイの概要を理解した後は、Google Cloud Platform の残りの部分についても学習しましょう。すでに Google Cloud SDK がインストールされているので、Google Cloud SQL、Google Cloud Storage、Google Cloud Datastore といったプロダクトを操作するツールを使用できます。App Engine だけでなくプラットフォーム全体を使用するアプリケーションの作成方法を学ぶチュートリアルについては、Bookshelf アプリの作成に関するクイックスタートをご覧ください。

App Engine フレキシブル環境について学習する

App Engine についてさらに理解を深めるためのトピックをご紹介します。

• App Engine の概要
• リクエストのルーティング方法
• リクエストの処理方法
• インスタンスの管理方法

Hello World コードレビュー

Hello World は、1 つのサービスのみが含まれ、1 つのバージョンのみが存在し、すべてのコードがアプリのルート ディレクトリに存在する、最もシンプルな App Engine アプリです。このセクションでは、このアプリの各ファイルの詳細について説明します。

HelloServlet.java

HelloServlet.java ファイルでは、アプリがリクエストをリッスンする場所を記述する URL パターンを指定し、すべてのリクエストに対して「Hello World」というメッセージで応答します。

helloworld-servlet/src/main/java/com/example/appengine/gettingstartedjava/helloworld/HelloServlet.java

GitHub で表示

@SuppressWarnings("serial")
@WebServlet(name = "helloworld", value = "/" )
public class HelloServlet extends HttpServlet {

  @Override
  public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
    PrintWriter out = resp.getWriter();
    out.println("Hello, world - Flex Servlet");
  }
}

app.yaml

app.yaml ファイルには、アプリケーションのデプロイ設定が記述されています。

helloworld-servlet/src/main/appengine/app.yaml

GitHub で表示

runtime: java
env: flex

handlers:
- url: /.*
  script: this field is required, but ignored

runtime_config:  # Optional
  jdk: openjdk8
  server: jetty9

manual_scaling:
  instances: 1

app.yaml では、このアプリで使用するランタイムを指定します。また、env: flex を設定することで、このアプリがフレキシブル環境を使用することを指定します。

• Java ランタイムの機能の詳細については、Java 8 / Jetty 9.3 ランタイムをご覧ください。

pom.xml

Hello World には pom.xml ファイルも含まれており、ここには依存関係やビルド ターゲットなどのプロジェクト情報が記述されています。

helloworld-servlet/pom.xml

GitHub で表示

<project>                               <!-- REQUIRED -->

  <modelVersion>4.0.0</modelVersion>    <!-- REQUIRED -->
  <packaging>war</packaging>            <!-- REQUIRED -->

  <groupId>com.example.flex.helloworld</groupId>
  <artifactId>helloworld-servlet</artifactId> <!-- Name of your project -->
  <version>1.0-SNAPSHOT</version>       <!-- xx.xx.xx -SNAPSHOT means development -->

  <properties>
    <maven.compiler.source>1.8</maven.compiler.source> <!-- REQUIRED -->
    <maven.compiler.target>1.8</maven.compiler.target> <!-- REQUIRED -->
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

    <failOnMissingWebXml>false</failOnMissingWebXml> <!-- REQUIRED -->
    <appengine.maven.plugin>1.3.2</appengine.maven.plugin>
    <jetty.maven.plugin>9.4.3.v20170317</jetty.maven.plugin>
  </properties>

  <parent>                              <!-- Get parameters and allow bulk testing -->
    <artifactId>getting-started-java</artifactId>
    <groupId>com.example</groupId>
    <version>1.0.0</version>
    <relativePath>..</relativePath>
  </parent>

  <dependencies>
    <dependency>                        <!-- REQUIRED -->
      <groupId>javax.servlet</groupId>  <!-- Java Servlet API -->
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>           <!-- Provided by the Jetty Servlet Container -->
    </dependency>
  </dependencies>

  <build>
    <!-- For hot reload of the web application when using an IDE Eclipse / IDEA -->
    <outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory>

    <plugins>

      <plugin>                          <!-- Used for local debugging -->
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>${jetty.maven.plugin}</version>
      </plugin>

      <plugin>
        <groupId>com.google.cloud.tools</groupId>
        <artifactId>appengine-maven-plugin</artifactId>
        <version>${appengine.maven.plugin}</version>
        <configuration>
          <!-- deploy configuration -->
<!--
          <deploy.promote>true</deploy.promote>                           <!~~ DEFAULT value ~~>
          <deploy.stopPreviousVersion>true</deploy.stopPreviousVersion>   <!~~ DEFAULT value ~~>
 -->
        </configuration>
      </plugin>

    </plugins>
  </build>
</project>

• pom.xml ファイルについて詳しくは、Maven のドキュメントをご覧ください。