Java で Cloud Functions の HTTP 関数を作成してデプロイする

Cloud Functions は、Cloud Run functions という名称になりました。詳細については、Cloud Run functions のブログ投稿をご覧ください。

このガイドでは、Java ランタイムを使用して Cloud Functions の関数を記述するプロセスを説明します。Cloud Functions の関数には次の 2 つのタイプがあります。

HTTP 関数。標準的な HTTP リクエストから呼び出します。
イベントドリブン関数。Pub/Sub トピック上のメッセージや Cloud Storage バケット内の変更など、Cloud インフラストラクチャのイベントによってトリガーされます。

このドキュメントでは、Maven または Gradle のいずれかを使用して、単純な HTTP 関数を作成し、ビルドする方法を説明します。

始める前に

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.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

Enable the APIs

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

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

Enable the APIs

Google Cloud SDK をインストールして初期化します。
注: コマンドプロンプトが必要な場合は、Cloud Shellを使用できます。Cloud Shell コマンドライン環境には Google Cloud CLI がすでに含まれているので、インストールする必要はありません。Google Cloud CLI は、Google Compute Engine の仮想マシンにもプリインストールされています。
次のコマンドを使用して、gcloud コンポーネントを更新してインストールします。
```
gcloud components update
```
開発環境を準備します。

Java 設定ガイドに移動

関数を作成する

このセクションでは、関数を作成する方法について説明します。

Maven

関数コードで使用するため、ローカルシステムにディレクトリを作成します。

Linux または Mac OS X:
```
 mkdir ~/helloworld
 cd ~/helloworld
```
Windows:
```
 mkdir %HOMEPATH%\helloworld
 cd %HOMEPATH%\helloworld
```
ソースディレクトリとソースファイルを格納するプロジェクト構造を作成します。
```
mkdir -p ~/helloworld/src/main/java/functions
touch ~/helloworld/src/main/java/functions/HelloWorld.java
```

HelloWorld.java ファイルに次の内容を追加します。


package functions;

import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import java.io.BufferedWriter;
import java.io.IOException;

public class HelloWorld implements HttpFunction {
  // Simple function to return "Hello World"
  @Override
  public void service(HttpRequest request, HttpResponse response)
      throws IOException {
    BufferedWriter writer = response.getWriter();
    writer.write("Hello World!");
  }
}

この例の関数は、「Hello, World!」という挨拶を出力します。

Gradle

関数コードで使用するため、ローカルシステムにディレクトリを作成します。

Linux または Mac OS X:
```
 mkdir ~/helloworld-gradle
 cd ~/helloworld-gradle
```
Windows:
```
 mkdir %HOMEPATH%\helloworld-gradle
 cd %HOMEPATH%\helloworld-gradle
```
ソースディレクトリとソースファイルを格納するプロジェクト構造を作成します。
```
 mkdir -p src/main/java/functions
 touch src/main/java/functions/HelloWorld.java
```

HelloWorld.java ファイルに次の内容を追加します。


package functions;

import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import java.io.BufferedWriter;
import java.io.IOException;

public class HelloWorld implements HttpFunction {
  // Simple function to return "Hello World"
  @Override
  public void service(HttpRequest request, HttpResponse response)
      throws IOException {
    BufferedWriter writer = response.getWriter();
    writer.write("Hello World!");
  }
}

この例の関数は、「Hello, World!」という挨拶を出力します。

依存関係を指定する

次に、依存関係を設定します。

Maven

上記で作成した helloworld ディレクトリにディレクトリを変更し、pom.xml ファイルを作成します。

 cd ~/helloworld
 touch pom.xml

Maven を使用して依存関係を管理するには、プロジェクトの pom.xml ファイル内にある <dependencies> セクションで依存関係を指定します。この演習では、次の内容を pom.xml ファイルにコピーします。

<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.functions</groupId>
  <artifactId>functions-hello-world</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencies>
    <!-- Required for Function primitives -->
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <!--
          Google Cloud Functions Framework Maven plugin

          This plugin allows you to run Cloud Functions Java code
          locally. Use the following terminal command to run a
          given function locally:

          mvn function:run -Drun.functionTarget=your.package.yourFunction
        -->
        <groupId>com.google.cloud.functions</groupId>
        <artifactId>function-maven-plugin</artifactId>
        <version>0.11.0</version>
        <configuration>
          <functionTarget>functions.HelloWorld</functionTarget>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Maven に基づく完全なサンプルについては、helloworld をご覧ください。

Gradle

上記で作成した helloworld-gradle ディレクトリにディレクトリを変更し、build.gradle ファイルを作成します。

 cd ~/helloworld-gradle
 touch build.gradle

Gradle を使用して依存関係を管理するには、プロジェクトの build.gradle ファイル内で依存関係を指定します。この演習では、次の内容を build.gradle ファイルにコピーします。この build.gradle ファイルには、関数をローカルで実行するためのカスタムタスクが含まれています。

apply plugin: 'java'

repositories {
  jcenter()
  mavenCentral()
}
configurations {
    invoker
}

