「应用中间件」使用NGINX作为WebSocket代理

首席架构师智库

发布于 2019-09-25 10:10:57

1.5K0

发布于 2019-09-25 10:10:57

WebSocket协议提供了一种创建支持客户端和服务器之间实时双向通信的web应用程序的方法。作为HTML5的一部分，WebSocket使开发这些类型的应用程序比以前可用的方法容易得多。大多数现代浏览器都支持WebSocket，包括Chrome、Firefox、Internet Explorer、Opera和Safari，现在越来越多的服务器应用程序框架也支持WebSocket。

对于需要多个WebSocket服务器来实现性能和高可用性的企业生产使用，需要一个理解WebSocket协议的负载均衡层，NGINX从1.3版开始就支持WebSocket，可以作为反向代理，对WebSocket应用程序进行负载均衡。(NGINX Plus的所有版本都支持WebSocket。)

查看最近关于NGINX的可伸缩性的性能测试，以平衡WebSocket连接的负载。

WebSocket协议与HTTP协议不同，但是WebSocket握手与HTTP兼容，使用HTTP升级工具将连接从HTTP升级到WebSocket。这使得WebSocket应用程序更容易地适应现有的基础设施。例如，WebSocket应用程序可以使用标准的HTTP端口80和443，从而允许使用现有的防火墙规则。

WebSocket应用程序在客户机和服务器之间保持长时间运行的连接，从而促进实时应用程序的开发。用于将连接从HTTP升级到WebSocket的HTTP升级机制使用升级和连接头。反向代理服务器在支持WebSocket方面面临一些挑战。一个是WebSocket是一个逐跳协议，因此当代理服务器拦截来自客户机的升级请求时，它需要将自己的升级请求发送到后端服务器，包括适当的头文件。此外，由于WebSocket连接是长寿命的，与HTTP使用的典型短寿命连接相反，反向代理需要允许这些连接保持打开状态，而不是因为它们看起来是空闲的而关闭它们。

NGINX支持WebSocket，允许在客户机和后端服务器之间建立隧道。NGINX要将升级请求从客户端发送到后端服务器，必须显式设置升级和连接头，如下例所示:

location /wsapp/ {
 proxy_pass http://wsbackend;
 proxy_http_version 1.1;
 proxy_set_header Upgrade $http_upgrade;
 proxy_set_header Connection "Upgrade";
}

完成此操作后，NGINX将其作为WebSocket连接处理。

NGINX Websocket例子

下面是一个活生生的例子，展示NGINX作为WebSocket代理的工作方式。本例使用ws，这是一个基于Node.js的WebSocket实现。NGINX使用ws和Node.js作为一个简单WebSocket应用程序的反向代理。这些说明已经在Ubuntu 13.10和CentOS 6.5中测试过，但可能需要针对其他操作系统和版本进行调整。在本例中，WebSocket服务器的IP地址是192.168.100.10,NGINX服务器的IP地址是192.168.100.20。

如果尚未安装Node.js和npm，请运行以下命令:

Debian和Ubuntu:

$ sudo apt-get install nodejs npm

对于RHEL和CentOS:

$ sudo yum install nodejs npm

Node.js在Ubuntu上安装为nodejs，在CentOS上安装为node。这个例子使用了node，所以在Ubuntu上我们需要创建一个从nodejs到node的符号链接:

$ ln -s /usr/bin/nodejs /usr/local/bin/node

要安装ws，请运行以下命令:

$ sudo npm install ws

注意:如果您得到错误消息:“error: failed to fetch from registry: ws”，运行以下命令来修复问题:

sudo npm config set registry http://registry.npmjs.org/

然后再次运行sudo npm install ws命令。

ws附带了将用于客户机的程序/root/node_modules/ws/bin/wscat，但是我们需要创建一个程序来充当服务器。创建一个名为server.js的文件，包含以下内容:

console.log("Server started"); var Msg = ''; var WebSocketServer = require('ws').Server , wss = new WebSocketServer({port: 8010}); wss.on('connection', function(ws) { ws.on('message', function(message) { console.log('Received from client: %s', message); ws.send('Server received from client: ' + message); }); });

要执行服务器程序，请运行以下命令:

$ node server.js

服务器打印一个初始的“server started”消息，然后监听端口8010，等待客户机连接到它。当它接收到客户端请求时，它会对其进行回显，并向客户端发送包含它接收到的消息的消息。要有NGINX代理这些请求，我们创建以下配置:

http {
 map $http_upgrade $connection_upgrade {
 default upgrade;
 '' close;
 }
 
 upstream websocket {
 server 192.168.100.10:8010;
 }
 
 server {
 listen 8020;
 location / {
 proxy_pass http://websocket;
 proxy_http_version 1.1;
 proxy_set_header Upgrade $http_upgrade;
 proxy_set_header Connection $connection_upgrade;
 }
 }
}

NGINX监听端口8020并将请求代理到后端WebSocket服务器。proxy_set_header指令使NGINX能够正确处理WebSocket协议。

为了测试服务器，我们运行wscat作为我们的客户端: