初心者でも安心！Node.jsでリアルタイム通信を始めるためのsocket.emit()とsocket.send()チュートリアル

2024-06-19

Node.jsにおける「socket.emit()」と「socket.send()」の違い：詳細解説

Node.jsでリアルタイムな双方向通信を実現するソケット通信において、「socket.emit()」と「socket.send()」はよく混同されます。どちらもデータ送信に関わる関数ですが、それぞれ異なる役割と機能を持ちます。この解説では、それぞれの違いを分かりやすく説明し、適切な使い分けをサポートします。

機能概要

socket.emit(): イベント名を指定してデータをクライアントへ送信します。イベント名に基づいて、クライアント側のイベントハンドラーが呼び出されます。
socket.send(): 生のバイナリデータをクライアントへ送信します。イベント名やハンドラーの仕組みは利用せず、低レベルなデータ転送を行います。

具体的な違い

項目	socket.emit()	socket.send()
データ形式	イベント名付きデータ	生バイナリデータ
送信対象	特定のイベントを購読しているクライアント	接続中のすべてのクライアント
イベントハンドラー	イベント名に基づいて呼び出し	呼び出しなし
利用シーン	イベント駆動型通信	カスタムプロトコル、高パフォーマンス通信
利点	イベント管理が容易、コードが分かりやすい	低遅延、柔軟性が高い
欠点	イベント名とハンドラーのペアが必要	データ形式の解釈が必要、エラー処理が複雑

使い分けのポイント

イベント駆動型通信: イベント名とハンドラーを用いたシンプルな通信には socket.emit() が適しています。
カスタムプロトコル: 独自のデータ形式や高パフォーマンスが求められる場合は socket.send() を利用します。
互換性: Vanilla WebSocketとの互換性が必要な場合は socket.send() を選択します。

補足

socket.broadcast: 特定のイベントを購読していないクライアントを除外して送信する場合には、socket.broadcast.emit() 関数を利用できます。
ネームスペース: Socket.IOでは、イベント名をネームスペースで区別することができます。

まとめ

「socket.emit()」と「socket.send()」は、それぞれ異なる役割と機能を持つ関数です。それぞれの特性を理解し、状況に応じて適切な使い分けることが重要です。

// server.js
const io = require('socket.io')(3000);

io.on('connection', (socket) => {
  socket.on('message', (data) => {
    console.log('Received message:', data);
    socket.emit('message-received', { message: data });
  });
});

// client.js
const io = require('socket.io')(3000);

io.on('connect', () => {
  console.log('Connected to server');
  io.emit('message', 'Hello from client!');

  io.on('message-received', (data) => {
    console.log('Message received:', data.message);
  });
});

socket.send() を使ったカスタムプロトコル通信

// server.js
const io = require('socket.io')(3000);
const parser = require('socket.io-parser');

io.on('connection', (socket) => {
  socket.on('data', (raw) => {
    const data = parser.decodePayload(raw);
    console.log('Received data:', data);

    const response = { type: 'response', message: 'Data received' };
    const encodedResponse = parser.encodePayload(response);
    socket.send(encodedResponse);
  });
});

// client.js
const io = require('socket.io')(3000);
const parser = require('socket.io-parser');

io.on('connect', () => {
  console.log('Connected to server');

  const data = { type: 'request', message: 'Hello from client!' };
  const encodedData = parser.encodePayload(data);
  socket.send(encodedData);

  socket.on('data', (raw) => {
    const response = parser.decodePayload(raw);
    console.log('Received response:', response);
  });
});