开发说明（5）：WebSocket 接口

于 2024-08-16 10:19:49 发布
阅读量312 收藏 6
点赞数 3
分类专栏： 编程语言 - python 文章标签： websocket 网络协议 网络 python fastapi
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u011521019/article/details/141252245
版权

1. 写在前面

下面是如何使用 Redis 和 FastAPI 实现双向 WebSocket 通信，代码的核心是利用 Redis 的 Pub/Sub 机制在多个客户端之间进行消息广播和接收。

示例地址：https://github.com/jianpengzhang/fastapi-common-tmpl

2. 创建 WebSocket 工具类

在项目 app/core/ 目录下，增加 websockets.py 工具库。

import asyncio
import json
from typing import Dict, List, Any, Type

import redis.asyncio as aioredis
from fastapi import WebSocket, WebSocketDisconnect

from app.core.redis import get_redis_client
from app.core.utils import SingletonMeta

class RedisPubSubManager:
    """
    管理 Redis 连接和 Pub/Sub 订阅的类;
    """

    def __init__(self, *args, **kwargs):
        self.pubsub = None

    @staticmethod
    async def _publish(channel: str, message: Any) -> None:
        """
        消息发布到指定的 Redis 频道（channel）
        :param channel: 消息频道名称
        :param message: 消息内容
        :return:
        """
        await redis_client._instance.redis.publish(channel, message)

    async def connect(self) -> None:
        """
        初始化 Redis Pub/Sub 客户端
        :return:
        """
        self.pubsub = redis_client._instance.redis.pubsub()

    async def subscribe(self, channel: str) -> aioredis.Redis:
        """
        订阅指定的 Redis 频道（channel）
        :param channel: 消息频道名称
        :return:
        """
        await self.pubsub.subscribe(channel)
        return self.pubsub

    async def unsubscribe(self, channel: str) -> None:
        """
        取消订阅指定的 Redis 频道（channel）
        :param channel: 消息频道名称
        :return:
        """
        await self.pubsub.unsubscribe(channel)


class WebSocketManager(RedisPubSubManager, metaclass=SingletonMeta):
    """
    管理 WebSocket Channel 连接；
    """

    channel = "default_channel"

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.channels: Dict[str, List[WebSocket]] = {}

    async def _pubsub_data_reader(self, pubsub_subscriber):
        """
        不断读取 Redis 频道中的消息并广播到 频道（channel）中的所有 WebSocket 连接;
        注：get_message():
            {
            'type': 'message',
            'pattern': None,
            'channel': <Channel Name>,
            'data': '<Data>'
            }
        :param pubsub_subscriber:
        :return:
        """
        while True:
            #  获取来自 Redis 的消息，如果有新消息，解析消息并将其发送到相应channel内的所有 WebSocket 连接
            message = await pubsub_subscriber.get_message(ignore_subscribe_messages=True)
            if message is not None:
                all_sockets = self.channels[message['channel']]
                for socket in all_sockets:
                    await socket.send_text(message['data'])

    async def add_to_channel(self, channel: str, websocket: WebSocket) -> None:
        """
        将 Websocket 连接添加到频道（channel），并启动 Redis Pub/Sub 订阅
        :param channel: 消息频道名称
        :param websocket:
        :return:
        """
        await websocket.accept()
        if channel in self.channels:
            self.channels[channel].append(websocket)
        else:
            self.channels[channel] = [websocket]
            await self.connect()
            pubsub_subscriber = await self.subscribe(channel)
            # 创建一个任务，异步执行 _pubsub_data_reader()
            # _pubsub_data_reader() 可以在后台持续监听 Redis 消息，而不阻塞 WebSocket 连接的处理;
            asyncio.create_task(self._pubsub_data_reader(pubsub_subscriber))

    async def broadcast_to_channel(self, channel: str, message: Any) -> None:
        """
        将消息广播到channel中的所有 WebSocket 连接
        :param channel: 消息频道名称
        :param message: 消息内容
        :return:
        """
        await self._publish(channel, message)

    async def remove_from_channel(self, channel: str, websocket: WebSocket) -> None:
        """
        将 Websocket 从频道（channel）中移除，并在 频道（channel）为空时取消订阅 Redis 频道
        :param channel:
        :param websocket:
        :return:
        """
        self.channels[channel].remove(websocket)
        if len(self.channels[channel]) == 0:
            del self.channels[channel]
            await self.unsubscribe(channel)


