ws: Node.js WebSocket 库技术文档
2024-12-24 07:14:58作者:宗隆裙
1. 安装指南
安装步骤
要安装 ws
库,请在终端中运行以下命令:
npm install ws
可选性能优化
为了提高性能,你可以选择安装 bufferutil
模块:
npm install --save-optional bufferutil
bufferutil
是一个二进制插件,可以加速 WebSocket 帧数据负载的掩码和解掩码操作。预编译的二进制文件适用于大多数流行的平台,因此你不需要在机器上安装 C++ 编译器。
如果你不想使用 bufferutil
,可以通过设置环境变量 WS_NO_BUFFER_UTIL
来禁用它。
旧版 Node.js 的性能优化
如果你使用的是旧版 Node.js(v18.14.0 之前),还可以安装 utf-8-validate
模块:
npm install --save-optional utf-8-validate
这个模块包含了一个 buffer.isUtf8()
的二进制 polyfill。
同样,你可以通过设置环境变量 WS_NO_UTF_8_VALIDATE
来禁用它。
2. 项目的使用说明
基本使用
ws
是一个简单易用、性能卓越的 WebSocket 客户端和服务器实现。它通过广泛的测试,确保了其稳定性和可靠性。
浏览器支持
需要注意的是,ws
模块不能在浏览器中使用。浏览器客户端必须使用原生的 WebSocket
对象。如果你希望在 Node.js 和浏览器中无缝使用相同的代码,可以使用 isomorphic-ws
等 npm 包。
3. 项目 API 使用文档
WebSocket 类
ws
提供了 WebSocket
类,用于创建 WebSocket 客户端。以下是一些常用的 API:
创建 WebSocket 客户端
import WebSocket from 'ws';
const ws = new WebSocket('ws://www.host.com/path');
ws.on('open', function open() {
ws.send('Hello Server');
});
ws.on('message', function message(data) {
console.log('received: %s', data);
});
发送文本数据
ws.send('Hello Server');
发送二进制数据
const array = new Float32Array(5);
for (let i = 0; i < array.length; ++i) {
array[i] = i / 2;
}
ws.send(array);
WebSocketServer 类
ws
还提供了 WebSocketServer
类,用于创建 WebSocket 服务器。
创建简单的 WebSocket 服务器
import { WebSocketServer } from 'ws';
const wss = new WebSocketServer({ port: 8080 });
wss.on('connection', function connection(ws) {
ws.on('message', function message(data) {
console.log('received: %s', data);
});
ws.send('Hello Client');
});
处理外部 HTTP/S 服务器
import { createServer } from 'https';
import { readFileSync } from 'fs';
import { WebSocketServer } from 'ws';
const server = createServer({
cert: readFileSync('/path/to/cert.pem'),
key: readFileSync('/path/to/key.pem')
});
const wss = new WebSocketServer({ server });
wss.on('connection', function connection(ws) {
ws.on('message', function message(data) {
console.log('received: %s', data);
});
ws.send('Hello Client');
});
server.listen(8080);
4. 项目安装方式
通过 npm 安装
npm install ws
可选性能优化模块
npm install --save-optional bufferutil
npm install --save-optional utf-8-validate
通过以上步骤,你可以轻松安装并使用 ws
库来创建 WebSocket 客户端和服务器。
登录后查看全文
热门项目推荐
- QQwen3-Omni-30B-A3B-InstructQwen3-Omni是多语言全模态模型,原生支持文本、图像、音视频输入,并实时生成语音。00
- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0269get_jobs
💼【AI找工作助手】全平台自动投简历脚本:(boss、前程无忧、猎聘、拉勾、智联招聘)Java00AudioFly
AudioFly是一款基于LDM架构的文本转音频生成模型。它能生成采样率为44.1 kHz的高保真音频,且与文本提示高度一致,适用于音效、音乐及多事件音频合成等任务。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile08
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
148
1.95 K

deepin linux kernel
C
22
6

React Native鸿蒙化仓库
C++
192
274

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0

本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
515