PHP meets NodeJS

PHP meets NodeJSPHPに簡単にPUSH機能を組み込む

13年8月4日日曜日

まずは自己紹介簡単に自己紹介

Name : takyam （たくやむ）

Work : WEBアプリケーションエンジニア？

Twitter : @takyam

Blog : http://new.takyam.com/

GitHub : http://github.com/takyam-git

Bitbucket : https://bitbucket.org/takyam


http://new.takyam.com


http://github.com/takyam-git

http://github.com/takyam-git

https://bitbucket.org/takyam

https://bitbucket.org/takyam

PHPで通知機能

PHPでFacebookの通知機能のようなものを実装したい事ありますよね？

画面遷移を挟まずにユーザーへの通知が表示される機能です。

私はPUSH通知と呼んでるのですがこれをPHPで作りたいとおもいます


通知機能を作るにはサーバー側からPUSHする必要がありますが、いくつかの手法があります

ポーリング（実際はPUSHでは無い）

Commet

Websocket

それぞれメリット・デメリットがあります

今回はWebsocketを使ってみたいと思います


Websocketを使う

PHP単体でもWebsocketを扱えるようなライブラリはあります

とはいえWAFに組み込むのは難しいので今回はNodeJSを使います

Websocketの部分はNodeJSに全ておまかせです！


NodeJS分かんねぇよ

そんな硬派なPHPerも大丈夫！

NodeJSは全部で100行くらいなので、コピペすりゃOK

一度作ればNodeJSメンテナンス不要なイケてるシステムです


今回のシステムの前提今回のPUSHを実現するための前提条件が２つあります

NodeJSがPHPと同ドメイン（ポート違いOK）で運用できる

Redisが使える

これだけ！


まずはイメージをつかむ

文字で説明するのも大変なので簡単なイメージ図をご紹介

まず最終的な完成形のイメージを掴んでください


最終的な構成HTTP POST

Redis PUBLISH

Redis SUBSCRIBEWebsocket Connections



Redis PUBLISH


投稿に対してのコメントをAjaxでPHPにPOSTリクエスト



Redis PUBLISH


コメントのDBへの保存処理などを実施



Redis PUBLISH


コメントが来たよ通知JSONをRedisにPUBLISH



Redis PUBLISH


SUBSCRIBEしてるNodeJSが通知JSONを受信



Redis PUBLISH


通知JSONから通知対象のユーザーを選択する



Redis PUBLISH


通知対象のユーザーのWebsocketを使ってPUSH通知（JSON）を送信！



Redis PUBLISH


受け取ったPUSH通知JSONを元に画面の表示を更新


どうですか？そんなに複雑な構成では無いとおもいます

ポイントは以下の３つ

ユーザーからのデータ送信はAjaxので処理する

Redis経由でPHPがNodeJSに、一方通行でJSONを送る

NodeはPHPからのJSONを元にWebsocketでデータを送信する


なんでAjax？

コレ以上Nodeに複雑な処理持たせたくないから

PHP側だけで処理できる事はPHPだけでやった方が楽ですよね


Redisのpub/sub？

これもNode側の実装が楽だから

HTTPリクエスト処理するための何やかんや用意しなくてOK

JSONかわいいよJSON


Nodeが送信？

Nodeは決まったフォーマットのJSONに従ってJSONを配信するだけ

つまり、かなり定型的な処理しか行わない

つまり、Nodeの実装が楽っ☆


つまり

いかにNodeを触らなくて良いかを考えた構成になってます

Node大好きっ子ですが、メインがPHPなので複雑にしたくなかったのです


PHP/Node間のJSON“target_user_ids” のWebsocketに対して “data” を送るだけですね

{ “target_user_ids”: [1,2,10,22], “data”: { “type”: “notice_message”, “message”: “コメントがありました”,

“datetime”: “2013-08-03 15:12:32” }}

←配信対象のユーザーIDリスト

←配信データ}13年8月4日日曜日

“target_user_ids”???

ユーザーIDはPHP側にしか持ってません

NodeJS側は会員認証も何も持ってないのだから

ユーザーID渡されてもどのWebsocketがどのユーザーIDか分からなくね？


ユーザーIDをNodeと共有

というわけで、ここが肝なのですが、ユーザーIDをNode側に知らせる必要があります

方法は簡単、ユーザーIDを返すAPIをPHP側に用意するだけ！

ではイメージ図いってみましょう


ユーザーID取得処理


ユーザーID取得処理1.ページを開く(GETリクエスト)



2. HTML/JSを返す



3. Websocketを繋ぐ(リクエスト)

2. HTML/JSを返す




2. HTML/JSを返す

Session Cookie

SessionCookieが同時に送られる




2. HTML/JSを返す

Session Cookie


4. Websocket接続確立




2. HTML/JSを返す

Session Cookie


5.NodeからPHPにHTTPリクエスト





2. HTML/JSを返す

Session Cookie



Session Cookie受け取ったSession

Cookieを添えて





2. HTML/JSを返す

Session Cookie




Cookieを添えて

6.ユーザーIDを返す4. Websocket接続確立




2. HTML/JSを返す

Session Cookie




Cookieを添えて


7.WebsocketとユーザーIDを紐付ける


ポイントは1.ページを開く(GETリクエスト)


2. HTML/JSを返す

Session Cookie




Cookieを添えて






2. HTML/JSを返す

Session Cookie




Cookieを添えて



Websocketコネクション時のHandshakeの時に

PHP側のSessionCookieが送られる




2. HTML/JSを返す

Session Cookie




Cookieを添えて



SessionCookieを含めてPHPにリクエストつまり、PHP的にはユーザーからのリクエストと一緒


Nodeがユーザーになりきれる

Node側がユーザーを偽装する事ができますね！

PHP側がリクエストユーザーの、ユーザーIDを返すAPIを用意すればOK

これで、WebsocketにPHP側のユーザーIDを紐付ける事ができます


ユーザーID偽装のために

PHP側のSessionCookieをNode側に送信する必要があります

Cookieの送信ポリシー的に同じドメインである必要があります

なので、ポートは違っていいですが、NodeもPHPも同ドメインで運用してください


というわけで

省エネでPHPからPUSH通知を送る事ができます

例としてPHPあげましたが、PerlでもRubyでも同じ事はできるはずです


最後にこの資料作るきっかけになった投稿をくれた方々に感謝です

https://groups.google.com/forum/#!topic/nodejs_jp/gU2347-33PQ

簡単なサンプル（通知ではなくてチャットですが）も作りましたのでよろしければ

https://github.com/takyam-git/phpchat_example/






ありがとうございました

ご連絡は @takyam までぜひぜひ～

ブログも見てね～

http://new.takyam.com/


http://twitter.com/takyam

http://twitter.com/takyam



PHP meets NodeJS

Technology

Transcript of PHP meets NodeJS