dependencies {
  // Every function needs this dependency to get the Functions Framework API.
  compileOnly 'com.google.cloud.functions:functions-framework-api:1.1.0'

  // To run function locally using Functions Framework's local invoker
  invoker 'com.google.cloud.functions.invoker:java-function-invoker:1.3.1'

  // These dependencies are only used by the tests.
  testImplementation 'com.google.cloud.functions:functions-framework-api:1.1.0'
  testImplementation 'junit:junit:4.13.2'
  testImplementation 'com.google.truth:truth:1.4.0'
  testImplementation 'org.mockito:mockito-core:5.10.0'

}

// Register a "runFunction" task to run the function locally
tasks.register("runFunction", JavaExec) {
  main = 'com.google.cloud.functions.invoker.runner.Invoker'
  classpath(configurations.invoker)
  inputs.files(configurations.runtimeClasspath, sourceSets.main.output)
  args(
    '--target', project.findProperty('run.functionTarget') ?: '',
    '--port', project.findProperty('run.port') ?: 8080
  )
  doFirst {
    args('--classpath', files(configurations.runtimeClasspath, sourceSets.main.output).asPath)
  }
}

Gradle に基づく完全なサンプルについては、helloworld-gradle をご覧ください。

をご覧ください。

関数をローカルでビルドしてテストする

関数をデプロイする前に、ローカルでビルドしてテストできます。

Maven

次のコマンドを実行して、関数がビルドしたことを確認します。
```
mvn compile
```
もう 1 つのオプションは、mvn package コマンドを使用して、Java コードをコンパイルし、テストを実行して、ターゲットディレクトリ内の JAR ファイルにコードをパッケージ化するというものです。Maven ビルドのライフサイクルについて詳しくは、こちらをご覧ください。
次のコマンドを使用して関数を開始します。
```
mvn function:run
```
関数をテストするには、ブラウザで http://localhost:8080 にアクセスするか、別のウィンドウから curl localhost:8080 を実行します。

詳細については、ローカル関数にリクエストを送信するをご覧ください。

Gradle

次のコマンドを実行して、関数がビルドしたことを確認します。
```
gradle build
```

次のコマンドを使用して関数を開始します。

gradle runFunction -Prun.functionTarget=functions.HelloWorld

関数をテストするには、ブラウザで http://localhost:8080 にアクセスするか、別のウィンドウから curl localhost:8080 を実行します。

詳細については、ローカル関数にリクエストを送信するをご覧ください。

関数をデプロイする

関数をデプロイするには、helloworld ディレクトリ（maven を使用している場合）または helloworld-gradle ディレクトリ（Gradle の場合）で次のコマンドを実行します。

  gcloud functions deploy java-http-function \
    --gen2 \
    --entry-point=functions.HelloWorld \
    --runtime=java17 \
    --region=REGION \
    --source=. \
    --trigger-http \
    --allow-unauthenticated

REGION は、関数をデプロイする Google Cloud リージョンの名前に置き換えます（us-west1 など）。

オプションの --allow-unauthenticated フラグを使用すると、認証なしで関数にアクセスできます。

java-http-function は、関数が Google Cloud コンソールで識別される登録名で、--entry-point は関数の完全修飾クラス名（FQN）を指定します。

デプロイした関数をテストする

関数がデプロイされたら、gcloud functions deploy コマンドの出力で uri プロパティをメモするか、次のコマンドを使用して取得します。
```
gcloud functions describe java-http-function \
  --region=REGION
```
REGION は、関数をデプロイした Google Cloud リージョンの名前に置き換えます（us-west1 など）。
ブラウザで、この URL にアクセスします。関数から「Hello World!」というメッセージが返されます。

注: この URL は、Google Cloud コンソールでも確認できます。Cloud Functions の概要ページに移動し、関数の名前をクリックして [関数の詳細] ページを開きます。[トリガー] タブを開き、関数の URL を確認します。

関数のログを表示する

コマンドラインツールを使用してログを表示する

関数のログは、Cloud Logging UI または Google Cloud CLI で確認できます。

gcloud CLI を使用して関数のログを表示するには、logs read コマンドを使用します。

    gcloud functions logs read \
      --gen2 \
      --limit=10 \
      --region=REGION \
      java-http-function

REGION は、関数をデプロイした Google Cloud リージョンの名前に置き換えます（us-west1 など）。

出力は次のようになります。

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-05-29 23:09:57.708
LOG:

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-05-29 23:05:53.257
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "my--first--function-1" on port 8080.

LEVEL:
NAME: my-first-function
TIME_UTC: 2023-05-29 23:05:53.248
LOG: 2023-05-29 23:05:53.248:INFO:oejs.Server:main: Started @892ms

ロギングダッシュボードでログを表示する

ロギングダッシュボードで関数のログを表示するには、Cloud Functions の概要ページを開き、リストから関数の名前をクリックして、[ログ] タブをクリックします。

始める前に

関数を作成する

Maven

Gradle

依存関係を指定する

Maven

Gradle

関数をローカルでビルドしてテストする

Maven

Gradle

関数をデプロイする

デプロイした関数をテストする

関数のログを表示する

コマンドライン ツールを使用してログを表示する

ロギング ダッシュボードでログを表示する

コマンドラインツールを使用してログを表示する

ロギングダッシュボードでログを表示する