协慌网

登录 贡献 社区

枚举的字符串表示形式

我有以下枚举:

public enum AuthenticationMethod
{
    FORMS = 1,
    WINDOWSAUTHENTICATION = 2,
    SINGLESIGNON = 3
}

然而问题是,当我要求 AuthenticationMethod.FORMS 而不是 id 1 时,我需要 “FORMS” 这个词。

我找到了以下解决此问题的方法( 链接 ):

首先,我需要创建一个名为 “StringValue” 的自定义属性:

public class StringValue : System.Attribute
{
    private readonly string _value;

    public StringValue(string value)
    {
        _value = value;
    }

    public string Value
    {
        get { return _value; }
    }

}

然后我可以将此属性添加到我的枚举器:

public enum AuthenticationMethod
{
    [StringValue("FORMS")]
    FORMS = 1,
    [StringValue("WINDOWS")]
    WINDOWSAUTHENTICATION = 2,
    [StringValue("SSO")]
    SINGLESIGNON = 3
}

当然我需要一些东西来检索 StringValue:

public static class StringEnum
{
    public static string GetStringValue(Enum value)
    {
        string output = null;
        Type type = value.GetType();

        //Check first in our cached results...

        //Look for our 'StringValueAttribute' 

        //in the field's custom attributes

        FieldInfo fi = type.GetField(value.ToString());
        StringValue[] attrs =
           fi.GetCustomAttributes(typeof(StringValue),
                                   false) as StringValue[];
        if (attrs.Length > 0)
        {
            output = attrs[0].Value;
        }

        return output;
    }
}

好现在我有了获取枚举器字符串值的工具。我可以这样使用它:

string valueOfAuthenticationMethod = StringEnum.GetStringValue(AuthenticationMethod.FORMS);

好的,现在所有这些都像魅力一样,但我发现它做了很多工作。我想知道是否有更好的解决方案。

我也尝试过使用字典和静态属性的东西,但这也不是更好。

答案

尝试type-safe-enum模式。

public sealed class AuthenticationMethod {

    private readonly String name;
    private readonly int value;

    public static readonly AuthenticationMethod FORMS = new AuthenticationMethod (1, "FORMS");
    public static readonly AuthenticationMethod WINDOWSAUTHENTICATION = new AuthenticationMethod (2, "WINDOWS");
    public static readonly AuthenticationMethod SINGLESIGNON = new AuthenticationMethod (3, "SSN");        

    private AuthenticationMethod(int value, String name){
        this.name = name;
        this.value = value;
    }

    public override String ToString(){
        return name;
    }

}

更新显式(或隐式)类型转换可以通过

  • 添加带映射的静态字段

    private static readonly Dictionary<string, AuthenticationMethod> instance = new Dictionary<string,AuthenticationMethod>();
    • nb 为了在调用实例构造函数时初始化 “枚举成员” 字段不会抛出 NullReferenceException,请确保将 Dictionary 字段放在类中的 “枚举成员” 字段之前。这是因为静态字段初始化程序是按声明顺序调用的,并且在静态构造函数之前,创建了奇怪且必要但令人困惑的情况,即在初始化所有静态字段之前,以及在调用静态构造函数之前,可以调用实例构造函数。
  • 在实例构造函数中填充此映射

    instance[name] = this;
  • 并添加用户定义的类型转换运算符

    public static explicit operator AuthenticationMethod(string str)
    {
        AuthenticationMethod result;
        if (instance.TryGetValue(str, out result))
            return result;
        else
            throw new InvalidCastException();
    }

使用方法

Enum.GetName(Type MyEnumType,  object enumvariable)

如(假设Shipper是定义的枚举)

Shipper x = Shipper.FederalExpress;
string s = Enum.GetName(typeof(Shipper), x);

Enum 类还有很多其他静态方法值得研究......

您可以使用 ToString()引用名称而不是值

Console.WriteLine("Auth method: {0}", AuthenticationMethod.Forms.ToString());

文档在这里:

http://msdn.microsoft.com/en-us/library/16c1xs4z.aspx

... 如果你在 Pascal Case 中命名你的枚举(正如我所做的那样 - 例如 ThisIsMyEnumValue = 1 等),那么你可以使用一个非常简单的正则表达式来打印友好的形式:

static string ToFriendlyCase(this string EnumString)
{
    return Regex.Replace(EnumString, "(?!^)([A-Z])", " $1");
}

可以从任何字符串轻松调用:

Console.WriteLine("ConvertMyCrazyPascalCaseSentenceToFriendlyCase".ToFriendlyCase());

输出:

将我疯狂的帕斯卡案句转换为友好案例

这样可以节省在房屋周围的运行,创建自定义属性并将它们附加到您的枚举或使用查找表将枚举值与友好字符串结合,最重要的是它自我管理,并且可以在任何 Pascal Case 字符串上无限使用更可重复使用。当然,它不允许您使用与您的解决方案提供的枚举不同的友好名称。

虽然对于更复杂的场景,我确实喜欢你原来的解决方案。您可以更进一步地使用您的解决方案并使您的 GetStringValue 成为枚举的扩展方法,然后您不需要像 StringEnum.GetStringValue 那样引用它...

public static string GetStringValue(this AuthenticationMethod value)
{
  string output = null;
  Type type = value.GetType();
  FieldInfo fi = type.GetField(value.ToString());
  StringValue[] attrs = fi.GetCustomAttributes(typeof(StringValue), false) as StringValue[];
  if (attrs.Length > 0)
    output = attrs[0].Value;
  return output;
}

然后,您可以直接从枚举实例中轻松访问它:

Console.WriteLine(AuthenticationMethod.SSO.GetStringValue());