WCF Data Contract之枚举
WCF Data Contract之枚举
LazyBee
1 枚举被定义成总是可以序列化的，所以你定义新的枚举类型时，不需要应用DataContract就可以在数据契约中自由使用，同时你可以通过应用NonSerializedAttributed来排除不希望被序列化的枚举成员，这种枚举我们称之为简单枚举，例如：
public enum CarCondition
{
New,
Used,
Rental,
[NonSerialized]
Lost
}
如果使用SVCUtil为客户端导出的对应的枚举定义中将会使用DataContract和EnumMember来替代,如下所示：
[System.CodeDom.Compiler.GeneratedCodeAttribute("System.Runtime.Serialization", "
[System.Runtime.Serialization.DataContractAttribute(Name="CarCondition", Namespace="…")]
public enum CarCondition : int
{
[System.Runtime.Serialization.EnumMemberAttribute()]
New = 0,
[System.Runtime.Serialization.EnumMemberAttribute()]
Used = 1,
[System.Runtime.Serialization.EnumMemberAttribute()]
Rental = 2,
}
2 如果你需要定制枚举的数据契约名称、命名空间、枚举成员的名称的话，你就需要使用DataContract和EnumMember两个属性。使用EnumMemberAttribute的Value属性来定制枚举成员的名称。如果采用数据契约模型（应用DataContract）的枚举中，只有应用了EnumMember的枚举成员才会被序列化（也就是会包含在数据契约中）。
注意：如果我们在一个服务操作（应用了OperationContractAttribute属性）中增加了一个枚举类型的参数，而且这个枚举类型应用了DataContractAttribute属性，但对其中的枚举成员没有应用EnumMemberAttribute属性，在使用SVCUtil产生代理的时候将会出现让人范晕的代理代码：例如我们有如下操作定义以及枚举定义：
[OperationContract]
void TestSimpleEnum2(SimpleFlagEnum e);
[DataContract]
public enum SimpleFlagEnum
{
New = 2,
Used = 4,
Rental = 8,
Lost = 16
}
在使用SVCUtil产生代理时，你将能看到都变成了采用XML序列化格式了，而且枚举也变成了string了，当然如果你服务端的契约定义不同，也有可能变成MessageContract并且带有// CODEGEN: Generating message contract since element name e from namespace http://tempuri.org/ is not marked nillable消息提示在产生的文件中。
[System.ServiceModel.XmlSerializerFormatAttribute()]
void TestSimpleEnum2(string e);
针对这种情况，你可以通过去掉枚举的DataContract属性或者给枚举成员增加EnumMember属性来解决。只有你在需要只发布部分枚举成员的时候才需要使用DataContractAttribute和EnumMemberAttribute属性，否则就采用缺省的契约（不应用任何属性）来包含全部枚举成员，当然缺省的契约和对枚举类型应用DataContract属性以及对其所有成员应用EnumMember属性是等价的。
3通常数据契约包括的是枚举成员名称，而不是其数值。 但是，如果使用数据契约模型并且接收端为 WCF 客户端，则导出的架构会保留数值。
4 是否应用SerializableAttribute对简单枚举来说将没有任何影响。
5 对简单枚举的枚举成员应用EnumMemberAttribute属性时，该属性将不起作用。对使用数据契约模型的枚举应用NonSerializedAttribute属性也将不起作用。
6 对枚举可能需要使用按位操作，所以我们可以给枚举使用标志属性FlagsAttribute. 在这种情况下，可以同时发送或接收包含零个或多个枚举值的列表。
为此，请将 DataContractAttribute 属性应用于标志枚举，然后使用 EnumMemberAttribute 属性对所有为 2 的幂的成员进行标记。 请注意，若要使用标志枚举，级数必须为不间断的 2 的幂的序列（例如，1、2、4、8、16、32、64）。
可以使用下面的步骤来发送标志的枚举值：
1. 尝试查找映射到数值的枚举成员（应用了 EnumMemberAttribute 属性）。 如果可以找到，就发送仅包含该成员的列表。
2. 尝试将此数值分解为和的形式，以便枚举成员（每个成员都应用了 EnumMemberAttribute 属性）可以映射到和的各部分。 发送包含所有这些成员的列表。 请注意，“贪婪算法”用于查找这样的和，因此即使它存在，也不能保证可以找到。 为避免出现这种问题，请确保枚举成员的数值为 2 的幂。
3. 如果上面的两个步骤均无法实现并且数值为非零，则引发一个 SerializationException。 如果数值为零，则发送空列表。
例如：
[DataContract][Flags]
public enum CarFeatures
{
None = 0,
[EnumMember]
AirConditioner = 1,
[EnumMember]
AutomaticTransmission = 2,
[EnumMember]
PowerDoors = 4,
AlloyWheels = 8,
DeluxePackage = AirConditioner | AutomaticTransmission | PowerDoors | AlloyWheels,
[EnumMember]
CDPlayer = 16,
[EnumMember]
TapePlayer = 32,
MusicPackage = CDPlayer | TapePlayer,
[EnumMember]
Everything = DeluxePackage | MusicPackage
}
下面的示例值将按照规则进行序列化：
CarFeatures cf1 = CarFeatures.AutomaticTransmission;
//序列化为 <cf1>AutomaticTransmission</cf1>
CarFeatures cf2 = (CarFeatures)5;
//序列化为<cf2>AirConditioner PowerDoors</cf2>因为 5=1+4
CarFeatures cf3 = CarFeatures.MusicPackage;
//序列化为<cf3>CDPlayer TapePlayer</cf3>因为MusicPackage没有应用EnumMember
CarFeatures cf4 = CarFeatures.Everything;
//序列化为<cf4>Everything</cf4>因为Everything应用了EnumMember属性
CarFeatures cf5 = CarFeatures.DeluxePackage;
//抛出SerializationException异常，因为DeluxePackage和AlloyWheels都没有应用 //EnumMembers属性
CarFeatures cf6 = CarFeatures.None;
//序列化为空列表<cf6></cf6>因为没有一个EnumMember的值为0
7 不管是简单枚举还是使用数据契约模型的枚举，都不需要增加KnowType,当然也不需要使用ServiceKnowType.
