最初の関数: Java

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

  • HTTP 関数。標準的な HTTP リクエストから呼び出します。
  • バックグラウンド関数。Cloud Pub/Sub トピックのメッセージや Cloud Storage バケットの変更など、Cloud インフラストラクチャのイベントを処理するために使用します。

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

ガイドの構成

  1. Cloud SDK を使用した GCP プロジェクトの作成
  2. 関数の作成
  3. 依存関係の指定
  4. ローカルでのビルドとテスト
  5. 関数のデプロイ
  6. デプロイされた関数のテスト
  7. ログの表示

Cloud SDK を使用した GCP プロジェクトの作成

  1. Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
  2. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  3. Cloud プロジェクトに対して課金が有効になっていることを確認します。プロジェクトに対して課金が有効になっていることを確認する方法を学習する

  4. Cloud Functions and Cloud Build API を有効にします。

    API を有効にする

  5. Cloud SDK をインストールし、初期化します
  6. gcloud コンポーネントを更新してインストールします。
    gcloud components update
  7. 開発環境を準備します。

    Java 設定ガイドに移動

関数の作成

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

Maven

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

    Linux または Mac OS X:

     mkdir ~/helloworld
     cd ~/helloworld
    

    Windows:

     mkdir %HOMEPATH%\helloworld
     cd %HOMEPATH%\helloworld
    
  2. ソース ディレクトリとソースファイルを格納するプロジェクト構造を作成します。

    mkdir -p src/main/java/functions
    touch src/main/java/functions/HelloWorld.java
    
  3. 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

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

    Linux または Mac OS X:

     mkdir ~/helloworld-gradle
     cd ~/helloworld-gradle
    

    Windows:

     mkdir %HOMEPATH%\helloworld-gradle
     cd %HOMEPATH%\helloworld-gradle
    
  2. ソース ディレクトリとソースファイルを格納するプロジェクト構造を作成します。

     mkdir -p src/main/java/functions
     touch src/main/java/functions/HelloWorld.java
    
  3. 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.cloud.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.0.4</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.9.7</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.0.1'

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

  // These dependencies are only used by the tests.
  testImplementation 'com.google.cloud.functions:functions-framework-api:1.0.1'
  testImplementation 'junit:junit:4.12'
  testImplementation 'com.google.truth:truth:1.0.1'
  testImplementation 'org.mockito:mockito-core:3.4.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

Gradle

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

gradle build

関数をテストするには、次のコマンドを実行します。

gradle runFunction -Prun.functionTarget=functions.HelloWorld

テストが正常に完了すると、ウェブブラウザでアクセスできる URL(http://localhost:8080/)が表示され、動作中の関数を見ることができます。Hello World! というメッセージが表示されます。

別のターミナル ウィンドウから curl を使用して、この関数にリクエストを送信することもできます。

curl localhost:8080
# Output: Hello World!

関数のデプロイ

Maven

HTTP トリガーを使用して関数をデプロイするには、helloworld ディレクトリで次のコマンドを実行します。

gcloud functions deploy my-first-function --entry-point functions.HelloWorld --runtime java11 --trigger-http --memory 512MB --allow-unauthenticated

ここで、my-first-function は関数が Cloud Console で識別される登録名で、--entry-point は関数の完全修飾クラス名(FQN)を指定します。

Gradle

HTTP トリガーを使用して関数をデプロイするには、helloworld-gradle ディレクトリで次のコマンドを実行します。

gcloud functions deploy my-first-function --entry-point functions.HelloWorld --runtime java11 --trigger-http --memory 512MB --allow-unauthenticated

ここで、my-first-function は関数が Cloud Console で識別される登録名で、--entry-point は関数の完全修飾クラス名(FQN)を指定します。

デプロイされた関数のテスト

  1. 関数がデプロイされたら、httpsTrigger.url プロパティをメモするか、次のコマンドを使用して検索します。

    gcloud functions describe my-first-function
    

    次のようになります。

    https://GCP_REGION-PROJECT_ID.cloudfunctions.net/my-first-function
  2. ブラウザで、この URL にアクセスします。Hello World! というメッセージが表示されます。

ログの表示

コマンドライン ツールの使用

Cloud Functions のログは、Cloud Logging UI または gcloud コマンドライン ツールで表示できます。

gcloud ツールを使用して関数のログを表示するには、logs read コマンドの後に関数の名前を続けます。

gcloud functions logs read my-first-function

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

LEVEL  NAME               EXECUTION_ID  TIME_UTC                 LOG
D      my-first-function  k2bqgroszo4u  2020-07-24 18:18:01.791  Function execution started
D      my-first-function  k2bqgroszo4u  2020-07-24 18:18:01.958  Function execution took 168 ms, finished with status code: 200
...

ロギング ダッシュボードを使う

Cloud Console から Cloud Functions のログを表示することもできます。