class WebsocketConsumer:

    def __init__(self, websocket_class: Type[WebSocketManager]):
        if not callable(websocket_class):
            raise ValueError("Invalid websocket class")
        self.websocket_manager = websocket_class()

    async def connect(self, websocket: WebSocket, channel: str = None) -> None:
        """
        建立对应 Websocket 消息订阅
        :param websocket:
        :param channel:
        :return:
        """
        channel = channel or self.websocket_manager.channel
        await self.websocket_manager.add_to_channel(channel, websocket)
        try:
            while True:
                data = await websocket.receive_text()
                await self.websocket_manager.broadcast_to_channel(channel, data)
        except WebSocketDisconnect:
            await self.websocket_manager.remove_from_channel(channel, websocket)


# TODO：================= 自定义 Webocket =======================#

class ExampleWebsocket(WebSocketManager):
    """
    TODO 示例：自定义 WebSocket 示例
    """
    channel = "ws_example_channel"


class ExampleUserWebsocket(WebSocketManager):
    """
    TODO 示例：自定义 User WebSocket 示例
    """
    channel = "ws_example_user_channel_{}"

    async def broadcast_to_channel(self, channel: str, message: Any) -> None:
        """
        自定义消息结构体
        :param channel:
        :param message:
        :return:
        """
        data = {
            'type': 'user_event',
            'data': message
        }
        await self._publish(channel, json.dumps(data, ensure_ascii=False))

代码说明：

  • (1). RedisPubSubManager 类

    • 功能: 管理 Redis 连接及其 Pub/Sub 订阅;
    • 方法:
      • _publish(channel, message): 将消息发布到指定的 Redis 频道;
      • connect(): 初始化 Redis Pub/Sub 客户端;
      • subscribe(channel): 订阅指定的 Redis 频道，并返回 pubsub 对象;
      • unsubscribe(channel): 取消订阅指定的 Redis 频道;

  • (2). WebSocketManager 类

    • 功能: 继承 RedisPubSubManager，用于管理 WebSocket 连接和 Redis 通信;
    • 属性: init.channels 存储每个 Redis 频道和对应的 WebSocket 连接列表
    • 方法:
      • _pubsub_data_reader(pubsub_subscriber): 不断读取 Redis 频道中的消息并将其广播到所有连接到该频道的 WebSocket 客户端;
      • add_to_channel(channel, websocket): 将 WebSocket 连接添加到指定的频道，并启动 Redis Pub/Sub 订阅;
      • broadcast_to_channel(channel, message): 将消息广播到指定频道中所有 WebSocket 连接;
      • remove_from_channel(channel, websocket): 从频道中移除 WebSocket 连接，并在频道为空时取消订阅 Redis 频道;

  • (3). WebsocketConsumer 类

    • 功能: 通用的 WebSocket 消息处理类;
    • 方法:
      • connect(websocket, channel): 建立 WebSocket 连接，接收来自客户端的消息，并将其广播到指定的频道;

  • (4). 自定义 WebSocket 类

    • 功能: ExampleWebsocket 和 ExampleUserWebsocket 是两个自定义的 WebSocket 管理类;
    • ExampleWebsocket: 频道名称为 ws_example_channel;
    • ExampleUserWebsocket: 频道名称为 ws_example_user_channel_{}，带有用户标识符，并重写了 broadcast_to_channel 方法，以自定义消息的结构体;

工作流程：

  • 当一个 WebSocket 客户端连接到服务器时，通过 WebsocketConsumer.connect() 方法处理连接;
  • 该方法会将 WebSocket 客户端添加到指定的 Redis 频道，并在该频道有新的消息发布时，将其广播到所有连接的客户端;
  • 如果客户端发送消息，该消息会被发布到 Redis 频道，随后通过 Redis 机制广播到所有订阅该频道的客户端;

使用场景：

  • 这种架构适用于需要在多个 WebSocket 客户端之间同步消息的场景，如聊天室、实时通知系统等;
  • Redis Pub/Sub 机制确保了消息在所有订阅的客户端之间同步，WebSocket 保证了客户端与服务器的双向通信;

