介绍
kevoree-ws-server 是一个基于 Node.js 平台开发的 WebSocket 服务器，用于实现基于浏览器的实时通信功能。它基于 Node.js 提供的 ws 模块实现，可以方便地跨平台使用。使用 kevoree-ws-server，开发者可以快速构建出一个高性能、可靠的 WebSocket 服务器。该 npm 包被广泛应用于前端开发的各个领域。
安装
使用 npm 安装 kevoree-ws-server 很简单，只需要在终端执行以下命令即可：
npm install kevoree-ws-server --save
在安装完成后，你将能够通过以下方式来使用 kevoree-ws-server：
const WebSocketServer = require('kevoree-ws-server');功能
kevoree-ws-server 主要功能如下：
- 支持 WebSocket 协议（RFC6455 规范）
- 支持 SSL/TLS 安全协议
- 支持自定义HTTP头部
- 支持设置最大连接数、最大消息长度、最大带宽等参数
- 支持 EventEmmitter 事件接口
使用
在使用 kevoree-ws-server 之前，你需要先创建一个 WebSocket 服务器。以下是一个简单的使用示例：
-- -------------------- ---- -------
----- --------------- - -----------------------------
----- ------ - --- -----------------
----- --
---
----------------------- ------------ -
---------------- ----------------- -
---------------------- ---- ---------
-------------- - - ---------
---
---------------------
---在代码中，我们实例化了一个 WebSocket 服务器并配置了端口号为 80。当有客户端连接到该服务器时，服务器会触发 connection 事件。在 connection 事件的回调函数中，我们会建立一个 message 事件的监听器，当客户端发送消息时，服务器会接收到该消息并将其输出到控制台，然后将 echo: + message 发送回客户端。
当你运行该应用程序并在浏览器中打开以下URL时，接收到something并回传 echo: Hello World!。
ws = new WebSocket('ws://localhost/');
ws.onopen = function() {
ws.send('Hello World!');
};
ws.onmessage = function(event) {
console.log('received: ' + event.data);
};API
以下是 kevoree-ws-server 的主要 API。
WebSocketServer(options)
创建一个 WebSocket 服务器实例，可以使用以下选项：
- host: 服务器主机名，默认为
localhost - port: 服务器监听端口，默认为
8080 - server: HTTP/S 服务器对象，用于在同一端口上同时提供 HTTP/S 服务
- backlog: 允许排队的最大连接数，默认为 511
- maxPayload: 每个消息的最大长度，默认为 0 （无限制）
- perMessageDeflate: 指示是否启用 PERMESSAGE_DEFLATE 消息压缩，默认为 true
- verifyClient: 指定 WebSocket 连接的验证函数
WebSocketServer.on(event, listener)
添加一个事件监听器，可以监听以下事件：
- listening: 服务器开始监听时触发
- connection: 客户端连接到服务器时触发
- error: 服务器发生错误时触发
- close: 服务器关闭时触发
WebSocketServer.send(data, [options], [callback])
向所有连接的客户端广播消息，可以使用以下选项：
- binary: 是否将消息转换为二进制格式
- mask: 是否对消息进行掩码处理
WebSocketServer.close([callback])
关闭 WebSocket 服务器。
WebSocket
代表一个 WebSocket 连接，可以使用以下方法：
- send(data, [options], [callback]): 向客户端发送消息
- ping([data], [mask], [callback]): 向客户端发送 ping 消息
- close([code], [reason]): 关闭 WebSocket 连接
注意事项
WebSocket 协议是一种双向通信协议，客户端和服务器都可以推送消息到对方。使用 WebSocket 应该注意以下几点：
- WebSocket 是一种长连接，客户端需要及时释放资源。当客户端不再需要连接时，应主动关闭连接。
- WebSocket 连接可以跨域访问，但需要在服务器端添加跨域配置。
- WebSocket 使用 WS(S) 协议作为底层协议，因此必须使用正确的协议版本（RFC6455）。
结语
本文介绍了 kevoree-ws-server 的使用方法和注意事项，希望对读者有所帮助。在实际应用中，我们还需要根据自己的需求进行定制化开发，以实现更复杂的业务逻辑。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066eff4c49986ca68d8bb4