LangBot如何接入消息平台（上）？

本文旨以钉钉为例，介绍如何实现一个基于 websocket 协议的 LangBot 平台消息适配器。

本文是对消息适配器的开发细节描述，若对整个架构感兴趣，请参考 LangBot文档中的“如何实现一个消息适配器”

首先，我们需要了解一下 LangBot 设计的适配器接口。如 LangBot官方文档 中提到的架构，LangBot 具有消息转换器，事件转换器和适配器主类。

而我们要做的就是，将消息平台的消息格式，转换为 LangBot 可以理解并且可以处理的格式，之后 LangBot 产生的消息，也能被正确的回复给用户，但是，具体是怎么实现的呢？我们来看这一段代码：

class DingTalkMessageConverter(adapter.MessageConverter):

    @staticmethod
    async def yiri2target(
        message_chain:platform_message.MessageChain
    ):
        for msg in message_chain:
            if type(msg) is platform_message.Plain:
                return msg.text

    @staticmethod
    async def target2yiri(event:DingTalkEvent, bot_name:str):
        yiri_msg_list = []
        yiri_msg_list.append(
            platform_message.Source(id = event.incoming_message.message_id,
            time=datetime.datetime.now())
        )

        for atUser in event.incoming_message.at_users:
            if atUser.dingtalk_id == event.incoming_message.chatbot_user_id:
                yiri_msg_list.append(platform_message.At(target=bot_name))

        if event.content:
            text_content = event.content.replace("@"+bot_name, '')
            yiri_msg_list.append(platform_message.Plain(text=text_content))
        if event.picture:
            yiri_msg_list.append(platform_message.Image(base64=event.picture))
        if event.audio:
            yiri_msg_list.append(platform_message.Voice(base64=event.audio))

        chain = platform_message.MessageChain(yiri_msg_list)
        
        return chain

以上是 LangBot 的消息转换器，他继承了MessageConverter类，在其中，我们必须实现两个东西。由于我们做的工作就是将LangBot接入到各个消息平台中，所以必须要有一个函数，可以将LangBot内部的格式“翻译”成消息平台可以理解的格式，同时消息平台的消息也能正确的解析成LangBot格式的消息。

其中，yiri2target 就是LangBot到目标平台的函数。我们可以看到，在实现这个类的时候，LangBot将传来一个Messagechain,而Messagechain，就是LangBot内部的消息格式，具体可以看一下代码。

这个yiri2target，在钉钉中，会将LangBot产生的回答（目前假设LangBot的AI回答会产生一段文本），返回出去。

然后到了此类的下半部分，target2yiri。此方法会将用户发来的消息，也就是目标平台的消息，转换为LangBot的格式。我们可以看到，首先应该初始化一个list，list里面会把传来的消息转化成LangBot支持的类，Plain就是文本消息，base64是可以图片消息，等等等等。

之后，我们将这个list整个放到Messagechain中，return回去。

接下来是事件转换器，有开发者会想知道，我们已经有消息转换器，各种消息的信息都会存到其中，为什么还需要事件转换器呢？
在之后的适配器主类中，我们需要将事件独立出来，便于获取事件发生的信息，这对于以后的维护，以及后续的开发是至关重要的。

事件转换器的代码：

class DingTalkEventConverter(adapter.EventConverter):

    @staticmethod
    async def yiri2target(
        event:platform_events.MessageEvent
    ):
        return event.source_platform_object

    @staticmethod
    async def target2yiri(
        event:DingTalkEvent,
        bot_name:str
    ):
        message_chain = await DingTalkMessageConverter.target2yiri(event, bot_name)

        if event.conversation == 'FriendMessage':

            return platform_events.FriendMessage(
                sender=platform_entities.Friend(
                    id=event.incoming_message.sender_id,
                    nickname = event.incoming_message.sender_nick,
                    remark=""
                ),
                message_chain = message_chain,
                time = event.incoming_message.create_at,
                source_platform_object=event,
            )
        elif event.conversation == 'GroupMessage':
            sender = platform_entities.GroupMember(
                id = event.incoming_message.sender_id,
                member_name=event.incoming_message.sender_nick,
                permission= 'MEMBER',
                group = platform_entities.Group(
                    id = event.incoming_message.conversation_id,
                    name = event.incoming_message.conversation_title,
                    permission=platform_entities.Permission.Member
                ),
                special_title='',
                join_timestamp=0,
                last_speak_timestamp=0,
                mute_time_remaining=0
            )
            time = event.incoming_message.create_at
            return platform_events.GroupMessage(
                sender =sender,
                message_chain = message_chain,
                time = time,
                source_platform_object=event
            )

在上述的代码中，yiri2target提供了一个简化代码复杂度的设计，就是在原先的转换器中，新设置了一个属性，叫做source_platform_object,这会将原先的消息组件原封不动的传回来，所以理论上我们不需要对事件对象进行改动或者转换，在开发新的平台时，也建议这么用。

target2yiri就是在构造LangBot内部的事件了，首先我们可以看到，LangBot将事件分成了两类，一类是FriendMessage，一类是GroupMessage，其中需要包含sender，message_chain,time还有event，设置return。

至此，消息转换器和事件转换器就完成了，Langbot可以和消息平台进行转换，我们只剩下来了如何让 LangBot 收到消息，并且做出回复。

请看第二篇消息适配器的实现。在下一篇中，我们会完成适配器主类的设计，使 LangBot 可以真正的接入到某个平台。

— Mar 15, 2025