一.概要
本マニュアルでは、以下の内容について紹介します。
WebSocketの利点
WebSocketの必要性
WebSocketの設定方法
WebSocketが正しく動作しない時の対処法
二.WebSocketの作用
WebSocketを利用することで、サーバーからクライアントまでデータを送信することができます。
WebSocket APIでは、クライアントとサーバーの間では、ハンドシェイク一回で、永続的な接続が形成され、双方向でデータ転送が可能になります。
WebSocketは、主にtokenの更新、ユーザーの強制ログアウト、プラットフォームメッセージ、メモリとCPU状況の更新、そしてプラットフォームログ、現在のシステムオンライン数、データ接続編集状態の取得に使用されます。
三.WebSocketポート設定
1.デフォルトポート
FineReport プロジェクトでは、自動でWebSocketポートとWebSocket転送ポートが設定されています。
応用環境によって、2つのポートの有効順序は同じではありません。以下の順番に従い、どれか一つのポートの使用が成功した場合、他のポートはテストしなくなります。
| ポート | JAR ファイル | ID | 規定値 | 複数値設定 |
|---|---|---|---|---|
| Websocket ポート | - | WebSocketConfig.port | ["38888", "39888"] | 可能 |
| Websocket 転送ポート | 2019-11-08 以前 | WebSocketConfig.requestPort | 38889 | 可能 |
| 2019-11-08 及び以降 | WebSocketConfig.requestPorts | 38889 | 可能 |
2.設定方法
WebSocketポート設定方法は、自由に選択できます。詳しい情報は、この表をご確認ください。
| シーン | 設定方法 |
|---|---|
| 1 台のマシンで Websocket を配置する | 1 台のマシンで Websocket を配置する |
| クラスターで Websocket を配置する | クラスターで Websocket を配置する |
| HTTPS で Websocket を設定する | HTTPS で Websocket を設定する |
| ポートを別途設定しないでWebsocketを配置する | 1 つのポートで Websocket を実現する |
4. Websocket 接続失敗
前節のWebSocketポート構成方法に従って構成された後もWebsocketが接続に失敗する場合は、 WebSocket接続失敗を参照して確認してください。