1

我正在尝试构建一个为 API 构建 XML 响应的库。为了帮助说明我的问题，这里有 2 个示例 API 响应。第一个用于显示菜单，第二个用于显示文本。

<CiscoIPPhoneMenu>
  <Title>Title text goes here</Title>
  <Prompt>Prompt text goes here</Prompt>
  <MenuItem>
   <Name>The name of each menu item</Name>
   <URL>The URL associated with the menu item</URL>
  </MenuItem>
  <SoftKeyItem>
   <Name>Name of soft key</Name>
   <URL>URL or URI of soft key</URL>
   <Position>Position information of the soft key</Position>
  </SoftKeyItem>
</CiscoIPPhoneMenu>

...

<CiscoIPPhoneText>
  <Title>Title text goes here</Title>
  <Prompt>The prompt text goes here</Prompt>
  <Text>The text to be displayed as the message body goes here</Text>
  <SoftKeyItem>
   <Name>Name of soft key</Name>
   <URL>URL or URI of soft key</URL>
   <Position>Position information of the soft key</Position>
  <SoftKeyItem>
</CiscoIPPhoneText>

好的，所以我的模块大纲如下所示：

class CiscoIPPhone(object): 
    def __init__(self, title=None, prompt=None):
        self.title = title
        self.prompt = prompt

class MenuItem(object):
    def __init__(self, name, url):
        self.name = name
        self.url = url

class CiscoIPPhoneMenu(CiscoIPPhone):
    def __init__(self, *args, **kwargs):
        super(CiscoIPPhoneMenu, self).__init__(*args, **kwargs)
        self.items = []

    def add_menu(self, name, url):
        self.items.append(MenuItem(name, url))

注意：为了可读性，我删除了这些类处理的验证和清理。

所以我的问题是：

  1. 我实际上是在输出这些对象的序列化表示，这样做是否被认为是错误的或不好的做法？
  2. 是否有描述这种 API 接口类的设计模式？
  3. 是否有一个编写优雅的 Python 库（Pythonic）可以做类似的事情？（我想像 Django 模型序列化或 Django-Tastypie 的精简版）。
4

1 回答 1

1

最不幸的是，我无法评论 Python 方面的事情。

个人觉得这样的设计是可以接受的。

这些消息在一个地方被序列化和反序列化。使用这些类的域代码创建一个，用必要的数据填充它，并将它（或其序列化表示）传递给另一个组件。当实际序列化发生时，类本身会检查是否所有强制数据都已设置。

这些类是测试友好的。您只需创建一条消息、填写一些值并检查 XML 序列化版本。测试模式检查期望和实际输出。这些测试是整个协议的规范。

该设计适用于一个不错的流畅 API：

new CiscoIPPhoneMenu()
    .withTitle("Title text goes here")
    .withPrompt("Prompt text goes here")
    ...

出于参考目的，Martin Reddy 在C++ 的 API 设计中指出，对于协议或文件格式，有一个组件可以转换为序列化表示或从序列化表示转换。我认为这正是这些课程的目的。

如果序列化表示发生变化（例如，从 XML 格式变为二进制格式），您可以通过例如提供第二个接受格式的 ctor 轻松切换表示，或者您预计会发生变化并引入SerializationFormat枚举。

我可以很容易地想象一个 python 模块，它采用 XML 模式 ComplexType 并从中生成匹配的 python 类。一旦我尝试使用 Altova XML Spy 在 C# 中生成这些类；然而，这涉及到引用一个运行时 DLL，并且为此使用另一个 DLL 似乎开销太大。这本质上是protobuf的工作方式，XML 模式 ComplexType 在外部 DSL 中定义，序列化格式为二进制格式。

于 2012-05-08T20:54:54.237 回答