Nginx中配置WebSocket代理的详细步骤

IVDFP • 2025年2月24日 07:37:36 • nginx

1. 安装 Nginx

确保你已经安装了 Nginx。如果没有安装，可以使用以下命令进行安装：

sudo apt-get update
sudo apt-get install nginx

2. 配置 WebSocket 代理

编辑 Nginx 配置文件，通常位于 /etc/nginx/nginx.conf 或 /etc/nginx/sites-available/default。以下是一个示例配置，展示了如何配置 WebSocket 代理。

示例配置：

http {
    # 定义 upstream 块，指定后端 WebSocket 服务器
    upstream websocket_backend {
        server backend1.example.com:8080;
        server backend2.example.com:8080;
    }

    server {
        listen 80;
        server_name example.com;

        # 配置 WebSocket 代理
        location /ws {
            proxy_pass http://websocket_backend;
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;

            # 可选：设置超时时间
            proxy_read_timeout 86400s;
        }

        # 配置静态文件或其他路径
        location / {
            root /var/www/html;
            index index.html index.htm;
        }
    }
}

3. 参数解释

proxy_pass：指定后端 WebSocket 服务器的地址。
proxy_http_version 1.1：设置 HTTP 版本为 1.1，WebSocket 协议需要 HTTP/1.1。
proxy_set_header Upgrade $http_upgrade：传递客户端的 Upgrade 头部。
proxy_set_header Connection "upgrade"：传递客户端的 Connection 头部，指示这是一个 WebSocket 升级请求。
proxy_set_header Host $host：传递客户端的 Host 头部。
proxy_set_header X-Real-IP $remote_addr：传递客户端的真实 IP 地址。
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for：传递客户端的 X-Forwarded-For 头部。
proxy_set_header X-Forwarded-Proto $scheme：传递客户端的协议（HTTP 或 HTTPS）。
proxy_read_timeout 86400s：设置读取超时时间，WebSocket 连接通常是长连接，因此需要设置较长的超时时间。

4. 测试配置

在重新加载 Nginx 之前，先测试配置文件是否有语法错误。

sudo nginx -t

6. 验证配置

确保 WebSocket 连接可以正常建立和通信。可以在前端使用 WebSocket 客户端进行测试。

示例前端代码：

<!DOCTYPE html>
<html>
<head>
    <title>WebSocket Test</title>
</head>
<body>
    <script>
        var socket = new WebSocket('ws://example.com/ws');

        socket.onopen = function() {
            console.log('WebSocket connection opened');
            socket.send('Hello, WebSocket!');
        };

        socket.onmessage = function(event) {
            console.log('Message from server:', event.data);
        };

        socket.onclose = function() {
            console.log('WebSocket connection closed');
        };

        socket.onerror = function(error) {
            console.error('WebSocket error:', error);
        };
    </script>
</body>
</html>