Java で Cloud Run functions の HTTP 関数を作成してデプロイする（第 1 世代）

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.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

Gradle

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

gradle build

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

gradle runFunction -Prun.functionTarget=functions.HelloWorld

Maven

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

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

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

Gradle

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

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

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