Nginx代理WebSocket时如何保持长连接不中断？

Question

在使用Nginx代理WebSocket时，如何避免长连接频繁中断？常见的技术问题包括：Nginx默认的超时设置可能导致WebSocket连接被关闭。例如，`proxy_read_timeout`和`proxy_send_timeout`值过低会触发超时。此外，Nginx的`keepalive`配置不当也可能导致连接不稳定。为解决这些问题，需调整相关参数，如将`proxy_read_timeout`设为较高值（如3600秒），并确保`upgrade`和`connection`头信息正确转发。同时，启用心跳机制，通过定期发送ping/pong帧保持连接活跃，从而有效防止因网络空闲导致的连接中断。这种优化可显著提升WebSocket长连接的稳定性。

Answer 1

1. 问题概述

在使用Nginx代理WebSocket时，长连接频繁中断是一个常见的技术问题。这可能由多种因素引起，包括Nginx默认的超时设置、`keepalive`配置不当以及网络空闲导致的连接关闭等。以下将从常见问题出发，逐步深入分析并提供解决方案。

1.1 常见技术问题

• Nginx默认的`proxy_read_timeout`和`proxy_send_timeout`值过低，容易触发超时。
• `keepalive`配置不当可能导致连接不稳定。
• 未正确转发`upgrade`和`connection`头信息，可能导致握手失败。
• 网络空闲时间过长，中间设备（如防火墙）可能主动断开连接。

2. 分析过程

为解决上述问题，我们需要对Nginx的配置进行优化，并结合应用层的心跳机制来提升连接稳定性。

2.1 超时设置分析

Nginx默认的`proxy_read_timeout`和`proxy_send_timeout`值通常为60秒，这对WebSocket这种需要长时间保持连接的应用来说是不够的。需要根据实际需求调整这些参数。

2.2 Keepalive 配置分析

`keepalive`参数控制Nginx与后端服务器之间的复用连接数。如果配置不当，可能导致连接池耗尽或频繁重建连接。

3. 解决方案

以下是具体的优化步骤和配置示例：

3.1 调整Nginx配置

http {
    map $http_upgrade $connection_upgrade {
        default upgrade;
        '' close;
    }

    server {
        listen 80;

        location /ws/ {
            proxy_pass http://backend;
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection $connection_upgrade;

            # 设置超时时间
            proxy_read_timeout 3600s;
            proxy_send_timeout 3600s;

            # 启用keepalive
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header Host $host;
            proxy_buffering off;
        }
    }
}

3.2 启用心跳机制

在应用层实现心跳机制，通过定期发送ping/pong帧保持连接活跃。以下是伪代码示例：

// 客户端代码示例
const ws = new WebSocket('ws://example.com/ws');
ws.onopen = () => {
    setInterval(() => {
        if (ws.readyState === WebSocket.OPEN) {
            ws.send(JSON.stringify({ type: 'ping' }));
        }
    }, 30000); // 每30秒发送一次心跳
};

ws.onmessage = (event) => {
    const data = JSON.parse(event.data);
    if (data.type === 'pong') {
        console.log('Connection is alive');
    }
};

4. 流程图

以下是优化流程的Mermaid格式流程图：

```mermaid
sequenceDiagram
    participant Client
    participant Nginx
    participant Backend

    Client->>Nginx: WebSocket handshake request
    Nginx->>Backend: Forward handshake with headers
    Backend-->>Nginx: Handshake response
    Nginx-->>Client: Handshake success

    loop Data exchange
        Client->>Nginx: Send ping frame
        Nginx->>Backend: Forward ping frame
        Backend-->>Nginx: Send pong frame
        Nginx-->>Client: Receive pong frame
    end
```

4.1 表格总结

以下是关键参数及其作用的表格：

参数名称	作用	推荐值
proxy_read_timeout	设置Nginx等待后端响应的时间	3600s
proxy_send_timeout	设置Nginx发送数据到客户端的超时时间	3600s
proxy_set_header Upgrade	确保WebSocket协议升级头信息正确转发	$http_upgrade
proxy_set_header Connection	确保连接保持活动状态	$connection_upgrade