PHP で Cloud Run functions の HTTP 関数を作成してデプロイする

注: この内容は、Cloud Run functions（旧称 Cloud Functions 第 2 世代）を対象としています。

このドキュメントの第 1 世代のバージョンについては、PHP を使用して Cloud Run functions HTTP 関数を作成してデプロイする（第 1 世代）をご覧ください。

このガイドでは、PHP ランタイムを使用して Cloud Run functions を記述し、HTTP 関数をテストしてデプロイするプロセスについて説明します。

次の 2 つのタイプの Cloud Run functions を作成できます。

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

詳しくは、HTTP 関数の作成とイベント ドリブン関数の作成をご覧ください。

始める前に

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

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

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

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

   Enable the APIs

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

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

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

   Enable the APIs

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

   gcloud components update

10. 開発環境を準備します。

    Google Cloud での PHP の使用に移動

関数を作成する

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

   Linux / Mac OS X

   mkdir ~/helloworld_http
   cd ~/helloworld_http
   

   Windows

   mkdir %HOMEPATH%\helloworld_http
   cd %HOMEPATH%\helloworld_http
   

2. helloworld_http ディレクトリに、次の内容の index.php ファイルを作成します。

   <?php
   
   use Google\CloudFunctions\FunctionsFramework;
   use Psr\Http\Message\ServerRequestInterface;
   
   // Register the function with Functions Framework.
   // This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=http` environment
   // variable when deploying. The `FUNCTION_TARGET` environment variable should
   // match the first parameter.
   FunctionsFramework::http('helloHttp', 'helloHttp');
   
   function helloHttp(ServerRequestInterface $request): string
   {
       $name = 'World';
       $body = $request->getBody()->getContents();
       if (!empty($body)) {
           $json = json_decode($body, true);
           if (json_last_error() != JSON_ERROR_NONE) {
               throw new RuntimeException(sprintf(
                   'Could not parse body: %s',
                   json_last_error_msg()
               ));
           }
           $name = $json['name'] ?? $name;
       }
       $queryString = $request->getQueryParams();
       $name = $queryString['name'] ?? $name;
   
       return sprintf('Hello, %s!', htmlspecialchars($name));
   }
   

   このサンプル関数は HTTP リクエストで指定された名前を使用します。名前が指定されていない場合は、「Hello World!」という挨拶を返します。PHP HTTP 関数の構造と必要な要素の詳細については、HTTP 関数を作成するをご覧ください。

依存関係を指定する

1. PHP では、Composer を使用して依存関係を管理します。Cloud Shell を使用している場合、Composer がプリインストールされています。インストールされていない場合は、Composer のインストール手順に沿ってインストールしてください。

2. 関数の依存関係を指定します。

   1. 次の内容の composer.json ファイルを helloworld_http ディレクトリに追加します。

      {
          "require": {
              "php": ">= 8.1",
              "google/cloud-functions-framework": "^1.1"
          },
          "scripts": {
              "start": [
                 "Composer\\Config::disableProcessTimeout",
                 "FUNCTION_TARGET=helloHttp php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"
              ]
          }
      }
      

   FUNCTION_TARGET 行は、関数のエントリ ポイントを指定します。

   1. helloworld_http ディレクトリで次のコマンドを実行します。

   composer require google/cloud-functions-framework
   

   これにより、Functions Framework が composer.json に追加され、helloworld_http 内に依存関係を含む vendor ディレクトリが作成されます。

詳細: 詳細については、依存関係の指定をご覧ください。

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

関数をデプロイする前にローカルでビルドしてテストするには、次の手順を実施します。

1. helloHttp 関数を実行するローカル ウェブサーバーを作成します。

   export FUNCTION_TARGET=helloHttp
   composer start
   

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

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

このサンプル関数は、「Hello World!」という挨拶メッセージを返します。

関数をデプロイする

関数をデプロイするには、helloworld_http ディレクトリで次のコマンドを実行します。

  gcloud functions deploy php-http-function \
    --gen2 \
    --runtime=php82 \
    --region=REGION \
    --source=. \
    --entry-point=helloHttp \
    --trigger-http \
    --allow-unauthenticated

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

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

詳細: 詳細については、Cloud Run functions のデプロイをご覧ください。

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

1. 関数がデプロイされたら、gcloud functions deploy コマンドの出力で uri プロパティをメモするか、次のコマンドを使用して取得します。

     gcloud functions describe php-http-function \
       --region=REGION
   

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

2. ブラウザで、この URL にアクセスします。関数から「Hello World!」というメッセージが返されます。

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

関数のログを表示する

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

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

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

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

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

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

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:36.067
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.814
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello_http-1" on port 8080.

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.777
LOG: [pid1-nginx] Starting nginx (pid 17): /usr/sbin/nginx -c /tmp/nginxconf-953701689/nginx.conf [session:R8F8ZJ5]

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.766
LOG: [pid1-nginx] Successfully connected to /tmp/google-config/app.sock after 556.430499ms [session:R8F8ZJ5]

注: ログエントリが Cloud Logging に表示されるまでに少し時間がかかることがあります。

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

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

詳細: 詳細については、ログの作成、表示、処理をご覧ください。