Cloud Pub/Sub のチュートリアル

このシンプルなチュートリアルでは、Cloud Pub/Sub トリガーを用いてバックグラウンドの Cloud Functions の関数で書き込み、デプロイ、トリガーを行う方法について説明していきます。

Pub/Sub を初めて使用する場合、詳細については Pub/Sub のドキュメント、特にトピックとサブスクリプションの管理をご覧ください。Cloud Functions での Pub/Sub トピックとサブスクリプションの使用に関する概要については、Google Cloud Pub/Sub トリガーをご覧ください。

Pub/Sub 自体を使用したコードサンプルについては、Google Cloud のサンプルブラウザをご覧ください。

目標

バックグラウンド Cloud Functions の関数を書き込み、デプロイする。
Pub/Sub トピックにメッセージを公開して関数をトリガーする。

費用

このチュートリアルでは、以下を含む、Cloud Platform の有料コンポーネントを使用します。

Cloud Functions
Pub/Sub

料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを出すことができます。

新しい Cloud Platform ユーザーは無料トライアルをご利用いただけます。

始める前に

Google アカウントにログインします。
Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

Google Cloud Console の [プロジェクトセレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

[プロジェクトの選択] ページに移動

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

Cloud Functions and Cloud Pub/Sub API を有効にします。
API を有効にする

Cloud SDK をインストールして初期化します。

Cloud SDK がすでにインストールされている場合は、次のコマンドを実行して更新します。

gcloud components update

開発環境を準備します。

Node.js

Node.js 設定ガイドに移動

Python

Python 設定ガイドに移動

Go

Go 設定ガイドに移動

Java

Java 設定ガイドに移動

C#

.NET 設定ガイドに移動

Ruby

Ruby 設定ガイドに移動

アプリケーションの準備

ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。
Node.js
```
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
```
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。
Python
```
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
```
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。
Go
```
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
```
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。
Java
```
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
```
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。
C#
```
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
```
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。
Ruby
```
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
```
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。

Pub/Sub にアクセスするための Cloud Functions サンプルコードがあるディレクトリに移動します。

Node.js

cd nodejs-docs-samples/functions/helloworld/

Python

cd python-docs-samples/functions/helloworld/

Go

cd golang-samples/functions/helloworld/

Java

cd java-docs-samples/functions/helloworld/hello-pubsub/

C#

cd dotnet-docs-samples/functions/helloworld/HelloPubSub/

Ruby

cd ruby-docs-samples/functions/helloworld/pubsub/

サンプルコードを見てみましょう。

Node.js

functions/helloworld/index.js

GitHub で表示

/**
 * Background Cloud Function to be triggered by Pub/Sub.
 * This function is exported by index.js, and executed when
 * the trigger topic receives a message.
 *
 * @param {object} message The Pub/Sub message.
 * @param {object} context The event metadata.
 */
exports.helloPubSub = (message, context) => {
  const name = message.data
    ? Buffer.from(message.data, 'base64').toString()
    : 'World';

  console.log(`Hello, ${name}!`);
};

Python

functions/helloworld/main.py

GitHub で表示

def hello_pubsub(event, context):
    """Background Cloud Function to be triggered by Pub/Sub.
    Args:
         event (dict):  The dictionary with data specific to this type of
         event. The `data` field contains the PubsubMessage message. The
         `attributes` field will contain custom attributes if there are any.
         context (google.cloud.functions.Context): The Cloud Functions event
         metadata. The `event_id` field contains the Pub/Sub message ID. The
         `timestamp` field contains the publish time.
    """
    import base64

    print("""This Function was triggered by messageId {} published at {}
    """.format(context.event_id, context.timestamp))

    if 'data' in event:
        name = base64.b64decode(event['data']).decode('utf-8')
    else:
        name = 'World'
    print('Hello {}!'.format(name))

Go

functions/helloworld/hello_pubsub.go

GitHub で表示


// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"context"
	"log"
)

// PubSubMessage is the payload of a Pub/Sub event.
// See the documentation for more details:
// https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage
type PubSubMessage struct {
	Data []byte `json:"data"`
}

// HelloPubSub consumes a Pub/Sub message.
func HelloPubSub(ctx context.Context, m PubSubMessage) error {
	name := string(m.Data) // Automatically decoded from base64.
	if name == "" {
		name = "World"
	}
	log.Printf("Hello, %s!", name)
	return nil
}

Java

functions/helloworld/hello-pubsub/src/main/java/functions/HelloPubSub.java

GitHub で表示


import com.google.cloud.functions.BackgroundFunction;
import com.google.cloud.functions.Context;
import com.google.events.cloud.pubsub.v1.Message;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.logging.Level;
import java.util.logging.Logger;

public class HelloPubSub implements BackgroundFunction<Message> {
  private static final Logger logger = Logger.getLogger(HelloPubSub.class.getName());

  @Override
  public void accept(Message message, Context context) {
    String name = "world";
    if (message != null && message.getData() != null) {
      name = new String(
          Base64.getDecoder().decode(message.getData().getBytes(StandardCharsets.UTF_8)),
          StandardCharsets.UTF_8);
    }
    logger.info(String.format("Hello %s!", name));
    return;
  }
}

C#

functions/helloworld/HelloPubSub/Function.cs

GitHub で表示

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using Google.Events.Protobuf.Cloud.PubSub.V1;
using Microsoft.Extensions.Logging;
using System.Threading;
using System.Threading.Tasks;

