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

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>