首页 > 解决方案 > 复杂消息结构解析器的设计

问题描述

我正在开发一个解析器,它应该将一种类型的消息从字符串转换为 JSON,并将另一种类型的消息从 JSON 转换为字符串。

这两种类型的消息可以进一步扩展为更多类型,并且具有共同的结构。

在此处输入图像描述

到目前为止,我已经使用 OOP 方法构建了消息的结构。它使我可以灵活地在将来添加更多类型的消息,并将消息的每个部分的责任划分到不同的类之间。

我创建了一个名为 Parsable 的接口,其中包含 2 个静态方法:json_build 和 txt_build。txt_build 函数将字符串作为参数,检查它的一些格式(与类相关的部分),并返回相关类的实例,所有字段都设置为消息的内容。

例如,如果我有这样一条消息:“MESSAGE

MESSAGE_TYPE A

COMMON_FIELD1 SOME_VALUE

COMMON FIELD2 SOME_OTHER_VALUE

身体

停止”

然后将消息作为参数的 txt_build 将返回一个 MessageA 实例,其中 common_field1 和 common_field2 分别设置为 SOME_VALUE 和 SOME_OTHER_VALUE。

BODY 包含对每种类型的消息都是唯一的字段。为了简化问题,我没有提到它。

另外,我想有一个使用 json_build 方法将 JSON 对象从 JSON 转换为 txt 的选项。

所以像这样的json:

{
    "type": "B",
    "common_field1": "SOME_VALUE",
    "common_field2": "SOME_OTHER_VALUE"
    "body": {
         ...
    }
}

还会给我一个 MessageB 实例,其字段设置如上。

在将一个类的所有字段设置为其值的实例之后,我可以调用 get_json() 或 get_txt() 方法以获取 JSON 表示或字符串表示(根据我正在使用的某些指定格式) 的消息。

我开始实现通过字符串构建 MessageA 实例的部分,代码看起来有点像这样:

class Message:

@staticmethod
def txt_build(txt):
    parsed = ...  # code that parses the message

    common_field1, common_field2 = parsed['common_field1'], parsed['common_field2']

    msg_dispatch = {
        'A': MessageA,
        'B': MessageB
    }

    return msg_dispatch[parsed['msg_type']](common_field1, common_field2, msg_body)


class MessageA:
    def __init__(self, common_field1, common_field2, msg_body):
        super(MessageA, self).__init__(common_field1, common_field2)
        # code that parses the msg_body and init fields unique to MessageA


class MessageB:
    pass

该代码适用于解析文本和初始化字段。问题是我使用子类的构造函数来提供消息的主体(这是每个子类唯一相关的部分),所以我不能再次使用它来解析 JSON 对象,至少不是以一种漂亮的方式。

我想到的唯一可以回答良好代码实践的解决方案(至少在我看来)是复制整个消息层次结构,以便第一个解析 JSON,另一个解析字符串。

我想知道您是否有任何其他解决方案,可以简化事情。也许我没有注意到一个更简单的解决方案,或者没有想到使用一些适合这种情况的设计模式。我觉得我把事情不必要地复杂化了,我没有人可以咨询。

我很想听听关于如何以不同方式做事的任何建议或新想法,我希望我能说清楚。

非常感谢 :)

标签: pythonjsonparsingdesign-patterns

解决方案


我最终意识到我让事情变得比现在更复杂。

我尝试为编程语言等复杂语言构建解析器,而我尝试解析的消息格式要简单得多。

我将 Message 类层次结构与解析器分开,只在消息层次结构中留下 get_json 和 get_txt 方法。然后我构建了一个 Parser 接口,留下一个选项来构建几种解析器,例如 TxtParser、JSONParser 等。


推荐阅读