mqttxx 2.0.2__py3-none-any.whl → 3.1.2__py3-none-any.whl

mqttxx/rpc.py

@@ -1,9 +1,8 @@
 # MQTT RPC 模块 - 基于 aiomqtt 的双向对等 RPC 调用
 
 import asyncio
-import json
 import uuid
-from typing import Any, Callable, Optional
+from typing import Any, Callable, Optional, Type
 from loguru import logger
 
 from .client import MQTTClient
@@ -14,8 +13,9 @@ from .exceptions import (
     TooManyConcurrentCallsError,
     MQTTXError,
     ErrorCode,
+    MessageError,
 )
-from .protocol import RPCRequest, RPCResponse
+from .protocol import RPCRequest, RPCResponse, parse_message_from_bytes, Codec, JSONCodec
 
 
 # 权限检查回调类型
@@ -75,7 +75,8 @@ class RPCManager:
         self,
         client: MQTTClient,
         config: Optional[RPCConfig] = None,
-        auth_callback: Optional[AuthCallback] = None
+        auth_callback: Optional[AuthCallback] = None,
+        codec: Type[Codec] = JSONCodec,  # 新增：可插拔编解码器
     ):
         """初始化 RPC 管理器
 
@@ -85,6 +86,7 @@ class RPCManager:
             auth_callback: 权限检查回调函数（可选）
                 签名：async def auth_callback(caller_id: str, method: str, request: RPCRequest) -> bool
                 返回：True = 允许，False = 拒绝
+            codec: 编解码器（默认 JSONCodec）
 
         使用示例：
             client = MQTTClient(...)
@@ -92,6 +94,7 @@ class RPCManager:
 
             # 基础用法（无权限控制）
             rpc = RPCManager(client)
+            rpc.setup("my/rpc/responses")  # 设置响应主题
 
             # 带权限控制
             async def auth_check(caller_id, method, request):
@@ -102,14 +105,51 @@ class RPCManager:
         self._client = client
         self.config = config or RPCConfig()
         self._auth_callback = auth_callback
+        self._codec = codec  # 保存编解码器
 
         # RPC 状态
         self._pending_calls: dict[str, asyncio.Future] = {}  # request_id → Future
         self._handlers: dict[str, Callable] = {}  # method_name → handler
-        self._pending_calls_lock = asyncio.Lock()  # 修复 P0-1：保护 _pending_calls 并发访问
+        self._pending_calls_lock = (
+            asyncio.Lock()
+        )  # 修复 P0-1：保护 _pending_calls 并发访问
 
         logger.info("RPCManager 已初始化")
 
+    def setup(self, reply_topic: str):
+        """设置 RPC 响应主题并自动订阅
+
+        这个方法会：
+        1. 订阅 reply_topic（接收 RPC 响应）
+        2. 注册消息处理器（自动解码 + 分发）
+
+        Args:
+            reply_topic: 响应主题（例如：server/rpc_responses）
+
+        示例：
+            rpc = RPCManager(client)
+            rpc.setup("my/rpc/responses")
+        """
+        async def handle_bytes(topic: str, payload: bytes):
+            """bytes → RPC message → handle"""
+            try:
+                # 解码
+                message = parse_message_from_bytes(payload, self._codec)
+
+                # 路由
+                if isinstance(message, RPCRequest):
+                    await self._handle_request(topic, message)
+                elif isinstance(message, RPCResponse):
+                    await self._handle_response(topic, message)
+            except MessageError as e:
+                logger.debug(f"非 RPC 消息 - topic: {topic}, reason: {e}")
+            except Exception as e:
+                logger.exception(f"RPC 消息处理失败: {e}")
+
+        # 订阅 raw bytes
+        self._client.raw.subscribe(reply_topic, handle_bytes)
+
+
     def register(self, method_name: str):
         """装饰器：注册本地 RPC 方法供远程调用
 
