最初の関数: PHP

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

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

次のサンプルでは、簡単な HTTP 関数を作成しています。

ガイドの構成

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

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. 開発環境を準備します。

    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 ファイルを作成します。

    
    use Psr\Http\Message\ServerRequestInterface;
    
    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 の依存関係を管理するには、Composer を使用します。Composer をまだインストールしていない場合は、次の手順でインストールします。

  1. 任意の場所に Composer をダウンロードします。

  2. ダウンロード完了後、composer.phar ファイルをシステムパス内のディレクトリに移動します。次に例を示します。

    mv composer.phar /usr/local/bin/composer
    

次に、関数の依存関係を指定します。

  1. 依存関係を含む composer.json ファイルを関数コードのディレクトリに追加します。ここで、FUNCTION_TARGET=FUNCTION_NAME は関数の名前を示します。この例では、FUNCTION_NAMEhelloHttp です。

    {
        "require": {
            "google/cloud-functions-framework": "^1.0"
        },
        "scripts": {
            "start": [
               "Composer\\Config::disableProcessTimeout",
               "FUNCTION_TARGET=helloHttp php -S localhost:${PORT:-8080} vendor/bin/router.php"
            ]
        }
    }
    
  2. 関数コードを含むディレクトリ(先ほど作成した composer.json ファイルも含める必要があります)で、次のコマンドを実行します。

    composer require google/cloud-functions-framework
    

    これにより、Functions Framework が composer.json に追加されます。また、依存関係を含む関数コードのディレクトリに vendor/ ディレクトリが作成されます。

ローカルでのビルドとテスト

依存関係の指定の手順を完了したら、関数をローカルでビルドしてテストできます。

次のコマンドは、helloHttp 関数を実行するローカル ウェブサーバーを作成します。

export FUNCTION_TARGET=helloHttp
php -S localhost:8080 vendor/bin/router.php

関数が正常にビルドされると、URL が表示されます。この URL(http://localhost:8080/)にはウェブブラウザでアクセスできます。Hello World! というメッセージが表示されます。

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

curl localhost:8080
# Output: Hello World!

関数のデプロイ

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

gcloud functions deploy helloHttp --runtime php74 --trigger-http --allow-unauthenticated

--allow-unauthenticated フラグを使用すると、認証なしで関数にアクセスできます。認証を要求するには、フラグを省略します。

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

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

    gcloud functions describe helloHttp
    

    次のようになります。

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

    次に示す URL の例のように、HTTP リクエストで名前を渡します。

    https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp?name=NAME

    「Hello NAME!」というメッセージが表示されます。

ログの表示

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

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

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

gcloud functions logs read helloHttp

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

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

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

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