WebSocket是一种用于实时通信的协议，它在现代Web应用程序中变得越来越重要。Nginx作为一种高性能的反向代理服务器，可以用于配置WebSocket的转发功能，以实现WebSocket连接的负载均衡和安全性。在本文中，我们将介绍如何在Nginx中配置WebSocket功能，以便您可以更好地支持WebSocket连接。

一、什么是WebSocket？

WebSocket是一种双向通信协议，它允许服务器和客户端之间进行实时的数据交换。相比传统的HTTP请求，WebSocket的优势在于它能够建立持久性连接，避免了频繁的握手和连接建立过程。这使得WebSocket非常适合实时聊天应用、在线游戏、实时地图以及其他需要实时通信的应用程序。

二、配置Nginx支持WebSocket

要在Nginx中配置WebSocket支持，您需要进行以下步骤：

  1. 安装Nginx： 如果您还没有安装Nginx，首先需要安装Nginx。您可以使用适合您操作系统的包管理器来安装Nginx。

  2. 编辑Nginx配置文件： 打开Nginx的配置文件，通常位于/etc/nginx/nginx.conf或/etc/nginx/sites-available/目录中。您可以使用文本编辑器进行编辑。

  3. 添加WebSocket支持： 在Nginx配置文件中，找到您希望添加WebSocket支持的位置，通常是一个server块。然后添加以下配置：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    location /websocket/ {
         proxy_pass http://backend_server;
         proxy_http_version 1.1;
         proxy_read_timeout 360s;   
         proxy_redirect off;   
         proxy_set_header Upgrade $http_upgrade; 
         proxy_set_header Connection "upgrade";    #配置连接为升级连接
         proxy_set_header Host $host:$server_port;
         proxy_set_header X-Real-IP $remote_addr;
         proxy_set_header REMOTE-HOST $remote_addr;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     }

    这里，/websocket是WebSocket的端点路径，backend_server是后端WebSocket服务器的地址。

  4. 重新加载Nginx： 保存配置文件后，使用以下命令重新加载Nginx以使配置生效：

    1
    sudo service nginx reload

    或者

    1
    sudo systemctl reload nginx

现在，您的Nginx服务器将能够代理WebSocket请求。

三、验证WebSocket连接

为了验证WebSocket连接是否已经成功配置，您可以使用WebSocket客户端工具或JavaScript来创建一个WebSocket连接并测试它。以下是一个使用JavaScript的示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
var socket = new WebSocket("ws://your-nginx-server/websocket");

socket.onopen = function(event) {
    console.log("WebSocket连接已建立");
};

socket.onmessage = function(event) {
    console.log("接收到消息: " + event.data);
};

socket.onclose = function(event) {
    if (event.wasClean) {
        console.log("连接已关闭，状态代码: " + event.code + "，原因: " + event.reason);
    } else {
        console.error("连接异常关闭");
    }
};

socket.onerror = function(error) {
    console.error("WebSocket错误: " + error.message);
};

将your-nginx-server替换为您的Nginx服务器的地址。如果一切配置正确，您应该能够建立WebSocket连接并接收消息。

使用如上连接，如果所有的连接仅仅为 “ws” 协议的请求是没有问题的，但是如果要及支持 http 请求又支持 ws 请求上述配置就不起作用了。

四、既支持http又支持ws的配置

通过nginx官方关于WebSocket的配置得知，可以自定义变量。故配置如下，就可以做到既支持 ws 请求，又支持 http请求。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
http {
  #自定义变量 $connection_upgrade
  map $http_upgrade $connection_upgrade { 
      default          keep-alive;  #默认为keep-alive 可以支持 一般http请求
      'websocket'      upgrade;     #如果为websocket 则为 upgrade 可升级的。
  }

  server {
      ...
      location /chat/ {
          proxy_pass http://backend_server;
          proxy_http_version 1.1;
          proxy_set_header Upgrade $http_upgrade; #此处配置 上面定义的变量
          proxy_set_header Connection $connection_upgrade;
      }
  }
}

五、安全性考虑

当配置Nginx支持WebSocket时，务必注意安全性。确保您的WebSocket服务器受到适当的安全保护，并使用HTTPS来加密WebSocket连接以保护数据的传输。同时，限制对WebSocket端点的访问，以防止滥用。

总之，通过配置Nginx支持WebSocket，您可以更好地支持实时通信需求，并为您的应用程序提供更好的性能和可扩展性。遵循上述步骤，确保WebSocket连接的负载均衡和安全性，将有助于您构建出色的实时Web应用程序。