カンタン非同期処理のNode-REDはデータ構造から始めよ！

node.js上で動くNode-REDのプログラムは ノードと呼ばれるモジュールをつなげることで非同期処理を簡単に記述することができます。

ここまでは簡単なプログラミングの説明をしてきましたが、今回は少し大きなプログラムを開発する場合を考えてみます。Node-REDでロジックを書く場合はファンクションノードにJavascriptで用なプログラミングします（カスタムノードを作ることもできます）。

Javascriptというといわゆる「コールバック地獄」(google検索)が連想されますが、Node-REDならノードを分けることで、快適にプログラミングできます。ここでは、なつかしのジャクソン法の命名にならって４つに分類してみましょう。

基本

単純な処理は一つのファンクションノードで書くことができます。

図中のインジェクトノードからmsgオブジェクトを受け取って処理を行い、msgオブジェクトをreturnします。returnしたオブジェクトは次のデバッグノードでデバッグタブに出力されます。

連接

複数のノードを前後につなげます。処理1のノードがmsgオブジェクトをreturnすると、後続の処理2が実行されます。

全体としては非同期処理ですので、途中で外部呼び出しをすると、別の処理が開始されることがありますが、入力データの単位で見ると処理1と処理2は順次的に行われます。

選択

データに応じて処理を分ける場合、出力を複数に分けることができます。配列をreturnするとそれぞれが出力されます。出力が不要な場合は、その番号のところにnullをセットしておきます。

同じデータを渡すだけであれば１つの出力を複数のノードに渡すこともできます。
経験的には出力を複数にすると出力番号順、１つから複数に分けると後続のノードの作成順に実行される様に思いますが、保証されたものではありません。

反復

１つの入力から同じ処理を非同期に複数実行することもできます。node.send(obj)が呼ばれると処理中に、非同期に、後続処理が実行されます。

後続の処理は受け取ったオブジェクトをmsgとして処理しますので、returnで渡す場合と同じ様にnode.send()の引数もオブジェクトでないといけません。

ノード間のインタフェース

ノード間は関数呼び出しではないので引数がありません。Webプログラミングのセッション情報がmsgとして流れていくイメージが近いと思います。

msgはフロー（つまりタブ）をスコープとするFlow contextや全体で共通のGlobal contextと異なって、msg単位で独立しています。しかし引数と違って、ある処理が使わないデータが後続の処理で使われる場合もありますので、むやみに破壊することができません。

チェック＆カスケード

安全なノードの基本構造はチェック＆カスケードです。入力のmsgオブジェクトをチェックし、必要な処理を行い、受け取ったmsgオブジェクトをそのまま次のノードにカスケードします。

もちろん、msgオブジェクトに追加や変更をすることもありますが、受け取ったmsgオブジェクトを破壊しないことが基本です。

汎用性と保守性は違う

多くの言語では、汎用モジュールを参考にすると保守性の高いプログラミングが可能です。しかし、Node-REDでは注意が必要です。

Node-REDの標準ノードの多くはmsg.payloadをインタフェースにしています。しかし、始端あるいは終端となるノード以外でマネをすると、後続処理がmsg.payloadを退避する必要が生じてノード間の依存が強くなってしまい、保守性が悪くなります。

そこで、データの種類に応じてmsgオブジェクトにプロパティを追加する必要が出てきます。

データ構造から始めよ！

はじめに説明した様にNode-REDはファンクションノードによって、非同期処理を簡単かつ柔軟に扱うことができます。その反面、引数がないのでmsgオブジェクトを誤って破壊しない様に、データ構造をきちんと設計しておくべきです。

命名に用いたジャクソン法の4分類は、プログラムのデータ構造の分類です。それぞれに応じたフローがあるのですから、データ構造をどのようにするかを設計できれば容易に実装できるでしょう。

今回は全て配列をmsgにセットして渡しましたが、「選択」の場合は連想配列にすると見通しが良くなるかもしれません。このあたりは通信プロトコルなどの制約に応じて工夫してください。

おわりに

