将枚举转换为字符串

Question

在 .NET 3.5 中将枚举转换为字符串的首选方法是什么？

• Enum.GetName
• 枚举格式
• ToString

为什么我应该更喜欢其中一个而不是其他？一个表现更好吗？

Answer 1

从 C#6 开始，获取枚举名称的最佳方法是新的 nameof 运算符：

nameof(MyEnum.EnumValue);

// Ouputs
> "EnumValue"

这在编译时有效，枚举被编译结果中的字符串替换，这反过来意味着这是最快的方式。

如果您认为枚举名称的混淆是值得或重要的，那么任何枚举名称的使用都会干扰代码混淆 - 这可能是另一个问题。

Answer 2

适用于我们的项目...

public static String convertToString(this Enum eff)
{
    return Enum.GetName(eff.GetType(), eff);
}

public static EnumType converToEnum<EnumType>(this String enumValue)  
{
    return (EnumType) Enum.Parse(typeof(EnumType), enumValue);
}

Answer 3

在我的测试中，Enum.GetName 速度更快，而且幅度也不错。在内部ToString 调用Enum.GetName。 From source .NET 4.0，要点：

public override String ToString()
{
     return Enum.InternalFormat((RuntimeType)GetType(), GetValue());
}

private static String InternalFormat(RuntimeType eT, Object value)
{
    if (!eT.IsDefined(typeof(System.FlagsAttribute), false))
    {
        String retval = GetName(eT, value); //<== the one
        if (retval == null)
            return value.ToString();
        else
            return retval;
    }
    else
    {
        return InternalFlagsFormat(eT, value);
    }
}

我不能说这是肯定的原因，但测试状态一个比另一个更快。这两个调用都涉及装箱（实际上它们是反射调用，您实际上是在检索字段名称）并且可能会根据您的喜好缓慢。

测试设置：有 8 个值的枚举，没有。迭代次数 = 1000000

结果：Enum.GetName => 700 毫秒，ToString => 2000 毫秒

如果速度不明显，我不会在意并使用ToString，因为它提供了更清晰的通话。对比

Enum.GetName(typeof(Bla), value)

与

value.ToString()

Answer 4

Enum.GetName(...)

这是最优雅的方法。

var enumValueString = Enum.GetName(typeof (MyEnum), MyEnum.MyValue);

虽然我没有看到调用 .ToString() 的任何问题，因为它更短。

var enumValueString = MyEnum.MyValue.ToString();

---

您可以使用新的 C# 6 语法：

nameof(MyEnum.MyValue)

Answer 5

所有这些在内部最终都会调用一个名为InternalGetValueAsString 的方法。 ToString 和 GetName 之间的区别在于 GetName 必须先验证几件事：

1. 您输入的类型不为空。
2. 您输入的类型实际上是一个枚举。
3. 您传入的值不为空。
4. 您传入的值是枚举可以实际用作其基础类型的类型，或者是枚举本身的类型。它在值上使用GetType 来检查这一点。

.ToString 不必担心上述任何问题，因为它是在类本身的实例上调用的，而不是在传入的版本上，因此，由于.ToString方法没有与静态方法相同的验证问题，我认为.ToString 是获取字符串值的最快方法。

Answer 6

我能找到的最好的是this unrelated question on MSDN，它包含一个回答这个问题的 XML sn-p。这些方法中的任何一个都有相同的缺陷：它们调用enum.toString()，在使用Dotfuscation 时无法正常工作。其他问题似乎与间接装箱（GetName 和 Format）有关。不幸的是，我找不到使用上述任何方法的任何性能原因。

转述自xml snippet，

将装箱的枚举传递给 string.Format() 或任何其他函数可能会导致调用 enum.ToString()。 这会在 Dotfuscating 时引起问题。您不应使用enum.ToString()、enum.GetNames()、enum.GetName()、enum.Format() 或enum.Parse() 将枚举转换为字符串。相反，请使用 switch 语句，并在必要时将名称国际化。

Answer 7

Enum.GetName()

Format() 实际上只是对GetName() 的封装，带有一些格式化功能（或者准确地说是InternalGetValueAsString()）。 ToString() 与 Format() 几乎相同。我认为GetName() 是最好的选择，因为它对任何阅读源代码的人来说都是显而易见的。

