Amazon SQS メッセージング API の使用法

Amazon SQS メッセージ属性を使用してメッセージにカスタム・メタデータを添付するには、SQS メッセージ属性オブジェクトの InterSystems IRIS %ListOfObjects Opens in a new tabコレクションを作成する必要があります。次のセクションで作成する Amazon SQS メッセージ・オブジェクトでは、この属性のコレクション (一覧) をオプションのプロパティとして受け入れます。属性ごとに以下を定義します。

1. %External.Messaging.SQSMessageAttributeOpens in a new tab オブジェクトの新しいインスタンスを作成します。

2. 次のように、このメッセージ属性オブジェクトのプロパティを設定します。

   • key ：メッセージ属性キー

   • dataType ：メッセージ属性値のデータ型 ("String"、"Number"、または "Binary")

   • stringValue または binaryValue ：メッセージ属性値。指定したデータ型に適切な方のプロパティを設定します。

3. メッセージ属性オブジェクトの一覧に、各メッセージ属性オブジェクトを追加します。

メッセージ属性の詳細は、Amazon SQS メッセージ・メタデータのドキュメントOpens in a new tabを参照してください。以下の例ではタイム・スタンプ属性を作成しています。

 Set attrList = ##class(%ListOfObjects).%New()

 Set key = "timestamp"
 Set dataType = "String"
 Set value = $zdatetime($horolog)

 Set msgAttr1 = ##class(%External.Messaging.SQSMessageAttribute).%New()
 Set msgAttr1.key = key
 Set msgAttr1.dataType = dataType
 Set msg.stringValue = value

 Set tSC = attrList.Insert(msgAttr1)

送信するメッセージを作成するには、%External.Messaging.SQSMessageOpens in a new tab オブジェクトの新しいインスタンスを作成します。つづいて、そのメッセージ・オブジェクトのプロパティを定義します。メッセージの送信先名である queue とメッセージの body を指定する必要があります。前のセクションで説明したカスタム・メッセージ属性を定義している場合は、messageAttributes プロパティとしてメッセージ属性オブジェクトの一覧を指定します。例えば以下のようにします。

 Set queue = "quick-start-events"
 Set body = "MyMessage"

 Set msg = ##class(%External.Messaging.SQSMessage).%New()
 Set msg.queue = queue
 Set msg.body = body
 Set msg.messageAttributes = attrList

作成したメッセージは、Amazon SQS クライアント・オブジェクトの SendMessage() メソッドを実行することにより、トピックに送信できます:

set tSC = client.SendMessage(msg)
if $$$ISERR(tSC) { //handle error scenario }

Amazon SQS クライアントは、ReceiveMessage() メソッドを使用して Amazon SQS コンシューマとして機能できます。このメソッドでは、JSON 形式の文字列をオプションの引数として指定することで、メッセージ取得操作の設定を指定できます。そのためには、%External.Messaging.SQSReceiveSettingsOpens in a new tab クラスの新しいインスタンスを作成し、必要に応じてそのプロパティを設定します。利用できるプロパティは以下のとおりです。

• maxNumberOfMessages ：返すメッセージの最大数を指定した整数

• waitTimeSeconds ：ポーリングがタイムアウトするまでの時間 (秒数) を指定した整数

• visibilityTimeout ：メソッドから返されたメッセージを他のコンシューマが実質的に確認できる時間 (秒数) を指定した整数

例えば以下のようにします。

Set rset = ##class(%External.Messaging.SQSReceiveSettings).%New()
Set rset.waitTimeSeconds = 5
Set rset.visibilityTimeout = 30

メッセージを取得するには、Amazon SQS クライアント・オブジェクトが継承した ReceiveMessage() メソッドを呼び出します。このメソッドは、キューの名前を引数として取り、参照渡しで %ListOfObjectsOpens in a new tab としてメッセージを返します。前のセクションで説明したメッセージ取得設定を指定している場合は、ToJSON() メソッドを使用して、その設定を 3 番目の引数として指定します。例えば以下のようにします。

 #dim messages As %ListOfObjects
 Set tSC = client.ReceiveMessage(queue, .messages, rset.ToJSON())

キューのメッセージを受信して処理した Amazon SQS コンシューマは、キューからそのメッセージを削除する必要があります。メッセージを削除するには、クライアント・オブジェクトの DeleteMessage() メソッドを呼び出します。DeleteMessage() では、キューの名前を 1 番目の引数、メッセージの受信ハンドルを 2 番目の引数としてそれぞれ指定する必要があります。受信ハンドルは、ReceiveMessage() メソッドから返された、メッセージごとの receiptHandle プロパティに保存されています。

For i=1:1:messages.Size {
        Set msg = messages.GetAt(i)
        Write "Message: ", msg.ToJSON(), !
        Set tSC = client.DeleteMessage(queue, msg.receiptHandle)
 }

キューの設定を指定する場合は、%External.Messaging.SQSQueueSettings オブジェクトを作成し、そのオブジェクトのプロパティのうち、目的の設定に対応するものを設定します。使用できる構成オプションの詳細は、Amazon SQS のドキュメントOpens in a new tabを参照してください。

例えば、以下のコードでは、先入れ先出しキューを指定するキュー設定オブジェクトを作成し、そのキューへ 5 秒間の遅延ですべてのメッセージを配信します。

 Set queueSet = ##class(%External.Messaging.SQSQueueSettings).%New()
 Set queueSet.FifoQueue = 1
 Set queueSet.DelaySeconds = 5

キューを作成するには、クライアント・オブジェクトの CreateQueue() メソッドを呼び出します。CreateQueue() では、キュー名を引数で指定する必要があります。前のセクションの説明にあるようにキューのキュー設定オブジェクトを作成していれば、そのオブジェクトを 2 番目のオプションの引数として指定できます。

 Set queue = "quick-start-events"
 Set tSC = client.CreateQueue(queue, queueSet)

また、すべてのメッセージング・プラットフォームに共通のメソッドを使用して、キューを作成することもできます。この代替手法を使用する場合は、ToJSON() メソッドを使用して、キュー設定オブジェクトのコンテンツを JSON オブジェクトとして指定できます。詳細は、"%External.Messaging.Client.CreateQueueOrTopic()Opens in a new tab" を参照してください。

アプリケーションで クライアント・オブジェクトの DeleteTopic() メソッドを呼び出すことで、Amazon SQS キューを削除できます。このメソッドは、キューの名前を引数として受け入れます。

Set tSC = client.DeleteQueue(queue)

また、すべてのメッセージング・プラットフォームに共通のメソッドを使用して、キューを削除することもできます。詳細は、"%External.Messaging.Client.DeleteQueueOrTopic()Opens in a new tab" を参照してください。