为什么在 .NET 5 中指定循环枚举值时枚举的顺序很重要？

Question

我正在使用枚举循环引用将一些现有枚举归结为更少的值。 它适用于我的问题，因为它适用于过渡时期，在历史中确实会出现旧的枚举值，但不会创建具有过时值的新条目。

我不是在寻找替代方法，但我偶然发现了这个奇怪的问题，其中枚举的顺序会以意想不到的方式影响序列化值。

我有这个枚举：

    public enum CivilStatusEnum
    {
        None = 0,
        Married = 1,
        Cohabiting = Married,
        Alone = 3,
        DivorcedOrSeparated = Alone,
        WidowOrWidower = Alone,
    }

我指定了“DivorcedOrSeparated”= 单独 (3)。现在，当我将枚举转换为字符串时，我得到值“DivorcedOrSeparated”。

Console.PrintLine(CivilStatusEnum.Alone.ToString());

输出：

DivorcedOrSeparated

我有一个示例代码，其中包含测试及其预期结果。如您所见，测试失败。但是如果我改变枚举的顺序，测试就会解析。

    [Theory]
    [InlineData(CivilStatusEnum.Alone, "Alone")]
    [InlineData(CivilStatusEnum.DivorcedOrSeparated, "Alone")]
    [InlineData(CivilStatusEnum.WidowOrWidower, "Alone")]
    [InlineData(CivilStatusEnum.None, "None")]
    [InlineData(CivilStatusEnum.Married, "Married")]
    [InlineData(CivilStatusEnum.Cohabiting, "Married")]
    public void Test(CivilStatusEnum input, string expected)
    {
        var text = input.ToString();
        text.Should().Be(expected);
    }

我似乎无法找到一个合理的解释来解释为什么顺序对 tostring 和 serilization 很重要。

这是 .NET 5 中的错误，还是我遗漏了什么？ 如果这种行为是故意的，它如何确定哪个枚举名称将是 tostring 的输出？

谢谢你:)

Answer 1

Enum.ToString 执行二分查找。

确实，ToString 调用InternalFormat，后者调用GetEnumName。该方法在 EnumInfo.Values 返回的数组中执行二进制搜索。

我假设数组是按照底层值的递增顺序填充的（否则二进制搜索将不起作用），并且如果它们相等，则按照在源代码中声明值的顺序填充。这使得搜索结果依赖于声明的顺序。

为了说明这种二分搜索的效果，请考虑以下两个enum 定义：

enum Test1 { A = 0, B = 0, C = 0 }
enum Test2 { A = 0, B = 0, C = 0, D = 0, E = 0 }

Test1.A.ToString() 的结果是什么？注意Test1.A 的值为0。二分查找将首先考虑列表中间的元素，即B，其值为0。该值等于我们正在搜索的值，因此Test1.A.ToString() 返回"B"。如果找到的值高于正在搜索的值，则搜索将在列表的下半部分继续。如果找到的值低于正在搜索的值，则搜索将在列表的上半部分继续。

枚举中的所有常量也是如此，因为它们都具有相同的值。因此，Test1.C.ToString() 将同样返回 "B"。

同样，Test2.A.ToString() 返回 "C"，正如预期的那样。

但是请注意，虽然这种行为在当前版本的 .NET 中似乎是可预测的，但它是未定义的，并且可能会在未来的版本中发生变化。

这不是 .NET 5 中的错误。毕竟，以下两种情况都不可能成立：

CivilStatusEnum.Alone.ToString() ==  "Alone"
CivilStatusEnum.DivorcedOrSeparated.ToString() == "DivorcedOrSeparated"

原因当然是CivilStatusEnum.Alone == CivilStatusEnum.DivorcedOrSeparated。

以下是the documentation 对此的评价：

如果多个枚举成员具有相同的基础值，并且您尝试根据其基础值检索枚举成员名称的字符串表示形式，则您的代码不应对该方法将返回哪个名称做出任何假设。

Answer 2

我知道你说过你不是在寻找替代方法，但另一种方法是使用标志来避免这种问题：

[Flags]
public enum CivilStatusEnum
{
    None = 0,
    Married = 1,
    Cohabiting = 3, //Married | 2
    Alone = 4,
    DivorcedOrSeparated = 12, //Alone | 8
    WidowOrWidower = 20, //Alone | 16
}

然后ToString 将产生正确的答案，您可以使用以下代码检查某人是否已婚或单身：

bool IsMarried(CivilStatusEnum e){
    return ((int)e&1) == 1;
}

bool IsAlone(CivilStatusEnum e){
    return ((int)e&4) == 4;
}