Jiiフレームワークに関する一連の記事の続き 。 今日、彗星のリリースの瞬間が来ました。これについてはこの記事で説明します。



Jii-cometはスケーラブルであり、高負荷および低インターネット転送に対応しており、クライアントとサーバー間の絶え間ない接続を実現して、瞬時にデータを交換します。

Jii-cometは、チャネル間のメッセージング、それらへのサブスクライブ、サーバー間のデータ交換などを簡素化するコンポーネントとクラスのセットを提供します。 モジュール自体はクライアントにメッセージを配信する方法を認識しませんが、その逆も同様です。既存の一般的なライブラリ（たとえば、 socket.io 、 sockjs ）で実行できるように、また信頼性と拡張性を高めるために抽象化が含まれています。

このフレームワークについて初めて耳にする人には、 以前の記事を読むか、サイトにアクセスすることをお勧めします 。 要するに、

Jiiは、アーキテクチャとAPIがYii 2.0 PHPフレームワークに基づいているフレームワークであり、それを最大限に活用し、JavaScriptの利点を保持しています。

復習

まず、彗星とは何かに関する少しの助け（ wiki ）：

Comet（Web開発）-Webアプリケーションの任意のモデル。一定のHTTP接続により、Webサーバーは、ブラウザーからの追加要求なしにブラウザーにデータを送信（プッシュ）できます。

Jii-cometの機能

顧客：

• チャンネルからのメッセージの送受信
• チャンネル登録
• サーバー上のアクションを呼び出す
• バランシング（サーバーのランダム選択）
• メッセージトランスポートを変更する機能

サーバー：

• チャンネルからのメッセージの送受信
• チャンネルからのメッセージを購読する
• チャンネルへの接続に署名する
• 接続へのメッセージの送信
• メッセージトランスポート、ハブ、およびキューを変更する機能
• 複数のプロセスとサーバーへのスケーリング
• リッスンオンリーモード
• キューからアクションを実行する

設置

コメットは、 アプリケーションコンポーネントとしてサーバーとクライアントにそれぞれインストールされます。 サーバー上で、彗星が開き、指定されたポートからのデータを「リッスン」します。クライアントは、アプリケーションを初期化するときにこのポートに接続し、情報を待ちます。

クライアントがサーバー上のテストチャネルにサブスクライブし、そこにメッセージを送信するアプリケーションの例を考えてみましょう。
サーバー：

var Jii = require('jii'); require('jii-comet'); require('jii-workers') .application('comet', Jii.mergeConfigs( { application: { basePath: __dirname, components: { comet: { className: 'Jii.comet.server.Server', port: 4401, /** * * @param {Jii.comet.server.ConnectionEvent} event */ 'on addConnection': function(event) { Jii.app.comet.subscribe(event.connection.id, 'test'); } } } } }, custom.comet || {} )); 

顧客：

 require('jii/deps'); require('jii-comet/sockjs'); Jii.createWebApplication({ application: { basePath: location.href, components: { comet: { className: 'Jii.comet.client.Client', serverUrl: 'http://localhost:4401/comet', /** * * @param {Jii.base.Event} event */ 'on open': function(event) { Jii.app.comet.send('test', {message: 'Hello World'}); }, /** * * @param {Jii.comet.ChannelEvent} event */ 'on channel:test': function(event) { console.log('Income message: ' + event.params.message); } } } } }).start(); 

次に、サーバーとクライアントのコンポーネントを見てみましょう。

コメットサーバー

Jii-cometは、サーバーを作成するための2つのクラスを提供します。

• Jii.comet.server.HubServerは、接続からのメッセージのみをリッスンするように構成されたサーバーであり、接続自体はありませんが、隣接プロセスにある接続にデータを送信できます。 つまり そのようなサーバー（ポート上）に直接接続することはできませんが、メッセージは他のプロセス（クライアントが接続されているプロセス）を介して送信できます。
• Jii.comet.server.Serverは本格的なサーバーであり、以前のサーバーから継承されます。 クライアントとの直接接続を保存および維持し、クライアントとデータを交換できます。

この分離は、アプリケーションの柔軟なスケーリングに必要です。 たとえば、クライアントへの接続のみをサポートし、ビジネスロジックを処理しないJii.comet.server.Serverコンポーネントを使用して、いくつかのプロセスを作成できます。 そして、重い計算を実行するいくつかのJii.comet.server.HubServerプロセスを作成します。 これにより、コメットチャネルの応答性が向上します。すべての操作が同じサーバー上で行われた場合、複雑な操作によりプロセスが遅くなり、後続のすべての要求（軽い要求でも）が遅延します。

