如何将枚举值传递给 Web 服务

Question

我的困境基本上是如何在两个应用程序之间共享枚举。

用户通过 Web 上的前端应用程序上传文档。 此应用程序调用后端应用程序的 Web 服务并将文档传递给它。 后端应用程序保存文档并在文档表中插入一行。

文档类型（7 种可能的文档类型：发票、合同等）作为参数传递给 Web 服务的UploadDocument方法。 问题是，这个参数的类型（和可能的值）应该是什么？

由于您需要在两个应用程序中对这些值进行硬编码，我认为可以使用描述性字符串（ Invoice 、 Contract 、 WorkOrder 、 SignedWorkOrder ）。

在第一个应用程序中创建一个DocumentTypes枚举，并在第二个应用程序中重现它，然后将相应的整数值传递给它们之间的 Web 服务，这可能是一种更好的方法吗？

Answer 1

我建议不要在它们之间传递一个整数，只是为了可读性和调试的目的。 假设您正在查看您的日志，并且您看到 DocumentType=4 的一堆 500 错误。 现在您必须查找哪个 DocumentType 是 4。或者如果其中一个应用程序引用另一个应用程序中不存在的数字，可能是由于版本不匹配。

这是一个多一点的代码，它让大脑的静态类型部分有点粗糙，但是在 HTTP 之上的协议中，收到的智慧是在不透明的枚举上支持清晰的字符串。

Answer 2

我仍然会在内部使用枚举，但希望消费者只传递名称，而不是数值本身。

只是一些愚蠢的例子来说明：

public enum DocumentType
{
  Invoice,
  Contract,
  WorkOrder,
  SignedWorkOrder
}

[WebMethod]
public void UploadDocument(string type, byte[] data)
{
  DocumentType docType = (DocumentType)Enum.Parse(typeof(DocumentType), type);
}

Answer 3

我只能说 .net，但如果你有一个 ASP.net Webservice，你应该能够直接向它添加一个枚举。

当您在客户端应用程序中使用“添加 Web 引用”时，生成的类应包含该枚举

但这是从我的头顶，我很确定我过去做过，但我不能肯定地说。

Answer 4

在 .NET 中，枚举值（默认情况下）使用名称序列化为 xml。 对于可以有多个值（ flags ）的实例，它会在值之间放置一个空格。 这是有效的，因为枚举不包含空格，因此您可以通过拆分字符串再次获取值（即“发票合同 SignedWorkOrder”，使用 lubos 的示例）。

您可以使用XmlEnumAttribute或在使用 WCF 时使用EnumMember属性来控制 asp.net Web 服务中的值的序列化。

Answer 5

如果您从 .NET 页面/应用程序使用您的 Web 服务，则在您将您的 Web 引用添加到使用该服务的项目之后，您应该能够访问枚举。

Answer 6

如果您不使用 .NET 到 .NET SOAP，您仍然可以定义一个枚举器，前提是两个端点都使用 WSDL。

<s:simpleType name="MyEnum">    
     <s:restriction base="s:string">
          <s:enumeration value="Wow"/>
          <s:enumeration value="This"/>
          <s:enumeration value="Is"/>
          <s:enumeration value="Really"/>
          <s:enumeration value="Simple"/>
     </s:restriction>
</s:simpleType>

它取决于 WSDL -> 代理生成器工具将其解析为客户端语言中的枚举等效项。

Answer 7

在这样的接口边界上不使用enum有一些很好的理由。 考虑一下Dare关于这个主题的帖子。

Answer 8

我注意到，当使用“添加服务引用”而不是来自 VS.net 的“添加 Web 引用”时，会遇到实际的枚举值以及枚举名称。 这真的很烦人，因为我需要同时支持 2.0 和 3.5 客户端。 我最终不得不进入 2.0 生成的 Web 服务代理代码并在每次进行更改时手动添加枚举值！