实现一个消息平台适配器

INFO

请先阅读 插件开发 -> 组件扩展 章节，了解 LangBot 的组件扩展机制。

本文章将以aiocqhttp适配器为例，讲解如何为 LangBot 实现一个新的消息平台适配器，以便接入 WhatsApp、Discord 等新的消息平台协议。

• 文中代码以 v3.4.1.5 版本为例。

注册

首先查看组件扩展页的说明：

新增一个消息平台适配器，例如：接入 WhatsApp、Discord 等。

- 基类：`pkg.platform.adapter.MessageSourceAdapter`
- 装饰器：`pkg.platform.adapter.adapter_class(name: str)`
- 参考实现：`pkg.platform.adapters/`
- 使用方式：`data/config/platform.json`的`platform-adapters`中各个配置信息，将在初始化时自动根据`adapter`名称查找对应的适配器实现，并将配置传递给适配器以进行初始化。消息平台适配器实现复杂，建议多参考现有的实现。

我们实现一个消息平台适配器，本质上就是实现一个继承于基类的类，并使用装饰器进行注册。最后在运行阶段供用户选择并使用。

写到插件中

在插件目录下新建一个 aiocqhttp.py 文件：

import pkg.platform.adapter

@pkg.platform.adapter.adapter_class("aiocqhttp")
class AiocqhttpAdapter(pkg.platform.adapter.MessageSourceAdapter):
    pass

启动时，LangBot 的插件加载器会自动加载此模块（文件），并注册到消息平台适配器列表。

直接贡献到主仓库

在 pkg/platform/sources/ 目录下新建一个 aiocqhttp.py 文件：

from .. import adapter

@adapter.adapter_class("aiocqhttp")
class AiocqhttpAdapter(adapter.MessageSourceAdapter):
    pass

同时在 pkg/platform/manager.py 的第40行导入此模块：

        from .sources import nakuru, aiocqhttp, qqbotpy

事件、消息转换器

消息平台适配器，主要的工作就是接收消息平台协议的事件，将其转换成LangBot的格式，传递给核心组件，LangBot 核心组件处理完后，将需要回复的内容传递给消息平台适配器，消息平台适配器再将内容转换成平台协议的格式，发送给消息平台。

下图展示了两种情况的处理模式：消息平台协议无 SDK、有成熟 SDK。第一种情况我们需要根据消息平台协议的文档，自行实现连接管理、网络格式数据转换成 LB 消息 Python 对象。第二种情况，消息平台有成熟的 SDK，我们只需要根据 SDK 的文档，调用 SDK 的 API 创建连接，注册事件监听器，并实现消息转换器。

在pkg.platform.sources.aiocqhttp文件里，我们可以看到不只有AiocqhttpAdapter，还有class AiocqhttpMessageConverter(adapter.MessageConverter): 和 class AiocqhttpEventConverter(adapter.EventConverter):。

• MessageConverter 用于进行 LangBot 消息和平台消息的互相转换。
• EventConverter 用于进行 LangBot 事件和平台事件的互相转换。

TBC...