在项目 app/core/ 目录下，增加 utils.py 工具库，增加单例元类：

class SingletonMeta(type):
    """
    单例元类
    """
    _instances = {}

    def __call__(cls, *args, **kwargs):
        """
        方法重载，确保每次创建类的实例时，返回同一个实例;
        _instances，字典用于存储已经创建的实例
        :param args:
        :param kwargs:
        :return:
        """
        if cls not in cls._instances:
            cls._instances[cls] = super(SingletonMeta, cls).__call__(*args, **kwargs)
        return cls._instances[cls]

3. 在 FastAPI 定义 ws 接口

在 app/api/v1/endpoints/ 中定义 ws 端点：

# app/api/v1/endpoints/websockets.py

from fastapi import APIRouter, WebSocket

from app.core.websockets import ExampleWebsocket, ExampleUserWebsocket, WebsocketConsumer


ws_router = APIRouter()


@ws_router.websocket(f"/{ExampleWebsocket.channel}")
async def websocket_endpoint(websocket: WebSocket):
    # TODO 示例：通用示例，对应 ExampleWebsocket 单例实现
    await WebsocketConsumer(ExampleWebsocket).connect(websocket)


@ws_router.websocket("/{user_id}")
async def websocket_endpoint(websocket: WebSocket, user_id: int):
    # TODO 示例： 不同用户ID不同消息频道，对应 ExampleUserWebsocket 单例实现
    channel = ExampleUserWebsocket.channel.format(user_id)
    await WebsocketConsumer(ExampleUserWebsocket).connect(websocket, channel)

在 app/main.py 中定义 ws 路由：

def get_application() -> FastAPI:
... ...
    application.include_router(user_router, prefix=f"/api/{settings.VERSION}/users")
    application.include_router(ws_router, prefix=f"/ws")
    return application

4. 定义周期性任务，定时 ws 消息推送

在 app/tasks/scheduler_tasks.py 中定义周期性 ws 消息推送任务：

from app.core.websockets import ExampleWebsocket

@shared_task()
def push_websocket_data():
    """
    # TODO 示例：定时推送 Websocket 消息
    """
    asyncio.run_coroutine_threadsafe(
        ExampleWebsocket().broadcast_to_channel(ExampleWebsocket.channel,
                                                f"TODO 示例：当前时间（周期任务）: {datetime.datetime.now().strftime('%Y-%m-%d  %H:%M:%S')}"),
        AsyncLoopCreator.get_loop())

在 app/core/celery_config.py 配置周期性任务：

# 配置任务周期性
beat_schedule = {
    'get_current_time': {
        'task': 'app.tasks.scheduler_tasks.get_current_time',
        'schedule': crontab(minute='*/1'),  # Every minute
    },
    'push_websocket_data': {
        'task': 'app.tasks.scheduler_tasks.push_websocket_data',
        'schedule': 5,
    },
}

5. 验证

  • (1). 测试1：客户端（浏览器）推送消息至服务端：

    • 通过在线ws调试工具，例如：http://wstool.js.org/
      • ws 地址：ws://<IP>:9001/ws/1，点击“链接”；
      • 发送消息：测试；
      • 返回：{"type": "user_event", "data": "测试"};

  • (2). 测试2：服务端周期性推送消息至客户端（浏览器）：

    • 通过在线ws调试工具，例如：http://wstool.js.org/;
      • 监听 ws 地址：ws://<IP>:9001/ws/ws_example_channel;
      • 每隔 5s 收到消息：TODO 示例：当前时间（周期任务）: 2024-08-14 17:41:31;
