websocket-implementation

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 adapter for horizontal scaling
const redisClient = redis.createClient();
const { createAdapter } = require("@socket.io/redis-adapter");

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

// Connection management
const connectedUsers = new Map();

// ... (see reference guides for full implementation)

リファレンスガイド

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

ガイド	内容
Node.js WebSocket サーバー（Socket.IO）	Node.js WebSocket サーバー（Socket.IO）
ブラウザー WebSocket クライアント	ブラウザー WebSocket クライアント
Python WebSocket サーバー（aiohttp）	Python WebSocket サーバー（aiohttp）
メッセージの種類とプロトコル	メッセージの種類とプロトコル
Redis によるスケーリング	Redis によるスケーリング

ベストプラクティス

✅ 実施すること

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

❌ 避けること

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