これまで説明してきた様にNode-REDは、設定中心のプログラミングが可能（Hello World!からNode-REDを知る）、通信に強い（RedmineのREST API を呼ぶ）、 ソーシャルに強い[Node-REDでTwitterのDMからRedmineのチケットを作成する）といった特徴がありますが、今回取り上げた非同期処理が簡単なことは、node.js上のNode-REDならではの特徴でしょう。

Javascriptだとコールバック地獄に落ち入りがちな順次処理が、フローをつなげることで簡単に実現できますし、データ構造にあわせた非同期処理も可能です。

書籍が出版されるなどIoT環境として注目されるNode-RED。ビジュアルでお手軽な点が強調されがちですが、注目されている理由はこの辺りにあるのかも知れません。

[{"id":"a11bccb7.27e1","type":"inject","z":"27f9b08a.d8274","name":"","topic":"","payload":"[\"a\",\"b\",\"c\"]","payloadType":"json","repeat":"","crontab":"","once":false,"x":190,"y":360,"wires":[["602d509a.3620c8"]]},{"id":"249841f2.fdad9e","type":"debug","z":"27f9b08a.d8274","name":"","active":true,"console":"false","complete":"false","x":590,"y":360,"wires":[]},{"id":"602d509a.3620c8","type":"function","z":"27f9b08a.d8274","name":"処理; return msg;","func":"// 処理\n\nreturn msg;","outputs":1,"noerr":0,"x":390,"y":360,"wires":[["249841f2.fdad9e"]]},{"id":"53bf216f.6f1a08","type":"inject","z":"27f9b08a.d8274","name":"","topic":"","payload":"[\"a\",\"b\",\"c\"]","payloadType":"json","repeat":"","crontab":"","once":false,"x":190,"y":720,"wires":[["9b42e6b0.343ca"]]},{"id":"273b9052.147bf8","type":"debug","z":"27f9b08a.d8274","name":"","active":true,"console":"false","complete":"false","x":650,"y":720,"wires":[]},{"id":"9b42e6b0.343ca","type":"function","z":"27f9b08a.d8274","name":"node.send(msg.payload[i]);","func":"var str = {};\nfor (var i=0; i<3; i++) {\n    str.payload = msg.payload[i];\n    node.send(str);\n}\nreturn;","outputs":1,"noerr":0,"x":420,"y":720,"wires":[["273b9052.147bf8"]]},{"id":"27c28522.12d0f2","type":"inject","z":"27f9b08a.d8274","name":"","topic":"","payload":"[\"a\",\"b\",\"c\"]","payloadType":"json","repeat":"","crontab":"","once":false,"x":190,"y":600,"wires":[["4f024dc6.60be84"]]},{"id":"4f024dc6.60be84","type":"function","z":"27f9b08a.d8274","name":"return [out1,out2,out3];","func":"var out1 = {payload: msg.payload[0]};\nvar out2 = {payload: msg.payload[1]};\nvar out3 = {payload: msg.payload[2]};\n\n// 出力がない場合はnullをセットする\n\nreturn [out1,out2,out3];","outputs":"3","noerr":0,"x":410,"y":600,"wires":[["a777e498.aa86a8"],["46f414b5.131a7c"],["93110da4.4f47d8"]]},{"id":"46f414b5.131a7c","type":"debug","z":"27f9b08a.d8274","name":"out2","active":true,"console":"false","complete":"payload","x":630,"y":600,"wires":[]},{"id":"93110da4.4f47d8","type":"debug","z":"27f9b08a.d8274","name":"out3","active":true,"console":"false","complete":"payload","x":630,"y":640,"wires":[]},{"id":"a777e498.aa86a8","type":"debug","z":"27f9b08a.d8274","name":"out1","active":true,"console":"false","complete":"payload","x":630,"y":560,"wires":[]},{"id":"df8bd8b5.670d1","type":"comment","z":"27f9b08a.d8274","name":"基本","info":"処理を実行します。","x":110,"y":320,"wires":[]},{"id":"6c9bb4e2.5bd1f4","type":"comment","z":"27f9b08a.d8274","name":"連接","info":"処理1がreturnした後に処理2が行われます。","x":110,"y":400,"wires":[]},{"id":"d3e27c69.f6eca8","type":"inject","z":"27f9b08a.d8274","name":"","topic":"","payload":"[\"a\",\"b\",\"c\"]","payloadType":"json","repeat":"","crontab":"","once":false,"x":190,"y":440,"wires":[["f0184c5e.c2e49"]]},{"id":"f6623197.059fd8","type":"debug","z":"27f9b08a.d8274","name":"","active":true,"console":"false","complete":"false","x":650,"y":500,"wires":[]},{"id":"f0184c5e.c2e49","type":"function","z":"27f9b08a.d8274","name":"処理1; return msg;","func":"// １つ目の処理\nmsg.out = msg.payload[0];\n\nreturn msg;","outputs":1,"noerr":0,"x":390,"y":440,"wires":[["6a632a11.e600c4"]]},{"id":"6a632a11.e600c4","type":"function","z":"27f9b08a.d8274","name":"処理2; return msg;","func":"// 2つ目の処理\nmsg.out += msg.payload[1];\nmsg.out += msg.payload[2];\nmsg.payload = msg.out;\n\nreturn msg;","outputs":1,"noerr":0,"x":450,"y":500,"wires":[["f6623197.059fd8"]]},{"id":"2f8d825e.fec476","type":"comment","z":"27f9b08a.d8274","name":"選択","info":"return後にそれぞれのデータで後続処理を実行します。","x":110,"y":540,"wires":[]},{"id":"7a239044.c1d8f8","type":"comment","z":"27f9b08a.d8274","name":"反復","info":"処理を行いながら、後続処理を非同期に実行します。","x":110,"y":680,"wires":[]}]