感谢您花时间阅读文章!
关注公众号不迷路!
Mr_扛扛
关注
专栏目录
Springboot编写服务端基于websocket的视频传输接口
qq_39097034的博客
09-18 3649
Springboot编写服务端基于websocket的视频传输接口 文章目录Springboot编写服务端基于websocket的视频传输接口前言一、明确需求二、设计接口1.引入库2.编写接口3.saveFileImpl四.配合客户端进行测试五.发现问题，解决问题总结附一个有前端分块传输的代码 前言 今天初步完成了websocket视频接口的编写。websocket入门请看这位大神的文章SpringBoot2.0集成WebSocket，实现后台向前端推送信息 和前后端配合 具体流程如下： 一、明确需求 另
WebSocket 开发
harvestUachieve的博客
08-17 931
websocketWebSocket是HTML5下一种新的协议（websocket协议本质上是一个基于tcp的协议）它实现了浏览器与服务器全双工通信，能更好的节省服务器资源和带宽并达到实时通讯的目的Websocket是一个持久化的协议WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。
Websocket(2)--接口说明
琉璃糖的博客
01-25 4216
这节简单介绍下如何构建一个websocket应用及相应的接口规范。 目前大多数主流服务器支持websocket，下面是各浏览器支持情况： 本文所涉及示例都是在Firefox下测试。 服务器端可以自己实现代码（主要思路是解析消息头，获取Sec-WebSocket-Key，计算出服务器端Sec-WebSocket-Accept），市场上开源的也比较多，tomcat7和javeEE7（不是jdk
JMeter基础 — 使用JMeter测试WebSocket接口
公众号【伤心的辣条】资料领取~
06-30 1515
因为我之前对WebSocket接口也不是很了解，所以本篇文章先简单的概括的说明一下WebSocket的相关概念。在文章的后半部分，进行测试WebSocket接口的步骤说明。 1、什么是WebSocket接口 WebSocket是一种网络通信协议。 我们在上网过程中经常用到的是HTTP和HTTPS协议，HTTP协议和HTTPS协议的通信过程，通常是客户端通过浏览器发出一个请求，服务器按受请求后进行处理并返回结果给客户端，客户端接收响应的结果。 这种机制对于信息变化不是特别频繁的应用，可以良好支撑。但对于..
jmeter 测试websocket接口（二）
weixin_34050427的博客
08-25 95
1、到https://github.com/maciejzaleski/JMeter-WebSocketSampler下载Jmeter的WebSocket协议的支持插件：JMeterWebSocketSampler-1.0.2-SNAPSHOT.jar，并直接将这个jar包放到Jmeter软件的\lib\ext\目录下。2、另外，查阅https://github.com/maciejzaleski...
WebSocket接口初体验
码农飞哥
10-03 7454
本文简单首先介绍了WebSocket的基本概念和相关特点，WebSocket是一个全双工通信的协议，它支持客户端向服务端发送消息， 也支持服务端想客户端发送消息， 一次握手，可以多次发送消息。接着就是介绍了在SpringBoot中如何整合WebSocket的相关功能。实现了一个服务端和客户端。
h5stream API 中文手册 v1.00： WebSocket, WebRTC, HLS, RTMP 开发指南
WebSocket接口用于低延迟的双向通信；WebRTC则支持点对点的高清视频通信；HLS接口则适用于适应性流媒体，可以根据网络条件自动调整视频质量；最后，RTMP接口用于从RTMP服务器接收流。 总体来说，h5stream API 中文...
即时通讯开发长连接网关技术:WebSocket实时推送网关技术
蔚可云的博客
08-05 899
客户端定时向服务端发送心跳消息，如果超过设定的时间仍没有收到心跳，则认为客户端与服务端的长连接已断开，服务端会关闭连接，清理内存中的会话。在众多的WebSocket实现中，从性能、扩展性、社区支持等方面考虑，最终选择了Netty。网关以多节点方式构成集群，每节点负责一部分长连接，可实现负载均衡，当面对海量连接时，也可以通过增加节点的方式分担压力，实现水平扩展。如果直接使用新的WebSocket网关的推送能力，只需要简单的接口调用就实现了数据推送，开发时间降低到分钟级别，研发效率大大提高。...
WebSocket带有说明文档的详解
07-26
**使用.txt** - 这是一个文本文件，可能包含了如何使用WebSocket的简要说明，例如如何配置服务器，客户端如何连接，以及如何发送和接收消息的步骤。 在学习WebSocket时，你需要理解HTTP和WebSocket之间的区别，熟悉...
jmeter测试websocket接口1
08-08
### jmeter测试websocket接口知识点详解 #### 一、Websocket协议简介 Websocket是一种与HTTP协议不同的双向通信协议。与HTTP这种非持久性协议相比，Websocket提供了更高效的通信方式。 - **HTTP协议**：HTTP协议...
WebSocket 接口测试：打通前端与后端的通信之路！
m0_58026506的博客
11-29 455
WebSocketWebSocket 是一种基于在单个 TCP 连接上进行全双工通信的协议，解决了HTTP协议不适用于实时通信的缺点，相较于 HTTP 协议，WebSocket 协议实现了持久化网络通信，可以实现客户端和服务端的长连接，能够进行双向实时通信，协议名为"ws"。WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在 WebSocket API 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。
php websocket开放接口,接口WebSocket
weixin_26712065的博客
03-21 959
WebSocket接口新增自V0.0.4接口类文件为: Api/Websocket.phpWebsocket接口时指使用应用层Websocket协议来解析数据流的接口类文件。使用Websocket接口, 只需要实例化Api\Websocket.php即可。使用Websocket接口, 就是使用了H5推出的WebSocket协议。可以在服务器和客户端浏览器之间维持一个长链接。颠覆传统的HTTP交互方...
【JMeter】之websocket接口
段王爷的博客
04-10 3131
http不能主动推送消息，必须要有请求，所以聊天情况下，需要不断去轮询查看服务器是否有消息回复 websocket长链接，链接后可以一直发送消息（聊天、直播） 抓包websocket接口 绿色向上箭头：发出去的消息 红色向下箭头：服务器返回的消息 使用jmeter工具测试websocket接口 插件安装 创建连接 发送匹配接口（type：match） 发送消息（type：normal） 获取回复 关闭连接 备注：1.msgi...
WebSocket 协议以及 Socket 接口
青蛙king的博客
05-14 3121
在项目开发时，我们经常需要与服务器进行持续的通讯以保持双方信息的同步。通常这种持久通讯在不刷新页面的情况下进行，消耗一定的内存资源常驻后台，并且对于用户不可见。轮询：定时轮询：通过 Ajax 轮询请求，每隔一秒或者一段时间请求一次服务器查看是否有未读消息。长轮询：每一个请求发送到服务器时，服务器将请求卡主，直到有消息时才返回。使用 WebSocket 协议（推荐）由于轮询存在明显的弊端：占用服务端地资源, 增大服务端压力，会产生很多无效请求，而且消息存在延时性。
websocket 建立聊天接口
留着鼻涕敲代码
12-06 1130
1、 websocket简介 WebSocket 协议在2008年诞生，2011年成为国际标准。所有浏览器都已经支持了。 它的最大特点就是，服务器可以主动向客户端推送信息，客户端也可以主动向服务器发送信息，是真正的双向平等对话，属于服务器推送技术的一种。 典型的websocket应用场景： 即时通讯…客服 聊天室 广播 点餐 2、socket技术 客户端：发socket请求 可以用原生的 可以使用包 socket.io 服务器端: 提供socket服务 socket.io 3. 代
接口测试之WebSocket
patmos
10-31 514
接口测试之WebSocket WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。 WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在 WebSocket API 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进 行双向数据传输。 在 WebSocket API 中，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了 一条快速通道。两者之间就直接可以数据互相传送。 W
Postman测WebSocket接口
最新发布
2401_83387413的博客
06-07 990
在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。在测试 WebSocket 的时候，可以使用 js 编写简单的页面，通过浏览器进行访问调试。连接建立成功后，在 Message 的信息栏中输入模拟数据，点击 “Send” 按钮，即可与服务端进行数据交互。在地址栏中输入相应的 WebSocket 请求地址，点击地址栏右侧的 “Connect” 按钮，即可建立连接。支持对交互信息进行格式化显示，如：Text、JSON、XML、HTML等；
全网最细，Python接口自动化测试websocket接口实战，即学即用......
大佬云集技术答疑交流群：743262921(进群暗号:222)
03-29 2827
在python中，发送http请求，比较有名的是requests这个库；webservice的接口可以使用suds-py3来请求。那么websocket怎么请求呢？其实在python中也有很多第三方库可以用来发送websocket请求。比如websocket-client, 那么接下来我们先来看看websocket-client这个库的使用。环境安装由于websocket-client是第三方库，使用之前需要先安装，安装直接使用pip 命令安装即可。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值