WebSocket実装

目次

• 概要
• 使用する場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

適切な接続管理、メッセージルーティング、エラーハンドリング、および水平スケーリング対応を備えた、スケーラブルなWebSocketシステムを構築します。

使用する場面

• リアルタイムチャットおよびメッセージング構築
• ライブ通知の実装
• 共同編集ツールの作成
• ライブデータ更新のブロードキャスト
• リアルタイムダッシュボード構築
• クライアントへのイベントストリーミング
• リアルタイムマルチプレイヤーゲーム

クイックスタート

最小限の動作例：

const express = require("express");
const http = require("http");
const socketIo = require("socket.io");
const redis = require("redis");

const app = express();
const server = http.createServer(app);
const io = socketIo(server, {
  cors: { origin: "*" },
  transports: ["websocket", "polling"],
  reconnection: true,
  reconnectionDelay: 1000,
  reconnectionDelayMax: 5000,
  reconnectionAttempts: 5,
});

// 水平スケーリング用のRedisアダプター
const redisClient = redis.createClient();
const { createAdapter } = require("@socket.io/redis-adapter");

io.adapter(createAdapter(redisClient, redisClient.duplicate()));

// 接続管理
const connectedUsers = new Map();

// ... (完全な実装はリファレンスガイドを参照してください)

リファレンスガイド

詳細な実装は references/ ディレクトリにあります：

ガイド	内容
Node.js WebSocketサーバー (Socket.IO)	Node.js WebSocketサーバー (Socket.IO)
ブラウザWebSocketクライアント	ブラウザWebSocketクライアント
PythonWebSocketサーバー (aiohttp)	Python WebSocketサーバー (aiohttp)
メッセージタイプとプロトコル	メッセージタイプとプロトコル
Redisでのスケーリング	Redisでのスケーリング

ベストプラクティス

✅ すべきこと

• 適切な認証を実装する
• 再接続をグレースフルに処理する
• ルーム/チャネルを効果的に管理する
• メッセージを適切に永続化する
• アクティブな接続を監視する
• プレゼンス機能を実装する
• スケーリングにはRedisを使用する
• メッセージ確認応答を追加する
• レート制限を実装する
• エラーを適切に処理する

❌ すべきでないこと

• 暗号化されていない機密データを送信する
• 無制限のメッセージ履歴をメモリに保持する
• 任意のルーム/チャネル作成を許可する
• 切断された接続のクリーンアップを忘れる
• 大容量メッセージを頻繁に送信する
• ネットワーク障害を無視する
• メッセージにパスワードを保存する
• 認証/認可をスキップする
• 接続の無制限な増加を許可する
• 最初からスケーラビリティを無視する