Nginx配置WebSocket

若鱼1919

已于 2024-10-24 13:05:11 修改

阅读量1.1k

点赞数 7

CC 4.0 BY-SA版权

文章标签： spring boot

于 2024-03-07 10:33:30 首次发布

本文链接：https://blog.csdn.net/goldenfish1919/article/details/136526457

本文详细解释了如何在Nginx配置中设置WebSocket支持，包括使用`http_upgrade`和`connection_upgrade`映射，以及将WebSocket请求代理到upstream服务器的示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1）原理

客户端：申请协议升级

首先，客户端发起协议升级请求。可以看到，采用的是标准的HTTP报文格式，且只支持GET方法。

GET / HTTP/1.1
Host: localhost:8080
Origin: http://127.0.0.1:3000
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Version: 13
Sec-WebSocket-Key: w4v7O6xFTi36lq3RNcgctw==

重点请求首部意义如下：

Connection: Upgrade：表示要升级协议
Upgrade: websocket：表示要升级到websocket协议。
Sec-WebSocket-Version: 13：表示websocket的版本。如果服务端不支持该版本，需要返回一个- Sec-WebSocket-Version header，里面包含服务端支持的版本号。
Sec-WebSocket-Key：与后面服务端响应首部的Sec-WebSocket-Accept是配套的，提供基本的防护，比如恶意的连接，或者无意的连接。

服务端：响应协议升级

服务端返回内容如下，状态代码101表示协议切换。到此完成协议升级，后续的数据交互都按照新的协议来。

HTTP/1.1 101 Switching Protocols
Connection:Upgrade
Upgrade: websocket
Sec-WebSocket-Accept: Oy4NRAQ13jhfONC7bP8dTKb4PTU=

Sec-WebSocket-Accept的计算

Sec-WebSocket-Accept根据客户端请求首部的Sec-WebSocket-Key计算出来。

计算公式为：

将Sec-WebSocket-Key跟258EAFA5-E914-47DA-95CA-C5AB0DC85B11拼接。
通过SHA1计算出摘要，并转成base64字符串。

toBase64( sha1( Sec-WebSocket-Key + 258EAFA5-E914-47DA-95CA-C5AB0DC85B11 )  )

在这里插入图片描述

2）nginx配置

反向代理的时候添加协议升级的请求头：

http {
    include       mime.types;
    default_type  application/octet-stream;
	
	# 如果 $http_upgrade 不为 '' (空)，则 $connection_upgrade 为 upgrade 。
    # 如果 $http_upgrade 为 '' (空)，则 $connection_upgrade 为 close。
	map $http_upgrade $connection_upgrade{
		default upgrade;
		'' close;
	}

	upstream webservers{
	  server 127.0.0.1:8080 weight=90 ;
	}

    server {
        listen       80;
        server_name  localhost;
        
		# WebSocket
		location /ws/ {
            proxy_pass   http://webservers/ws/;
			proxy_http_version 1.1;
			# 添加这2个请求头
			proxy_set_header Upgrade $http_upgrade;
			proxy_set_header Connection "$connection_upgrade";
        }
    }
}