@@ -129,9 +169,10 @@ class RPCManager:
                 # 同步方法也支持
                 return {"result": "ok"}
         """
+
         def decorator(func: Callable):
             self._handlers[method_name] = func
-            logger.success(f"RPC 方法已注册: {method_name}")
+            # logger.debug(f"RPC 方法已注册: {method_name}")  无需输出
             return func
 
         return decorator
@@ -171,12 +212,12 @@ class RPCManager:
         if isinstance(message, RPCRequest):
             asyncio.create_task(
                 self._handle_request(topic, message),
-                name=f"rpc_req_{message.request_id[:8]}"
+                name=f"rpc_req_{message.request_id[:8]}",
             )
         elif isinstance(message, RPCResponse):
             asyncio.create_task(
                 self._handle_response(topic, message),
-                name=f"rpc_resp_{message.request_id[:8]}"
+                name=f"rpc_resp_{message.request_id[:8]}",
             )
 
     async def call(
@@ -254,8 +295,9 @@ class RPCManager:
             future = asyncio.get_event_loop().create_future()
             self._pending_calls[request_id] = future
 
-        # 发送请求
-        await self._client.publish(topic, json.dumps(request.to_dict()), qos=1)
+        # 发送请求（使用编解码器）
+        payload = request.encode(self._codec)
+        await self._client.raw.publish(topic, payload, qos=1)
         logger.debug(f"RPC 请求已发送 - method: {method}, request_id: {request_id[:8]}")
 
         try:
@@ -316,8 +358,7 @@ class RPCManager:
                     f"RPC 权限拒绝 - caller: {message.caller_id}, method: {message.method}"
                 )
                 response = RPCResponse(
-                    request_id=message.request_id,
-                    error="Permission denied"
+                    request_id=message.request_id, error="Permission denied"
                 )
                 await self._send_response(message.reply_to, response)
                 return
@@ -328,8 +369,7 @@ class RPCManager:
         if not handler:
             logger.warning(f"方法未找到 - method: {message.method}")
             response = RPCResponse(
-                request_id=message.request_id,
-                error=f"方法未找到: {message.method}"
+                request_id=message.request_id, error=f"方法未找到: {message.method}"
             )
         else:
             # 执行方法
@@ -353,22 +393,20 @@ class RPCManager:
         try:
             if asyncio.iscoroutinefunction(self._auth_callback):
                 allowed = await self._auth_callback(
-                    message.caller_id,
-                    message.method,
-                    message
+                    message.caller_id, message.method, message
                 )
             else:
                 allowed = self._auth_callback(
-                    message.caller_id,
-                    message.method,
-                    message
+                    message.caller_id, message.method, message
                 )
             return bool(allowed)
         except Exception as e:
             logger.exception(f"权限检查失败: {e}")
             return False  # 默认拒绝
 
-    async def _execute_handler(self, handler: Callable, message: RPCRequest) -> RPCResponse:
+    async def _execute_handler(
+        self, handler: Callable, message: RPCRequest
+    ) -> RPCResponse:
         """执行 RPC 方法处理器
 
         Args:
@@ -390,10 +428,7 @@ class RPCManager:
                 result = handler(message.params)
 
             logger.debug(f"RPC 方法执行成功 - method: {message.method}")
-            return RPCResponse(
-                request_id=message.request_id,
-                result=result
-            )
+            return RPCResponse(request_id=message.request_id, result=result)
 
         except asyncio.CancelledError:
             # 任务被取消，向上传播
@@ -401,10 +436,7 @@ class RPCManager:
 
         except Exception as e:
             logger.exception(f"RPC 方法执行失败 - method: {message.method}")
-            return RPCResponse(
-                request_id=message.request_id,
-                error=str(e)
-            )
+            return RPCResponse(request_id=message.request_id, error=str(e))
 
     async def _send_response(self, topic: str, response: RPCResponse):
         """发送 RPC 响应
@@ -413,5 +445,6 @@ class RPCManager:
             topic: 响应主题
             response: RPC 响应消息
         """
-        await self._client.publish(topic, json.dumps(response.to_dict()), qos=1)
+        payload = response.encode(self._codec)
+        await self._client.raw.publish(topic, payload, qos=1)
         logger.debug(f"RPC 响应已发送 - request_id: {response.request_id[:8]}")