namespace HelloPubSub
{
    public class Function : ICloudEventFunction<MessagePublishedData>
    {
        private readonly ILogger _logger;

        public Function(ILogger<Function> logger) =>
            _logger = logger;

        public Task HandleAsync(CloudEvent cloudEvent, MessagePublishedData data, CancellationToken cancellationToken)
        {
            string nameFromMessage = data.Message?.TextData;
            string name = string.IsNullOrEmpty(nameFromMessage) ? "world" : nameFromMessage;
            _logger.LogInformation("Hello {name}", name);
            return Task.CompletedTask;
        }
    }
}

Ruby

functions/helloworld/pubsub/app.rb

GitHub で表示

require "functions_framework"
require "base64"

FunctionsFramework.cloud_event "hello_pubsub" do |event|
  # The event parameter is a CloudEvents::Event::V1 object.
  # See https://cloudevents.github.io/sdk-ruby/latest/CloudEvents/Event/V1.html
  name = Base64.decode64 event.data["message"]["data"] rescue "World"

  # A cloud_event function does not return a response, but you can log messages
  # or cause side effects such as sending additional events.
  logger.info "Hello, #{name}!"
end

関数のデプロイ

Pub/Sub トリガーを使用して関数をデプロイするには、サンプルコード（Java の場合は pom.xml ファイル）を含むディレクトリで次のコマンドを実行します。

Node.js

gcloud functions deploy helloPubSub \
--runtime nodejs10 \
--trigger-topic YOUR_TOPIC_NAME

優先する Node.js のバージョンを指定するには、--runtime フラグに次の値を使用します。

nodejs10
nodejs12
nodejs14（公開プレビュー）

Python

gcloud functions deploy hello_pubsub \
--runtime python38 \
--trigger-topic YOUR_TOPIC_NAME

優先する Python バージョンを指定するには、--runtime フラグに次の値を使用します。

python37
python38
python39（公開プレビュー）

Go

gcloud functions deploy HelloPubSub \
--runtime go113 \
--trigger-topic YOUR_TOPIC_NAME

優先する Go バージョンを指定するには、--runtime フラグに次の値を使用します。

go111（サポート終了）
go113

Java

gcloud functions deploy java-pubsub-function \
--entry-point functions.HelloPubSub \
--runtime java11 \
--memory 512MB \
--trigger-topic YOUR_TOPIC_NAME

C#

gcloud functions deploy csharp-pubsub-function \
--entry-point HelloPubSub.Function \
--runtime dotnet3 \
--trigger-topic YOUR_TOPIC_NAME

Ruby

gcloud functions deploy hello_pubsub --runtime ruby26 \
--trigger-topic YOUR_TOPIC_NAME

優先する Ruby バージョンを指定するには、--runtime フラグに次の値を使用します。

ruby26
ruby27

ここで、YOUR_TOPIC_NAME は関数の登録先となる Pub/Sub トピックの名前です。

YOUR_TOPIC_NAME がまだ存在しない場合、このコマンドにより作成されます。Cloud Console または次の gcloud コマンドを使用して、deploy コマンドを実行する前にトピックを作成することもできます。

gcloud pubsub topics create YOUR_TOPIC_NAME

関数のトリガー

メッセージを Pub/Sub トピックに公開します。この例では、メッセージは関数が挨拶に含める名前です。
```
gcloud pubsub topics publish YOUR_TOPIC_NAME --message YOUR_NAME
```
YOUR_TOPIC_NAME を Pub/Sub トピックの名前に置き換え、YOUR_NAME を任意の文字列に置き換えます。
実行した内容が完了していることをログで確認します。
```
gcloud functions logs read --limit 50
```
注: ログが表示されるまでに数分かかることがあります。すぐに表示されない場合は、1～2 分後にもう一度確認してください。

関数内からメッセージを Pub/Sub トピックに公開することもできます。

クリーンアップ

このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、リソースを含むプロジェクトを削除するか、プロジェクトを維持して個々のリソースを削除します。

プロジェクトの削除

課金をなくす最も簡単な方法は、チュートリアル用に作成したプロジェクトを削除することです。

プロジェクトを削除するには:

注意: プロジェクトを削除すると、次のような影響があります。

プロジェクト内のすべてのものが削除されます。このチュートリアルで既存のプロジェクトを使用した場合、それを削除すると、そのプロジェクトで行った他の作業もすべて削除されます。
カスタムプロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタムプロジェクト ID を作成した可能性があります。そのプロジェクト ID を使用した URL（たとえば、appspot.com）を保持するには、プロジェクト全体ではなくプロジェクト内の選択したリソースだけを削除します。

複数のチュートリアルとクイックスタートを検討する予定がある場合は、プロジェクトを再利用すると、プロジェクトの割り当て制限を超えないようにできます。

Cloud Console で [リソースの管理] ページに移動します。
[リソースの管理] に移動
プロジェクトリストで、削除するプロジェクトを選択し、[削除] をクリックします。
ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。

Cloud Function の削除

Cloud Functions を削除しても、Cloud Storage に保存されたリソースは削除されません。

このチュートリアルで作成した Cloud Function を削除するには、次のコマンドを実行します。

Node.js

gcloud functions delete helloPubSub

Python

gcloud functions delete hello_pubsub

Go

gcloud functions delete HelloPubSub

Java

gcloud functions delete java-pubsub-function

C#

gcloud functions delete csharp-pubsub-function

Ruby

gcloud functions delete hello_pubsub

Google Cloud Console から Cloud Functions を削除することもできます。