node的ws的api详细讲解

时间:2025-02-23 14:34:19

WebSocket是一种在单个TCP连接上进行全双工通信的协议。中的ws模块提供了WebSocket的实现,使得可以轻松地创建WebSocket服务器和客户端。

在ws模块中,WebSocket客户端由WebSocket类实现。WebSocket提供了一系列的API,用于管理WebSocket连接、发送消息等操作。本文将详细讲解WebSocket客户端和服务端的API。

一、WebSocket客户端API

1. WebSocket的创建

在使用WebSocket之前,需要先创建一个WebSocket连接。创建WebSocket的方式如下:

const WebSocket = require('ws');
const ws = new WebSocket('ws://localhost:8080');

上述代码中,首先引入了ws模块,然后通过new关键字创建了一个WebSocket实例。在创建WebSocket时,需要传递一个URL,指定WebSocket服务器的地址和端口号。

2. WebSocket的事件

WebSocket提供了一系列的事件,用于监听WebSocket连接的建立、关闭等事件。以下是WebSocket的常用事件:

  • open:当WebSocket连接建立成功时触发该事件。
  • message:当WebSocket连接收到消息时触发该事件。
  • error:当WebSocket连接发生错误时触发该事件。
  • close:当WebSocket连接关闭时触发该事件。

示例代码如下:

ws.on('open', function open() {
   
  console.log('connected');
  ws.send('hello');
});

ws.on('message', function incoming(data<