保持枚举到对象的映射与枚举类?(Keep enum-to-object mapping with e

2019-07-29 03:49发布

我经常需要一个枚举和另一个对象(在此实例中的字符串)之间的全局硬编码映射。 我想同定位的枚举和映射定义明确的维护。

正如你所看到的,在这个例子中,将创建一个静态字段一个恼人的类。

public enum EmailTemplates
{
    // Remember to edit the corresponding mapping singleton!
    WelcomeEmail,
    ConfirmEmail
}

public class KnownTemplates
{
    public static Dictionary<EmailTemplates, string> KnownTemplates;
    static KnownTemplates() {
        KnownTemplates.Add(EmailTemplates.WelcomeEmail, "File1.htm");
        KnownTemplates.Add(EmailTemplates.ConfirmEmail, "File2.htm");
    }
}

有时候,映射类可以有更多的功能和一个有意义的名称,并映射活动,甚至可以是私有的。 但是,这既污染了维护/相关问题。

任何人对此有一个很好的模式?

Answer 1:

您可以使用属性来标注枚举,然后使用反射来构建字典。

[AttributeUsage(AttributeTargets.Field)]
sealed class TemplateAttribute : Attribute {

  public TemplateAttribute(String fileName) {
    FileName = fileName;
  }

  public String FileName { get; set; }

}

enum EmailTemplate {

  [Template("File1.htm")]
  WelcomeEmail,

  [Template("File2.htm")]
  ConfirmEmail

}

class KnownTemplates {

  static Dictionary<EmailTemplate, String> knownTemplates;

  static KnownTemplates() {
    knownTemplates = typeof(EmailTemplates)
      .GetFields(BindingFlags.Static | BindingFlags.Public)
      .Where(fieldInfo => Attribute.IsDefined(fieldInfo, typeof(TemplateAttribute)))
      .Select(
        fieldInfo => new {
          Value = (EmailTemplate) fieldInfo.GetValue(null),
          Template = (TemplateAttribute) Attribute
            .GetCustomAttribute(fieldInfo, typeof(TemplateAttribute))
        }
      )
      .ToDictionary(x => x.Value, x => x.Template.FileName);
  }

}

如果你这样做了很多,你可以创建一个合并枚举值与该枚举值关联的属性更一般的通用功能:

static IEnumerable<Tuple<TEnum, TAttribute>> GetEnumAttributes<TEnum, TAttribute>()
  where TEnum : struct
  where TAttribute : Attribute {
  return typeof(TEnum)
    .GetFields(BindingFlags.Static | BindingFlags.Public)
    .Where(fieldInfo => Attribute.IsDefined(fieldInfo, typeof(TAttribute)))
    .Select(
      fieldInfo => Tuple.Create(
        (TEnum) fieldInfo.GetValue(null),
        (TAttribute) Attribute.GetCustomAttribute(fieldInfo, typeof(TAttribute))
      )
    );
}

并使用它像这样:

knownTemplates = GetEnumAttributes<EmailTemplate, TemplateAttribute>()
  .ToDictionary(tuple => tuple.Item1, tuple => tuple.Item2.FileName);

为了获得更大的乐趣,你可以创建一个扩展方法:

static class EmailTemplateExtensions {

  static Dictionary<EmailTemplate, String> templates;

  static EmailTemplateExtensions() {
    templates = GetEnumAttributes<EmailTemplate, TemplateAttribute>()
      .ToDictionary(tuple => tuple.Item1, tuple => tuple.Item2.FileName);
  }

  public static String FileName(this EmailTemplate emailTemplate) {
    String fileName;
    if (templates.TryGetValue(emailTemplate, out fileName))
      return fileName;
    throw new ArgumentException(
      String.Format("No template defined for EmailTemplate.{0}.", emailTemplate)
    );
  }

}

然后调用EmailTemplate.ConfirmEmail.FileName()将返回File2.htm



Answer 2:

通常情况下,当你想额外的信息或行为添加到您的枚举元素,这意味着你需要一个完全成熟的类代替。 您可以从(OLD-)的Java类型安全的枚举模式借鉴和创造的东西是这样的:

sealed class EmailTemplate {
  public static readonly EmailTemplate Welcome = new EmailTemplate("File1.html");
  public static readonly EmailTemplate Confirm = new EmailTemplate("File2.html");

  private EmailTemplate(string location) {
    Location = location;
  }
  public string Location { get; private set; }

  public string Render(Model data) { ... }
}

现在你可以给你的元素的任何属性或方法联系起来,比如LocationRender以上。



Answer 3:

这里是一个工作非常适合我的方法。

public class BaseErrWarn : Attribute
{
    public string Code { get; set; }
    public string Description { get; set; }

    public BaseErrWarn(string code, string description)
    {
        this.Code = code;
        this.Description = description;
    }
}

public enum ErrorCode
{
    [BaseErrWarn("ClientErrMissingOrEmptyField", "Field was missing or empty.")] ClientErrMissingOrEmptyField,
    [BaseErrWarn("ClientErrInvalidFieldValue", "Not a valid field value.")] ClientErrInvalidFieldValue,
    [BaseErrWarn("ClientErrMissingValue", "No value passed in.")] ClientErrMissingValue
}

现在你可以使用反射来枚举映射到BaseErrWarn类:

public static BaseErrWarn GetAttribute(Enum enumVal)
{
    return (BaseErrWarn)Attribute.GetCustomAttribute(ForValue(enumVal), typeof(BaseErrWarn));
}

private static MemberInfo ForValue(Enum errorEnum)
{
    return typeof(BaseErrWarn).GetField(Enum.GetName(typeof(BaseErrWarn), errorEnum));
}

下面是使用这种映射来枚举映射到对象,然后拉字段关闭它的例子:

    public BaseError(Enum errorCode)
    {
        BaseErrWarn baseError = GetAttribute(errorCode);
        this.Code = baseError.Code;
        this.Description = baseError.Description;
    }

    public BaseError(Enum errorCode, string fieldName)
    {
        BaseErrWarn baseError = GetAttribute(errorCode);
        this.Code = baseError.Code;
        this.Description = baseError.Description;
        this.FieldName = fieldName;
    }  


文章来源: Keep enum-to-object mapping with enum class?