大きな負荷がないか、何を選択すればよいかわからない場合は、 Jii.comet.server.Serverコンポーネントを選択してください 。これにはすべての機能が含まれています。

サーバーの構成例は次のようになります。

 application: { components: { comet: { className: 'Jii.comet.server.Server', host: '0.0.0.0', port: 3100 }, // ... } } 

プロパティ、メソッド、およびイベントの完全なリストを以下に示します。

Jii.comet.server.HubServer

プロパティ

• listenActions （boolean）-クライアントからアクションを呼び出すためのリクエストを受け入れるかどうか。 デフォルトではtrueです。
• ハブ （オブジェクト）-プロセスまたはサーバー間でメッセージを交換するためのJii.comet.server.hub.HubInterfaceインターフェースを実装するハブ、コンポーネント、またはその構成。 デフォルトでは、 Jii.comet.server.hub.Redisコンポーネントが作成されます。
• キュー （オブジェクト）-キュー、コンポーネント、またはその構成。アクション（アクション）の呼び出しのキューを蓄積するためのJii.comet.server.queue.QueueInterfaceインターフェースを実装します。 デフォルトでは、 Jii.comet.server.queue.Redisコンポーネントが作成されます。

方法

• start（） - ハブおよびキューコンポーネントの接続を開き、チャネルからのメッセージのリッスンを開始します。
• stop（） -コンポーネントのすべての接続を切断し、外部からの情報の受信を停止します。
• sendToChannel（チャネル、データ） -ハブ内のチャネルにメッセージを送信します。 ここで、 channelは（string） チャネルの名前であり、 dataは（string | object | *）送信するデータです。
• sendToConnection（id、data） -前のメソッドと同様に、データを送信しますが、チャネルではなく、直接接続に送信します。 ここでid （string）はJii.comet.server.Connectionから取得した接続識別子であり、 dataは（string | object | *）送信するデータです。
• on（名前、ハンドラー、データ、isAppend）およびoff（名前、ハンドラー）は、イベントをサブスクライブおよびサブスクライブ解除するためのメソッドです。 イベントのリストを以下に説明します;引数の説明はイベントセクションにあります。
• hasChannelHandlers（name） -プロセスに名前 （文字列）チャネルのサブスクライバーがいる場合、 trueを返します。

イベント

• チャネル -イベントは、任意のチャネルへの着信メッセージによってトリガーされます。 ハンドラーの最初の引数は、 チャネル （文字列）およびメッセージ （文字列）パラメーターを持つJii.comet.ChannelEventクラスのインスタンスです。
• channel：％my_channel_name％ -イベントは、後に指定されたチャネルへの着信メッセージで発生します

たとえば、 Jii.app.comet.on（ 'channel：test'、...）が呼び出されると、 メッセージはテストチャネルにサブスクライブされます。 上記のように、パラメータchannel （string）およびmessage （string）を持つJii.comet.ChannelEventクラスのインスタンスは、最初の引数としてイベントハンドラーに渡されます。
message-ハブへの着信メッセージがあると、イベントが発生します。 ハンドラーの最初の引数は、 メッセージ （文字列）パラメーターを持つJii.comet.server.MessageEventクラスのインスタンスです。

Jii.comet.server.Server

上記のプロパティ、メソッド、およびイベントを継承し、次を追加します。

プロパティ

• host （文字列）-クライアントからの着信接続を待機しているホスト。 デフォルトでは、 0.0.0.0です。
• port （number）-着信接続用のポート。 デフォルトでは、 4100です。
• transport （オブジェクト）-クライアント（ブラウザ）と直接メッセージを交換するためのJii.comet.server.transport.TransportInterfaceインターフェースを実装するコンポーネントまたはその構成。

方法

• subscribe（connectionId、channel）およびunsubscribe（connectionId、channel） -指定されたチャネルへの接続に署名し、登録を解除します。 Jiiは、メッセージの競合を回避するために、サーバー上のチャネルにサブスクライブすることをお勧めします。 メソッドでは、 connectionId （文字列）はJii.comet.server.Connectionから取得した接続識別子であり、 channel （文字列）はチャンネルの名前です。

イベント

• addConnection-新しいクライアントが参加するとイベントが発生します。 ハンドラーの最初の引数は、 接続パラメーター（ Jii.comet.server.Connection ）を持つJii.comet.server.ConnectionEventクラスのインスタンスです。
• removeConnection-クライアントへの接続が失われたときにイベントが発生します。 前の例と同様に、 Jii.comet.server.ConnectionEventクラスのインスタンスがハンドラーの最初の引数として渡されます。

Jii.comet.server.Connection

クライアント接続情報が含まれています

プロパティ

• id （文字列）-接続識別子。 接続にメッセージを直接送信するために使用されます。
• リクエスト （ Jii.comet.server.Request ）-接続情報：ヘッダー、IPアドレス、接続ポートなど。
• originalConnection （オブジェクト）-トランスポートから受信した接続の内部インスタンス。 各車両に固有。

彗星クライアント

クライアントは少し単純です。1つのコンポーネントJii.comet.client.Clientがあり、サーバーの1つに接続してデータを交換します。

 application: { components: { comet: { className: 'Jii.comet.client.Client', serverUrl: 'http://localhost:4401/comet', autoOpen: true }, // ... } } 

プロパティ、メソッド、およびイベントの完全なリストを以下に示します。

Jii.comet.client.Client

プロパティ

• transport （オブジェクト）-サーバーとメッセージを交換するためのJii.comet.client.transport.TransportInterfaceインターフェースを実装するコンポーネントまたはその構成。
• プラグイン （オブジェクト）-コンポーネントまたはその構成のセット。それぞれがクライアントコメットの機能を拡張するためにJii.comet.client.plugin.PluginInterfaceインターフェースを実装します。
• workersCount （number | null）-サーバーワーカーの最大数。 この設定は、クライアントの負荷を分散するために使用されます。 デフォルトでは、 nullは無効になっています。
• autoOpen （ブール値） -trueの場合、彗星アプリケーションが初期化されると、クライアントは自動的にサーバーに接続します。 デフォルトではtrueです。

イベント

• open-接続が正常に開かれたときにイベントが発生します。
• close-イベントは、接続が閉じられたときに発生します。
• beforeSend-イベントは発信メッセージで発生します。 ハンドラーの最初の引数は、 messageパラメーターを持つJii.comet.client.MessageEventクラスのインスタンスです。 メッセージパラメーターを変更することにより、送信されるメッセージを変更できます。 メッセージパラメーターのデータはサーバーに送信されます。
• channel-イベントは、サブスクライブされたチャネルへの着信メッセージによってトリガーされます。 ハンドラーの最初の引数は、 チャネル （文字列）およびメッセージ （文字列）パラメーターを持つJii.comet.ChannelEventクラスのインスタンスです。
• channel：％my_channel_name％ - ：の後に指定されたサブスクライブされたチャネルへの着信メッセージでイベントが発生します。 たとえば、 Jii.app.comet.on（ 'channel：test'、...）が呼び出されると、 メッセージはテストチャネルにサブスクライブされます。 上記のように、パラメータchannel （string）およびmessage （string）を持つJii.comet.ChannelEventクラスのインスタンスは、最初の引数としてイベントハンドラーに渡されます。
• message-着信メッセージでイベントが発生します。 ハンドラーの最初の引数は、 メッセージ （文字列）パラメーターを持つJii.comet.server.MessageEventクラスのインスタンスです。
• beforeRequest-クライアントがアクションを完了するためにサーバーにリクエストを送信しようとする前にイベントが発生します。 ハンドラーへの最初の引数は、パラメーターroute （string）およびparams （object）を持つJii.comet.client.RequestEventクラスのインスタンスです。 このイベントで要求パラメーターを変更できます。paramsパラメーターからのデータはサーバーに送信されます。
• request-サーバーが以前に要求されたアクションに応答すると、イベントが発生します。 ハンドラーへの最初の引数は、パラメーターroute （string）およびparams （object）を持つJii.comet.client.RequestEventクラスのインスタンスです。

プラグイン

プラグインを使用すると、クライアントの彗星の機能を拡張できます。 デフォルトでは、 Jii.comet.client.plugin.AutoReconnectを自動的に再接続するプラグインがインストールされます。 プラグインの作成と接続は非常に簡単です。 Jii.comet.client.plugin.PluginInterfaceプラグインインターフェースはメソッドの実装を必要としませんが、cometイベントにサブスクライブできるcometパラメーターを介してのみcometクライアントへのアクセスを提供します。 プラグインは、 プラグインセクションに追加することにより、構成を通じてインストールおよび構成されます。

 application: { components: { comet: { className: 'Jii.comet.client.Client', // ... plugins: { autoReconnect: { enable: false }, myPlugin: { className: 'app.components.MyCometPlugin' } } }, // ... } } 

仕組み

一見、jii-cometは彗星輸送ライブラリ（sockjs、socket.io-から選択）のラッパーですが、そうではありません。 クライアントへのメッセージ配信機能とその逆のみがトランスポートライブラリから取得されます。 チャネル、サブスクリプション、スケーリング、および追加機能の実装はjii-cometで行われました。 アーキテクチャ的に「内部」のjii-cometは、次のコンポーネントに分割されます。

サーバー：

• トランスポート（ Jii.comet.server.transport.TransportInterface ）-クライアントとサーバー間のメッセージ交換の抽象化。
• ハブ（ Jii.comet.server.hub.HubInterface ）-プロセスとサーバー間のメッセージ交換の抽象化。
• キュー（ Jii.comet.server.queue.QueueInterface ）は、アクション呼び出しを蓄積するための抽象化です。
• 接続（ Jii.comet.server.Connection ）-このクラスのインスタンスには接続情報が含まれており、コンテキストコンポーネントとして使用できます 。

顧客：

• トランスポート（ Jii.comet.client.transport.TransportInterface ）-クライアントとサーバー間のメッセージ交換の抽象化。
• プラグイン（ Jii.comet.client.plugin.PluginInterface ）-クライアントコメットの機能を拡張するための抽象化。 デフォルトでは、 Jii.comet.client.plugin.AutoReconnectを自動的に再接続するプラグインがインストールされます。

これらの抽象化はすべて、アプリケーションの構成とコンテキストを通じてカスタマイズおよび再定義できます。

例

• 複数の顧客
• 接続を維持するためのいくつかのサーバープロセス（ Jii.comet.server.ServerおよびlistenActions = false ）
• 接続を維持し、アクションを処理するためのいくつかのサーバープロセス（ Jii.comet.server.ServerおよびlistenActions = true ）
• アクションのみを処理するための複数のサーバープロセス（ Jii.comet.server.HubServerおよびlistenActions = true ）

例：クライアントがチャネルにメッセージを送信します

1. クライアントはテストチャネルにメッセージを送信します。
2. 接続をサポートするサーバープロセスはこのメッセージを受信し、ハブ（ Jii.comet.server.hub.HubInterface ）に送信します。
3. ハブは、このチャネルにサブスクライブしている（または接続が署名されている）すべてのサーバープロセスにこのメッセージを送信します。
4. サーバープロセスはメッセージを受信し、サブスクライブしている接続に送信します。

例：クライアントがサーバーでアクションを呼び出す

1. クライアントは、 サイト/テストアクションを実行する要求を送信します。
2. 接続をサポートするサーバープロセスはそれを受け入れ、アクションキュー（ Jii.comet.server.queue.QueueInterface ）にドロップします。また、ハブ（ Jii.comet.server.hub.HubInterface ）を介して、アクションを処理するすべてのサーバーに通知を送信します（ listenActions = true ）キューが更新されたこと。
3. listenActions = trueのサーバープロセスの1つは、要求をキューから引き出し（Redisの実装でlpopメソッドを使用）、アクションを開始します。
4. アクションが完了すると、サーバープロセスはアクションの結果（応答）をクライアントに送り返します。 このサーバープロセスはクライアントと直接接続していないため、ハブ（ Jii.comet.server.hub.HubInterface ）に送信します。
5. ハブは、この接続のメッセージにサブスクライブしているサーバープロセスにメッセージを送信します。
6. この接続をサポートするサーバープロセスはメッセージを受信し、クライアントに直接送信します。

3番目の段落では、キューからのリクエストはlistenActions = trueで任意のサーバープロセスをプルできます。 これは、「誰が管理するか」の原則に従って機能し、原則として、負荷の最も少ないサーバーが間に合います。 したがって、サーバーとそのプロセス間でアクションコールのバランスがとられます。

内部通信チャネル

Jii-cometには、クライアントとサーバー間の内部通信チャネルとして任意のライブラリを使用できるようにする抽象化があります。 現時点では、 sockjsライブラリー用のアダプターが作成されており、将来はsocket.io用に表示されます 。

構成では、トランスポートはトランスポートセクションで宣言されます。 デフォルトでは、北のJii.comet.server.transport.SockjsクラスとクライアントのJii.comet.client.transport.Sockjsクラスが使用されます。
トランスポートは、構成により構成および再定義できます。

 comet: { className: 'Jii.comet.client.Client', transport: { className: 'Jii.comet.client.transport.Sockjs', transports: [ 'websocket', 'xhr-streaming', 'xdr-streaming', 'jsonp-polling' ] } } 

終わり

フレームワークサイト-jiiframework.ru
Github-github.com/jiisoft
affka@affka.ruに提案や提案を送ってください

フレームワークのアイデアが好きですか？ githubに 星をつけてください！