Answer 8

我创建了一个“描述”扩展方法并将其附加到枚举，以便我可以获得真正用户友好的命名，包括空格和大小写。我从来不喜欢将枚举值本身用作可显示的文本，因为我们开发人员使用它来创建更具可读性的代码。它不适用于 UI 显示目的。我希望能够更改 UI 而无需遍历和更改枚举。

Answer 9

我不知道“首选”方法是什么（询问 100 个人并获得 100 种不同的意见），但做最简单且有效的方法。 GetName 有效，但需要更多的击键。 ToString() 似乎做得很好。

Answer 10

对于 VB 爱好者：

EnumStringValue = System.Enum.GetName(GetType(MyEnum), MyEnumValue)

Answer 11

这也可以。

    List<string> names = Enum.GetNames(typeof(MyEnum)).ToList();

Answer 12

对我来说，将 Enum 转换为 String 的最简单方法是：

// Sample for Enum.ToString(String)
using System;

class Sample
{
    enum Colors {Red, Yellow = 12};

    public static void Main()
    {
    Colors myColor = Colors.Yellow;

    Console.WriteLine("Colors.Red = {0}", Colors.Red.ToString("d"));
    Console.WriteLine("Colors.Yellow = {0}", Colors.Yellow.ToString("d"));

    Console.WriteLine("{0}myColor = Colors.Yellow{0}", Environment.NewLine);

    Console.WriteLine("myColor.ToString(\"g\") = {0}", myColor.ToString("g"));
    Console.WriteLine("myColor.ToString(\"G\") = {0}", myColor.ToString("G"));

    Console.WriteLine("myColor.ToString(\"x\") = {0}", myColor.ToString("x"));
    Console.WriteLine("myColor.ToString(\"X\") = {0}", myColor.ToString("X"));

    Console.WriteLine("myColor.ToString(\"d\") = {0}", myColor.ToString("d"));
    Console.WriteLine("myColor.ToString(\"D\") = {0}", myColor.ToString("D"));

    Console.WriteLine("myColor.ToString(\"f\") = {0}", myColor.ToString("f"));
    Console.WriteLine("myColor.ToString(\"F\") = {0}", myColor.ToString("F"));
    }
}
/*
This example produces the following results:
Colors.Red = 0
Colors.Yellow = 12

myColor = Colors.Yellow

myColor.ToString("g") = Yellow
myColor.ToString("G") = Yellow
myColor.ToString("x") = 0000000C
myColor.ToString("X") = 0000000C
myColor.ToString("d") = 12
myColor.ToString("D") = 12
myColor.ToString("f") = Yellow
myColor.ToString("F") = Yellow
*/ 

现在要将所选字符串转换回 Enum，您只需 Parse 它：

var myYellowEnum = Enum.Parse(typeof (Colors), "Yellow"); // Returns Yellow

Answer 13

有了新的 Roslyn 警告，这个问题让我开始思考。我的研究使我找到了 2 个图书馆。两者都显示出比内置 .NET 5 方法 ToString、GetName 等更好的性能。看看基准测试：

Enums.NET

FastEnum

Answer 14

ToString() 从可读性的角度给出了最明显的结果，而使用Enum.GetName() 需要更多的心理分析才能快速理解它试图做什么（除非你看到所有的模式时间）。

从纯粹的性能角度来看，正如@nawfal 的回答中已经提供的那样，Enum.GetName() 更好。

如果性能确实是您的目标，那么最好提前提供查找（使用字典或其他映射）。

在 C++/CLI 中，这看起来像

Dictionary<String^, MyEnum> mapping;
for each (MyEnum field in Enum::GetValues(MyEnum::typeid))
{
    mapping.Add(Enum::GetName(MyEnum::typeid), field);
}

使用 100 个项目和 1000000 次迭代的枚举进行比较：

Enum.GetName：~800ms
.ToString(): ~1600ms
字典映射：~250ms

Answer 15

简单：将名称枚举到列表中：

List<String> NameList = Enum.GetNames(typeof(YourEnumName)).Cast<string>().ToList()