Python中关闭WAAPI(WAMP/Autobahn)连接时的断开异常问题排查

问题背景 #

参考官方WAAPI Python示例代码实现连接，官网示例代码如下：

from waapi import WaapiClient, CannotConnectToWaapiException
from pprint import pprint

try:
    # 使用默认URL连接Waapi
    with WaapiClient() as client:
        # 注：client会在代码块结束时自动断开连接

        # 无参数的简单RPC调用
        print("获取Wwise实例信息:")
        result = client.call("ak.wwise.core.getInfo")
        pprint(result)

        # 带参数的RPC调用
        print("查询默认工作单元信息:")
        object_get_args = {
            "from": {
                "path": ["\\Actor-Mixer Hierarchy\\Default Work Unit"]
            },
            "options": {
                "return": ["id", "name", "type"]
            }
        }
        result = client.call("ak.wwise.core.object.get", object_get_args)
        pprint(result)
except CannotConnectToWaapiException:
    print("无法连接到Waapi: Wwise是否已运行且WAAPI已启用?")

自行编写了管理连接生命周期的自定义类：

from waapi import WaapiClient, CannotConnectToWaapiException

class WwiseConnector:
    def __init__(self):
        self.client = None

    def connect(self):
        try:
            self.client = WaapiClient()
        except CannotConnectToWaapiException:
            print("无法连接到WAAPI — Wwise是否已开启并启用WAAPI?")
        except Exception as e:
            print(f"意外错误: {e}")

    def disconnect(self):
        if self.client:
            self.client.disconnect()
            self.client = None

运行时持续出现以下错误：

session closed with reason wamp.close.transport_lost [WAMP transport was lost without closing the session]

请问该异常产生的原因是什么？正确的WAAPI连接与断开生命周期管理方式是怎样的？

错误原因分析 #

这个错误的核心是WAMP会话未被正确关闭，导致传输层连接意外丢失，问题出在自定义的WwiseConnector实现上：

• WAAPI的WaapiClient基于WAMP协议，内部维护了异步IO循环和会话状态。直接调用disconnect()时，可能没有等待会话的优雅关闭流程完成就释放客户端对象，导致Wwise端检测到会话异常中断。
• 官网示例使用with语句（上下文管理器），因为WaapiClient实现了__enter__和__exit__方法，会在代码块结束时自动处理优雅关闭会话、终止异步循环的完整流程，避免了传输层丢失的问题。

正确的WAAPI生命周期管理方式 #

方式1：优先使用上下文管理器（推荐） #

这是官方推荐的方式，无需手动管理连接和断开，由上下文自动处理完整生命周期：

from waapi import WaapiClient, CannotConnectToWaapiException

class WwiseConnector:
    def __enter__(self):
        try:
            self.client = WaapiClient()
            return self.client
        except CannotConnectToWaapiException:
            raise RuntimeError("无法连接到WAAPI，请确认Wwise已开启并启用WAAPI")
        except Exception as e:
            raise RuntimeError(f"连接失败: {str(e)}")

    def __exit__(self, exc_type, exc_val, exc_tb):
        if self.client:
            # 上下文管理器会自动处理优雅关闭
            self.client.disconnect()
            self.client = None

# 使用示例
try:
    with WwiseConnector() as client:
        # 在这里执行所有WAAPI操作
        info = client.call("ak.wwise.core.getInfo")
        print(info)
except RuntimeError as e:
    print(e)

方式2：手动管理生命周期（需确保优雅关闭） #

如果必须手动控制连接和断开，需要确保等待WAMP会话的关闭流程完成，修正后的代码如下：

from waapi import WaapiClient, CannotConnectToWaapiException
import asyncio

class WwiseConnector:
    def __init__(self):
        self.client = None
        self._loop = None

    def connect(self):
        try:
            # 显式获取或创建异步IO循环
            self._loop = asyncio.get_event_loop()
            # 同步创建客户端（内部已处理异步连接）
            self.client = WaapiClient(loop=self._loop)
        except CannotConnectToWaapiException:
            print("无法连接到WAAPI — Wwise是否已开启并启用WAAPI?")
        except Exception as e:
            print(f"意外错误: {e}")

    def disconnect(self):
        if self.client and self._loop:
            try:
                # 等待异步关闭流程完成
                self._loop.run_until_complete(self.client.disconnect_async())
            except Exception as e:
                print(f"断开连接时出错: {e}")
            finally:
                self.client = None
                self._loop = None

# 使用示例
connector = WwiseConnector()
connector.connect()

if connector.client:
    try:
        # 执行WAAPI操作
        info = connector.client.call("ak.wwise.core.getInfo")
        print(info)
    finally:
        # 必须确保调用断开
        connector.disconnect()

关键注意事项 #

• 永远不要在未完成会话关闭的情况下直接销毁WaapiClient对象。
• 若使用手动管理，必须依赖异步循环完成disconnect_async()的执行，这是优雅关闭会话的核心步骤。
• 确保在所有WAAPI操作完成后，无论是否出现异常，都要调用断开方法（类似finally块的逻辑）。

内容的提问来源于stack exchange，提问作者a.b89