【Node.js24.x】Object::WebSocket()メソッドの使い方
WebSocketメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
WebSocketメソッドは、Objectクラスに属し、Webブラウザとサーバー間でリアルタイムな双方向通信を確立し、データを送受信するためのメソッドです。このメソッドは、WebSocketプロトコルを利用することで、一度接続を確立した後は、クライアントとサーバーがいつでも相互にデータを交換できる持続的な通信路を提供します。従来のHTTP通信のように毎回リクエストを送る必要がなく、サーバーからの能動的なデータ送信(プッシュ通知)や、チャットアプリケーションのような継続的なリアルタイム更新が容易になります。開発者はこのメソッドを通じて、複雑なネットワーク通信の管理を抽象化し、効率的で低遅延なデータ交換機能をアプリケーションに組み込むことができます。例えば、リアルタイムな情報表示が必要なダッシュボード、オンラインゲーム、共同編集ツールなど、即時性が重視される様々なWebアプリケーションの構築において、中心的な役割を果たします。
構文(syntax)
1const WebSocket = require('ws'); 2 3const ws = new WebSocket('ws://localhost:8080'); 4 5ws.onopen = () => { 6 ws.send('Hello Server!'); 7}; 8 9ws.onmessage = (event) => { 10 console.log(`Received from server: ${event.data}`); 11}; 12 13ws.onerror = (error) => { 14 console.error('WebSocket error:', error); 15}; 16 17ws.onclose = () => { 18 console.log('WebSocket connection closed.'); 19};
引数(parameters)
url, protocols = []
- url: string: 接続先のWebSocketサーバーのURL
- protocols: string[] = []: クライアントがサポートするサブプロトコルを文字列の配列で指定します。省略された場合は、サーバーがサポートするサブプロトコルは使用されません。
戻り値(return)
WebSocket
WebSocket オブジェクトそのものを返します。このオブジェクトは、クライアントとサーバー間の双方向通信チャネルを表します。