如何向 WCF 客户端公开枚举属性

Question

我想向 WCF 客户端应用程序公开枚举属性，但我只能看到枚举值。

这是枚举：

public enum TemplateType
{
    [EnumDescription("Property Particulars")]
    [EnumValue("PropertyParticulars")]        
    PropertyParticulars = 1,

    [EnumDescription("Short Format Lists")]
    [EnumValue("ShortFormatLists")]        
    ShortFormatLists,

    [EnumDescription("Client Letters")]
    [EnumValue("ClientLetters")]
    ClientLetters,

    [EnumDescription("Labels")]
    [EnumValue("Labels")]
    Labels
}

如何公开描述和值属性？

Answer 1

您可以从服务公开枚举，但枚举上的属性在通过线路发送时不会被序列化。这意味着该枚举的使用者只能看到枚举本身，而看不到您的任何属性。

您需要做的是使用 DataContract 属性来装饰您的枚举，并使用 EnumMember 属性，以便序列化您的信息，但这仅允许您指定基础值 每个枚举值，而不是描述。

Answer 2

如果打算公开枚举成员的显示文本，则有一个解决方法，可以在合约中以这种方式定义枚举：

public enum EPaymentCycle
{
    [EnumMember(Value = "Month by Month")]
    Monthly,

    [EnumMember(Value = "Week by Week")]
    Weekly,

    [EnumMember(Value = "Hour by Hour")]
    Hours
}

SvcUtils 序列化会产生一个有趣的结果：

public enum EPaymentCycle : int
{

    [System.Runtime.Serialization.EnumMemberAttribute(Value="Month by Month")]
    MonthByMonth= 0,

    [System.Runtime.Serialization.EnumMemberAttribute(Value="Week by Week")]
    WeekbyWeek= 1,

    [System.Runtime.Serialization.EnumMemberAttribute(Value="Hour by Hour")]
    HourbyHour = 2
}

您可以通过反射读取 EnumMemberAttribute 值，然后就得到了它。 svcutil 序列化生成的 xsd 元数据文件也符合预期：

<xs:simpleType name="EPaymentCycle">
<xs:restriction base="xs:string">
  <xs:enumeration value="Month by Month" />
  <xs:enumeration value="Week by Week" />
  <xs:enumeration value="Hour by Hour" />
</xs:restriction>

Answer 3

我并不完全熟悉规范，但我怀疑这种元数据在 WSDL 中是否有等效的表示形式。因此，如果您在代理中生成类型，这在客户端将不可见。

但是，如果将所有 DataContract 放在客户端中引用的单独程序集中，则可以在客户端重用这些类型。在这种情况下，属性将是可见的。需要为您的服务引用检查“引用程序集中的重用类型”，但默认情况下此选项处于启用状态。

这里有一篇关于它的简短博客文章。我确信还有其他人...

Answer 4

交通灯值的枚举示例...

[DataContract]
public enum TrafficLightType
{
    [EnumMember]
    Red,

    [EnumMember]
    Green,

    [EnumMember]
    Amber
}