Functionノードを使う（その4）

今回も、前回に引き続きFunctionノードのサンプルフローを見つつざっとその機能を把握してみます。第四回目です。

初期化処理と終了処理

最初のサンプルは「09 - Setup and close」です。Functionノードはフロー実行時だけでなく、Node-RED起動時と終了時にもコードを実行できます。いつも通りFunctionノードのプロパティを見ていきます。
初期化処理タブではglobalコンテキストの変数を0で初期化しています。


続いてコードタブではglobalコンテキストの変数値をインクリメントしてmsg.playloadに格納しています。


最後に終了処理タブではglobalコンテキストの変数値をコンソールに出力しています。


このフローを何度か実行すると、インクリメントされた値がログに出力されます。この出力はコードタブに記載した内容の実行結果です。

終了処理が実行されることを確認するため、コンソール上でNode-REDを停止すると、以下のように最新のglobalコンテキスト内の変数値が出力されます。通常、この手の機能はログ出力が目的ではなく、リソースの解放処理のような後始末をするのに利用するのが一般的だと思います。
28 Oct 22:33:19 - [info] フローを開始します
28 Oct 22:33:19 - [info] フローを開始しました
^C28 Oct 22:34:57 - [info] フローを停止します
count: 4
28 Oct 22:34:57 - [info] フローを停止しましたつ

さらに再びNode-REDを起動してフローを実行すると、出力される値がリセットされて1、2、3、、、と増えていくのが確認できると思います。初期化処理タブに記載した内容がNode-RED起動時に実行されて変数値がリセットされたんですね。

というわけで、初期化処理と終了処理の動作が確認できました。パッと使いどころは思いつきませんが、フロー実行のたびに実行するにはコストの高い処理をNode-RED起動時に実行して、終了時に止める、みたいな感じでしょうか。ありがちなパターンかと思います。

非同期初期化

ラストのサンプルは「10 - Asyncronous setup」です。デプロイすると1秒後にログが出力されます。初期化処理でも非同期実行ができるよ、とのことです。これ以上の説明は不要かと思います。


とりあえずまとめ

さて、Functionノードのサンプルをひと通り見てきました。このノードには何でもできる全能感が漂っているので、どのノードを使えばいいか迷ったらこのノードで適当に流そうと思います。

コメント

コメントを投稿

このブログの人気の投稿

Execノードを使う

イメージ
ここのところずっと Node-RED のサンプルを見ながら各ノードの使い方を確認しています。 頭出しの記事はこちら をご確認ください。今回はExecノードです。Execノードを使うと外部のコマンドを実行することができます。コマンドが出力した、標準出力や標準エラー出力などをノードから出力できます。 標準出力の内容を出力する 最初に確認するサンプルは「 flows > node-red > function > exec > 01 - Get standard output from external command 」です。 Execノードのプロパティを見ると以下の通りになっています。 実行コマンドは「 echo 」 msg.payload で受け取った値を引数として利用 出力モードは「 コマンド終了時 - execモード 」 コマンド終了時に結果を出力します Execノードには出力ポートが3つあります。 標準出力 標準エラー出力 返却コード 実行すると、標準出力には「 Hello World! 」、返却コードには「 {code : 0} 」が出力されます。この挙動は特に説明することはないかと思います。 標準エラー出力の内容を出力する 次に確認するサンプルは「 flows > node-red > function > exec > 02 - Get error output from external command 」です。外部コマンドのエラーをポートに出力します。中身は先程のサンプルフローとほぼ同じですが、Execノードで存在しないコマンドを実行しています。 実行すると、以下のログが出力されます。これも説明不要かと思います。 実行中に出力する 最後に確認するサンプルは「 flows > node-red > function > exec > 03 - Run external command in spawn mode 」です。出力がコマンド実行中に行われるのがこれまでのサンプルと違う点です。 コマンドはwhieループ内で2秒おきに「 Hello 」を標準出力に出力し続けます。Spawnモードで実行するとループ内でechoコマンドが実行されるたびにログが出力されます。サービスっぽい挙動をす
続きを読む

Joinノードを使う（その4）

イメージ
ここのところずっと Node-RED のサンプルを見ながら各ノードの使い方を確認しています。 頭出しの記事はこちら をご確認ください。今回はJoinノードの4回目です。終わらねぇ。 確認するサンプルは、 前回 に引き続き「 読み込み > サンプル > flows > node-red > sequence > join > 02 - Manual join mode 」です。 メッセージを結合してkey/valueオブジェクトにする 5段目のフローから見ていきます。ざっくりとした流れは以下のとおりです。 DataノードでCSVデータを送信する CsvノードでCSVデータをJSONオブジェクトに変換する msg.payloadには以下のような値が指定されたメッセージ4つに分解される { name: "Apple", price: 100 } Changeノードでmsg.payload内の値を以下のプロパティに設定する msg.topic = "Apple"（msg.payload.nameの値） msg.payload = 100（msg.payload.priceの値） Joinノードで、2個の受信メッセージごとにmsg.topicの値をキーとしてkey/valueオブジェクトに結合して送信する これを実行すると、以下のようにmsg.payloadにJSONオブジェクトが指定されていることを確認できます。 メッセージを結合して結合オブジェクトにする 先ほどは結合した値がkey/valueオブジェクトでしたが、6段目のフローでは単純にオブジェクト結合します。ざっくりとした流れは以下のとおりです。 DataノードでJSON配列を送信する nameをキーに持つオブジェクトとpriceをキーに持つオブジェクトを交互に含んでいます（実際、こんなに都合の良いデータが生成されることはあるんだろうか） Splitノードで配列データを個別のメッセージに分割します Joinノードで、2個の受信メッセージごとにオブジェクトに結合して送信する これを実行すると、以下のようにmsg.payloadに2個ずつのオブジェクトがJSONオブジェクトに結合されたものが指定されていることを確認できます。ちなみに、Joinノード
続きを読む

SendGridのX-SMTPAPIヘッダの使い方（Section Tags、Substitution Tags編）

イメージ
前回に引き続き SendGrid についてです。 今回は SMTP API を使ってみました。 SMTP APIについて SendGridのSMTP APIは基本的には普通のSMTPプロトコルに則ったものですが、X-SMTPAPIヘッダというカスタムヘッダを使うことで機能を拡張することができます。 X-SMTPAPIヘッダについて X-SMTPAPIヘッダはSMTPプロトコルの拡張ヘッダです。 X-SMTPAPI: { "category": "newuser" } みたいな感じでJSON形式でパラメータを与えることで機能を拡張します。 Section TagsとSubstitution Tagsについて 今回はSMTP APIで使える機能のうちSection TagsとSubstitution Tagsを使ってみました。 Section TagsとSubsitution Tagsは送信メールの内容を宛先毎に特定の文字列を置換するための機能です。toと合わせて使うことで機能します。 例えば、X-SMTPAPIヘッダの値を以下のような形にします。 { "to": ["test1@xxx.xxx", "test2@yyy.yyy"], "sub": { "-body-": [ "-bodyFemale-", "-bodyMale-" ], "-favorite-": [ "バナナ", "カツオ" ], " "-nickname-": [ "ミキ", "サブロー" ] }, "section": { " "-bodyFemale-": "-nickname-さん！女性向けの商品のご紹介です。", "-bodyMale": "-nickn
続きを読む