WCF 版本控制枚举

Question

我正在开始编写一些需要向前兼容和兼容的 WCF 数据协定。可版本化。我一直在此处阅读MSDN文章，想知道是否有人对有关枚举的第 14 点进行了澄清。内容如下：

14. 您不应在版本之间添加或删除枚举成员。您也不应该重命名枚举成员，除非您使用 EnumMemberAttribute 属性上的 Name 属性来使它们在数据协定模型中的名称保持相同。

读到这里，我的意思是，一旦枚举被发布（并被客户端使用），你就不能在不破坏兼容性的情况下以任何方式修改它（主要是添加/删除）？ （即这将是一个重大变化）

有人可以证实这一点吗？

Answer 1

我建议不要通过 WCF 接口发送枚举。假设您有以下枚举：

[DataContract]
public enum WeekdayEnum
{
    [EnumMember]
    Monday = 0
}

如果您通过 WCF 返回枚举，则一切都会正常工作：

[ServiceContract]
public class Service1
{
    [OperationContract]
    public List<WeekdayEnum> GetWeekdays()
    {
        return new List<WeekdayEnum> { WeekdayEnum.Monday };
    }
}

添加到枚举而不更新客户端中的服务引用，您仍然没问题：

[DataContract]
public enum WeekdayEnum
{
    [EnumMember]
    Monday = 0,
    [EnumMember]
    Tuesday = 1
}

但是，如果您从服务返回附加值如果不更新客户端服务引用，旧客户端将会崩溃：

[ServiceContract]
public class Service1
{
    [OperationContract]
    public List<WeekdayEnum> GetWeekdays()
    {   // NetDispatcherFaultException on legacy clients that only have Monday
        return new List<WeekdayEnum> { WeekdayEnum.Monday, WeekdayEnum.Tuesday };
    }
}

在支持旧客户端非常重要的项目中，我遇到过这样的问题。解决方案是简单地通过 WCF 发送 DTO，而不是枚举。例如，WeekdayEnum 可以通过通过简单的 DTO 发送值来替换：

[DataContract]
public class WeekdayDto
{
    [DataMember]
    public int Id { get; set; }

    [DataMember]
    public string Name { get; set; }
}

这样，您的旧客户就会保持满意。

Answer 2

我可以确认，只要您在与服务通信时不使用新值，就可以添加到已发布的枚举而不破坏兼容性。但请注意，如果您实际尝试将类发送到使用新枚举值的服务，您将收到 System.ServiceModel.CommunicationException。

There was an error while trying to serialize parameter myType. The InnerException message was 'Enum value 'x' is invalid for type 'myType' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.'.  Please see InnerException for more details.