tuxi/websocket_server

websocket server

基于django-private-chat 和 djangorestframework 的websockt 服务端示例

前端示例

测试用户

username	password
user1	password123
user2	password123

WebSocket 的验证方式

支持jwt 和 session 两种方式对websocket进行鉴权

ws_auth_type_jwt_token = "token"
ws_auth_type_session_key = "session_key"

连接的示例url path

ws://127.0.0.1:5002/?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyLCJ1c2VybmFtZSI6IjE4OTAxMTA4NzE5IiwiZXhwIjoxNTY2Mjc2OTc2LCJlbWFpbCI6IiIsIm1vYmlsZSI6IjE4OTAxMTA4NzE5In0.IzgSstfFrDB2ehf778HHx-2Hrw6YDE54_sexFAhC9Z0&opponent=xiaoyuan

建立连接

let base_ws_server_path = 'wss://chat.enba.com'
let opponent_username = 'xiaoyuan'
websocket = new WebSocket(base_ws_server_path + '?session_key={{ request.session.session_key }}' + '&opponent={{ opponent_username }}');

初始化项目

python3.6
创建python虚拟环境

mkvirtualenv -p /usr/bin/python3 websocketserver

source ~/.virtualenvs/websocketserver/bin/activate

安装依赖

pip install -r requirements.txt

在WebSocketServer目录下创建private_config.py ，此文件用于存储云片apikey, 添加YUNPIAN_APIKEY = ''

cd websocket_server
vim WebSocketServer/private_config.py

生成数据库

# 1. 创建更改的文件
python manage.py makemigrations
# 2. 将生成的py文件应用到数据库
python manage.py migrate

创建管理员

python manage.py createsuperuser

运行前端示例

请先配置客户端请求的host和port

CHAT_WS_CLIENT_HOST = '127.0.0.1'
CHAT_WS_CLIENT_PORT = 80
CHAT_WS_CLIENT_ROUTE = 'ws/'

运行

python manage.py runserver 8000

非DEBUG时，需要收集静态文件

python manage.py collectstatic --noinput

运行websocket服务端

请先配置websocket监听的host和port

CHAT_WS_SERVER_PROTOCOL = 'ws'
CHAT_WS_SERVER_HOST = '127.0.0.1'
CHAT_WS_SERVER_PORT = 5002

运行run_chat_server启动websocket 服务

python manage.py run_chat_server

或者

通过systemd服务的配置run_chat_server 将项目中bin/chatserver.service拷贝到/lib/systemd/system目录下（注意：修改.service中的项目路径）。

cp bin/chatserver.service /lib/systemd/system

启动websocket 服务

sudo systemctl start chatserver.service

如果时修改或新建的服务文件需要先执行systemctl daemon-reload ，告诉systemd系统，然后再启动chatserver.service，不然无法正常启动。

问题

问题1: 本地测试环境下websocket正常工作，但是本地服务器使用nginx反向代理未正常在线，显示WebSocket is already in CLOSING or CLOSED state.。

解决：此问题是由webSocket在nginx的proxy_pass配置错误导致的，proxy_pass http://websocket_server;修改为proxy_pass http://websocket_server/;问题解决。

问题2: 生产环境部署到阿里云ECS时，使用nginx做websocket的反向代理后，客户端请求总是502。同样的配置，在本地服务器通过nginx没有，但是阿里云ECS部署就会导致502错误。 Error：enba:186 WebSocket connection to 'ws://chat.enba.com/ws/9ygfrczj6le3buh28b393cv20w5hzj4l/enba' failed: Error during WebSocket handshake: Unexpected response code: 502

解决：由于websocket服务使用python manage.py run_chat_server命令开启的，并且绑定的host为localhost、port为5002，通过netstat -atnp命令在本地服务器查询到5002网络端口已开启，而在阿里云ECS服务端未查询到此网络端口，期间很是郁闷，不过此时我已经找到了问题所在。此问题是由于nginx配置错误导致，在nginx的proxy_pass为127.0.0.1:5002，而websockets监听的为localhost：5002，导致反向代理失败。通过修改初始化websockets.serve()方法的host参数将localhost修改为127.0.0.1问题解决，重启chatserver.service问题解决。

问题3: ws协议跨域问题由于HTTPS是基于SSL依靠证书来验证服务器的身份，并为浏览器和服务器之间的通信加密，所以在HTTPS站点调用某些非SSL验证的资源时浏览器可能会阻止。比如原本https的前端项目中使用了类似ws://chat.enba.com/ws/9ygfrczj6le3buh28b393cv20w5hzj4l/enba的websockt协议，会出现类似如下错误：

Mixed Content: The page at 'https://chat.enba.com/dialogs/enba' was loaded over HTTPS, but attempted to connect to the insecure WebSocket endpoint 'ws://chat.enba.com/ws/9ygfrczj6le3buh28b393cv20w5hzj4l/enba'. This request has been blocked; this endpoint must be available over WSS.

解决方法：

通过wss协议实际是websocket+SSL，就是在websocket协议上加入SSL层，类似https(http+SSL)。
利用nginx代理wss
- 客户端发起wss连接连到nginx
- nginx将wss协议的数据转换成ws协议数据并转发到websocket协议端口
- websocket收到数据后做业务逻辑处理
- websocket给客户端发送消息时，则是相反的过程，数据经过nginx/转换成wss协议然后发给客户端
nginx配置ssl和wss 由于我在nginx配置中已配置ssl证书，所以只需要在server 443端口处，添加以下：

   # 此路由为websocket服务
   location /ws/ { # CHAT_WS_CLIENT_ROUTE
       # 后面必须要带`/`
       proxy_pass http://websocket_server/;
       proxy_http_version 1.1;
       proxy_connect_timeout 10s;                #配置点1
       proxy_read_timeout 60s;                  #配置点2，如果没效，可以考虑这>个时间配置长一点
       proxy_send_timeout 12s;                  #配置点3
       proxy_set_header Upgrade $http_upgrade;
       proxy_set_header Connection "Upgrade";
   }

websocket服务端和前端进行websocket通讯时使用wss协议头即可。

tuxi / websocket_server