📜  ws (1)

📅  最后修改于: 2023-12-03 15:06:02.683000             🧑  作者: Mango

简介

WS 是一种基于 TCP 协议实现的简单 WebSocket 实现,它可以在 Node.js 应用程序中被用来实现 WebSocket 服务器功能。

该模块提供了一个 WebSocket 服务器和客户端。这种模块通过节点的事件循环来驱动它。

用法

服务器

下面是一个简单的示例 WebSocket 服务器的示例:

const WebSocket = require('ws');

const wss = new WebSocket.Server({ port: 8080 });

wss.on('connection', function connection(ws) {
  ws.on('message', function incoming(message) {
    console.log('received: %s', message);
  });

  ws.send('something');
});

这个示例在端口 8080 上创建了一个 WebSocket 服务器,这个服务器可以接收来自 WebSocket 客户端的连接请求。当某个 WebSocket 客户端连接成功的时候,服务器就会在控制台输出日志信息。服务器还会在接收到客户端发送的消息时,将其在控制台上输出。

客户端

下面是一个简单的示例 WebSocket 客户端的示例:

const WebSocket = require('ws');

const ws = new WebSocket('ws://www.host.com/path');

ws.on('open', function open() {
  ws.send('something');
});

ws.on('message', function incoming(data) {
  console.log(data);
});

这个示例通过创建一个 WebSocket 实例来连接到一个 WebSocket 服务器。当客户端与服务器连接成功的时候,客户端会向服务器发送一条消息。而当服务器向客户端发送一条消息的时候,客户端会在控制台上输出这条消息。

总结

通过使用 ws 模块,可以很方便地在 Node.js 应用程序中实现 WebSocket 服务器与客户端的功能。这个模块非常简单易用,且具有良好的兼容性。