Sanic WebSocket 使用

WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。Sanic 提供了非常简洁的 websockets 抽象，让我们开发基于 WebSocket 的web应用非常容易。

WebSocket 实例

下面是一个简单的建立 WebSocket 的例子：

from sanic import Sanic
from sanic.response import json
from sanic.websocket import WebSocketProtocol

app = Sanic()

@app.websocket('/feed')
async def feed(request, ws):
    while True:
        data = 'hello!'
        print('Sending: ' + data)
        await ws.send(data)
        data = await ws.recv()
        print('Received: ' + data)

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8888, protocol=WebSocketProtocol)

上面这个app建立一个 WebSocket 的服务。也可以用 app.add_websocket_route 方法替换装饰器：

async def feed(request, ws):
    pass

app.add_websocket_route(feed, '/feed')

WebSocket 路由的处理函数需要两个参数，第一个是request对象，第二个是 WebSocket 协议对象，这个协议对象有两个方法send和recv用来发送和接收数据。

WebSocket 的配置

通过app.config来配置 WebSocket，比如：

app.config.WEBSOCKET_MAX_SIZE = 2 ** 20
app.config.WEBSOCKET_MAX_QUEUE = 32
app.config.WEBSOCKET_READ_LIMIT = 2 ** 16
app.config.WEBSOCKET_WRITE_LIMIT = 2 ** 16

阅读Sanic 配置详细了解Sanic的配置细节。

复杂的例子

通常我们的web应用既有普通的get、post，也有websocket，比如下面这个例子：

from sanic import Sanic
from sanic.response import file

app = Sanic(__name__)


@app.route('/')
async def index(request):
    return await file('websocket.html')


@app.websocket('/feed')
async def feed(request, ws):
    while True:
        data = 'hello!'
        print('Sending: ' + data)
        await ws.send(data)
        data = await ws.recv()
        print('Received: ' + data)


if __name__ == '__main__':
    app.run(host="0.0.0.0", port=8888, debug=True)

这样一个app实例同时支持包括WebSocket在内的多种路由。

我的公众号：猿人学 Python 上会分享更多心得体会，敬请关注。

***版权申明:若没有特殊说明，文章皆是猿人学 yuanrenxue.con 原创，没有猿人学授权，请勿以任何形式转载。***