WCF 与 XmlSerializer：返回通用协定时出现命名空间冲突

Question

背景

我正在使用 WCF 为 C#.NET Web 应用程序开发 REST API。我将其配置为使用 XmlSerializer 而不是其默认的 DataContractSerializer，以便更好地控制 XML 格式。我创建了一个通用的 ResponseContract 数据协定，它使用 和 包装响应以实现通用请求状态、错误消息和命名空间等数据。一个示例方法：

ResponseContract; GetItemList(...)

上述方法的响应示例：

<?xml version="1.0" encoding="utf-8"?>
<Api xmlns="http://example.com/api/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <Response Status="OKAY" ErrorCode="OKAY" ErrorText="">
      <Data Template="ItemList">
         <Pages Template="Pagination" Size="10" Index="1" Count="13" Items="126" />
         <Items>
            <Item example="..." />
            <Item example="..." />
            <Item example="..." />
        </Items>
      </Data>
   </Response>
</Api>

问题

这对于方法都具有相同通用 ResponseContract 类型的服务非常有效。 WCF 或 XmlSerializer 期望每个协定在其命名空间内具有唯一的名称，但服务现在返回具有相同 XML 根名称的不同类型的通用协定：

ResponseContract<ItemListContract, ItemListErrorCode> GetItemList(...)
ResponseContract<ItemContract, ItemErrorCode> GetItem(...)

结果是：

The top XML element 'Api' from namespace 'http://example.com/api/' references distinct types Company.Product.ApiServer.Contracts.ResponseContract`2[Company.Product.ApiServer.Contracts.Items.ItemListContract,Company.Product.ApiServer.Interfaces.Items.ItemListErrorCode] and Company.Product.ApiServer.Contracts.ResponseContract`2[Company.Product.ApiServer.Contracts.Items.ItemContract,Company.Product.ApiServer.Items.ItemErrorCode]. Use XML attributes to specify another XML name or namespace for the element or types.

服务必须允许不同的返回类型。这是很难实现的，因为 ResponseContract （设置名称和命名空间）是通用的并且由所有 API 方法返回。我还需要维护 WSDL 元数据 完整性，这意味着不会使用反射进行动态更改。

尝试的解决方案

1. 不可能以声明方式更改 XML 属性，因为 根元素及其属性是完全通用的（在 ResponseContract 中）。

2. 使用反射在运行时更改属性命名空间（例如“http://example.com/api/Items/GetItemList”）没有任何效果。可以获取属性，但对它们的更改没有效果。无论如何，这都会破坏 WSDL。

3. 实现 IXmlSerialized 时，调用 WriteXml() 时，编写器已位于 开始标记之后。只能覆盖 子节点的序列化，无论如何都不会造成问题。无论如何，这不起作用，因为在调用 IXmlSerialized 方法之前抛出异常。

4. 使用 typeof() 或类似方法连接常量命名空间以使其唯一是行不通的，因为命名空间必须是常量。

5. 默认的DataContractSerializer可以在名称中插入类型名称（如），但是DataContractSerializer的输出臃肿且不可读且缺少属性，这对于外部重用者来说是不可行的。

6. 扩展XmlRootAttribute 以不同方式生成命名空间。不幸的是，调用时没有可用的类型信息，只有通用的 ResponseContract 数据。可以生成随机命名空间来规避该问题，但动态更改架构会破坏 WSDL 元数据。

7. 将 ResponseContract 设为基类而不是包装器契约应该可行，但会导致大量重复的通用数据。例如，上例中的 和 也是合约，它们有自己的等效 > 和 元素。

结论

有什么想法吗？

Answer 1

我为此获得了风滚草徽章！

我放弃了所描述的方法，因为我找不到可行的解决方案。相反，每个合约都会从通用 BaseContract 继承可为 null 的 QueryStatus 属性。对于主合约，此属性会自动填充；对于子合约，此属性会自动填充为 null。