在使用 WebSocket 协议实现实时通信的时候，很多情况下我们都需要一个 Websocket 代理服务器来处理来自不同客户端的数据，这时候 wsgateway 可以派上用场。wsgateway 是一种以 WebSocket 作为数据通信协议的网关。它能够通过 WebSocket 协议实时将来自用户客户端的请求转发到一个真正的 WebSocket 服务器，从而实现客户端和 WebSocket 服务器之间的数据传输。本文将介绍如何使用 npm 包 wsgateway 来完成 WebSocket 代理服务器的搭建。
一、wsgateway 的安装
npm install wsgateway
二、wsgateway 的基本使用方法
wsgateway 的使用方法非常简单，下面我们通过一个例子来说明。
我们假定将 wsgateway 部署在域名为 example.com 的服务器上，WebSocket 服务器地址为 ws://ws.example.com，监听端口为 8888。现在我们要让 wsgateway 转发来自客户端的数据到该 WebSocket 服务器。我们来看实现方法：
-- -------------------- ---- -------
----- --------- - ---------------------
----- ------ - --- ------------------
----- ------------
------- --------------------------
---
------------------- -----
---------------------- -- --------- -- ---- -------
---在这个例子中我们通过 new 操作符创建了一个 wsgateway.Server 的实例，传入了一个配置参数。其中最重要的一个参数是 target，它指定了接收来自客户端数据的 WebSocket 服务器地址。还需要注意的是，我们需要通过 listen 方法启动该服务器，指定监听的端口。
现在我们的 wsgateway 服务器已经可以将来自客户端的数据转发到 WebSocket 服务器了。
三、wsgateway 的高级用法
在实际使用过程中，我们可能需要对 wsgateway 进行更丰富的配置，这个时候可能就需要使用 wsgateway 的高级用法。
监听多个端口
有时我们会需要同一个 wsgateway 服务器监听多个端口，这时候我们可以传递一个数组给 listen 方法，指定多个监听端口。例如：
server.listen([8000, 9000], ()=>{
console.log(`wsgateway is listening on port 8000 and 9000`);
});添加自定义 HTTP 头信息
在一些特殊的场景下，我们可能需要向客户端添加一些自定义的 HTTP 头信息。这时候我们可以使用 headers 参数。例如：
const server = new wsgateway.Server({
path: '/wsserver',
target: 'ws://ws.example.com:8888',
headers: {
'Authorization': 'Bearer ' + token
}
});进一步控制服务端是否代理请求
在某些情况下，我们可能需要细粒度的控制服务端是否代理请求。wsgateway 默认转发全部请求。如果我们需要仅仅传递某些请求，我们可以使用 filter 参数。例如：
-- -------------------- ---- -------
----- ------ - --- ------------------
----- ------------
------- ---------------------------
------- --------
-- -------- --- -------- -
------ -----
-
------ ------
-
---在这个例子中，我们只允许模式是 /chat 的请求被代理转发。
自定义转发逻辑
有时候我们需要自定义 wsgateway 的转发逻辑，这时候我们可以使用 proxy 参数。例如：
-- -------------------- ---- -------
----- ------ - --- ------------------
----- ------------
------- ---------------------------
------ ----- ----- ------- --------
------------------- ---------
-- -------------
-- -------- --------- -------------
--- ------- - --- --------------------------------
-------------- - -----
----------------------
-
------ --------
-
---在这个例子中，我们自定义了 proxy 方法，它接收三个参数：客户端请求的 req 对象、客户端与 wsgateway 的 WebSocket 连接 socket，以及客户端请求的额外信息 head。在这里我们定义了自己的转发逻辑，最终通过返回一个 WebSocket 对象来完成转发。
四、总结
本文介绍了 npm 包 wsgateway 的基本使用方法以及更丰富的高级用法。了解了这些，我们可以基于 wsgateway 建立自己的 WebSocket 代理服务器，实现服务器和客户端的实时通信。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671178dd3466f61ffe6c2