WebSocket 配置与Nginx 的完美结合(过程详解)_websocket

序言

在现代 web 应用中，websocket 作为一种全双工通信协议，为实时数据传输提供了强大的支持。若要确保 websocket 在生产环境中的稳定性和性能，使用 nginx 作为反向代理服务器是一个明智的选择。本篇文章将带你了解如何在 nginx 中配置 websocket，并验证其是否正常工作。

1. nginx 中的 websocket 配置

1.1 安装 nginx

在进行配置之前，确保你的系统上已安装 nginx。你可以使用以下命令来安装：

ubuntu/debian:

sudo apt update
sudo apt install nginx

centos/rhel:

sudo yum install nginx

1.2 基本 nginx 配置

打开 nginx 配置文件（通常位于 /etc/nginx/nginx.conf 或 /etc/nginx/sites-available/default）并添加以下内容，以支持 websocket 连接。

server {
    listen 80;
    server_name yourdomain.com;  # 替换为你的域名
    location /ws {  # websocket 路径
        proxy_pass http://localhost:8080;  # 你的 websocket 服务器地址
        proxy_http_version 1.1;  # 确保使用 http/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;  # 客户端真实 ip
        proxy_set_header x-forwarded-for $proxy_add_x_forwarded_for;  # 转发 ip
        proxy_set_header x-forwarded-proto $scheme;  # 转发协议
    }
    location / {  # 其他请求
        proxy_pass http://localhost:8080;  # 可以根据实际情况修改
    }
}

1.3 重启 nginx

配置完成后，需要重启 nginx 以应用更改：

sudo systemctl restart nginx
或者
nginx - s reload

2. 验证 websocket 配置的正确性

确保 websocket 正常工作的方式有很多，以下是几种简单有效的方法：

2.1 使用浏览器的开发者工具

打开你的网页应用并使用浏览器的开发者工具（通常按 f12）。
切换到 network 标签。
刷新页面，并查看 websocket 连接。
查找以 ws:// 或 wss:// 开头的请求，确认其状态为 101 switching protocols。这表示 websocket 连接已成功建立。

2.2 使用 wscat 测试工具

wscat 是一个非常实用的命令行工具，可以帮助你测试 websocket 连接。你可以通过 npm 安装：

npm install -g wscat

然后使用以下命令连接到 websocket 服务器：

wscat -c ws://yourdomain.com/ws

输入一些消息并确认能正常发送和接收。如果一切正常，说明 websocket 配置成功。

2.3 编写简单的客户端代码

你可以使用以下 javascript 代码在客户端验证 websocket 是否正常工作：

const ws = new websocket('ws://yourdomain.com/ws');
ws.onopen = () => {
    console.log('connected to the websocket server!');
    ws.send('hello, server!');  // 发送测试消息
};
ws.onmessage = (event) => {
    console.log('received message from server:', event.data);
};
ws.onclose = () => {
    console.log('disconnected from websocket server.');
};
ws.onerror = (error) => {
    console.error('websocket error:', error);
};

3. 常见问题及解决方法

3.1 websocket 连接状态为 404 或 403

原因：此错误通常表明 websocket 请求的路径不正确，或者 nginx 配置中的 location 块未能正确匹配 websocket 请求。
解决方法：
- 确保 websocket 的 url 与 nginx 配置中的路径一致。例如，如果在 nginx 中配置的是 /ws，确保你的 websocket 客户端也使用 ws://yourdomain.com/ws。
- 示例：如果客户端使用 ws://yourdomain.com/socket 而服务器在 /ws 下监听，会导致 404 错误。

3.2 浏览器控制台显示“connection refused”

原因：这种情况通常表明 websocket 服务器未在指定的地址和端口上运行，或者 nginx 没有正确地将请求转发到 websocket 服务器。
解决方法：

确认 websocket 服务器是否正在运行，使用如下命令检查端口：

netstat -tuln | grep 8080

确保 nginx 配置中的 proxy_pass 地址与 websocket 服务器的地址匹配。

3.3 收到的消息为空或格式不正确

原因：这可能是由于服务器未能正确解析发送的消息，或未能以预期格式发送消息。
解决方法：

检查服务器代码以确保正确接收和处理消息。例如，在 node.js 的 websocket 服务器中，可以使用以下代码确保将消息以字符串格式发送：

ws.on('message', (message) => {
    const response = json.stringify({ message: message });
    clients.foreach(client => client.send(response));
});

在客户端确认处理消息的代码逻辑是否正确，例如：

ws.onmessage = (event) => {
    const data = json.parse(event.data);
    console.log('received message:', data.message);
};

3.4 连接经常断开

原因**：可能是由于服务器的资源（如 cpu、内存）不足，或者 nginx 的超时设置过低。
解决方法：

检查服务器的资源使用情况，确保能处理所有 websocket 连接。

在 nginx 配置中增加 proxy_read_timeout 和 proxy_send_timeout 的值，例如：

location /ws {
    proxy_read_timeout 86400;  # 24 小时
    proxy_send_timeout 86400;
    ...
}

监控 websocket 连接的状态，以发现是否有客户端异常断开。

3.5 使用 ssl（wss://）时出现证书错误

原因：ssl 证书未正确配置，或者证书与请求的域名不匹配。
解决方法：

确保在 nginx 配置中正确加载了 ssl 证书和私钥：

server {
    listen 443 ssl;
    server_name yourdomain.com;
    ssl_certificate /path/to/fullchain.pem;
    ssl_certificate_key /path/to/privkey.pem;
    ...
}

使用 let’s encrypt 获取有效的 ssl 证书并确保证书与访问的域名一致。可以使用 certbot 工具自动化这一过程。

3.6 在负载均衡环境中，websocket 连接断开

原因：如果 nginx 配置了负载均衡而没有保持会话（sticky sessions），可能导致 websocket 连接在请求转发时断开。
解决方法：

在 nginx 配置中使用 ip_hash 来确保同一客户端总是连接到同一后端服务器：

upstream websocket {
    ip_hash;
    server backend1:8080;
    server backend2:8080;
}
server {
    location /ws {
        proxy_pass http://websocket;
        ...
    }
}

到此这篇关于websocket 配置与nginx 的完美结合(过程详解)的文章就介绍到这了,更多相关websocket 配置与nginx内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！