c# - 使用 Description 属性装饰 EF 对象模型上的枚举？

Question

我在我的 Entity Framework 5 模型中定义了一个枚举，我用它来定义表上字段的类型，例如

public enum PrivacyLevel : byte {
  Public = 1,
  FriendsOnly = 2,
  Private = 3,
}

我有一张 table Publication有一个tinyint领域 PrivacyLevel ，我已将其映射到 EF 模型中以使用 PrivacyLevel上面定义的类型，使用描述的方法 here .

但我还希望能够显示每个枚举值的字符串描述。我过去通过使用 Description 属性装饰枚举来完成此操作，例如

public enum PrivacyLevel : byte {
  [Description("Visible to everyone")]
  Public = 1,
  [Description("Only friends can view")]
  FriendsOnly = 2,
  [Description("Only I can view")]
  Private = 3,
}

我有一些代码可以通过检查它们是否具有 Description 属性来将枚举转换为字符串，并且效果很好。但在这里，因为我必须在我的模型中定义枚举，底层代码是自动生成的，我没有任何稳定的地方来装饰它们。

有什么解决方法吗？

Answer 1

不确定这是否是您所追求的，但根据我的理解，我会尽可能清楚，因为您有一个具体的数据库优先方法，您可以使用 Dto 方法将大部分实体模型抽象为 ViewModel通过 AutoMapper。

使用自动映射器配置文件，您可以为各种环境和场景快速设置配置文件，以实现灵 active 和适应性

所以这是给我带来问题的“枚举”

这是我的这个枚举的 View 模型

首先这是我的布局

这里是 Account 实体到 Account View 模型的简单映射

public class AccountProfile : Profile
{
    protected override void Configure()
    {
        // Map from Entity object to a View Model we need or use
        // AutoMapper will automatically map any names that match it's conventions, ie properties from Entity to ViewModel have exact same name properties

        Mapper.CreateMap<Account, AccountViewModel>()
              .ForMember(model => model.CurrentPrivacy, opt => opt.MapFrom(account => (PrivacyLevelViewModel)account.PrivacyLevel));

        Mapper.CreateMap<Account, EditAccountViewModel>()
            .ForMember(model => model.SelectedPrivacyLevel, opt => opt.MapFrom(account => (PrivacyLevelViewModel) account.PrivacyLevel));

        // From our View Model Changes back to our entity

        Mapper.CreateMap<EditAccountViewModel, Account>()
              .ForMember(entity => entity.Id, opt => opt.Ignore()) // We dont change id's
              .ForMember(entity => entity.PrivacyLevel, opt => opt.MapFrom(viewModel => (PrivacyLevel)viewModel.NewSelectedPrivacyLevel));

    }


}

请注意，这不一定适用于 MVC，它可以用在 WPF 或其他不依赖于 Web 的应用程序中，但由于这是一种很好的解释方式，这就是我在此示例中使用 MVC 的原因。

当我第一次收到对我的个人资料的 Http Get 请求时，我从数据库中获取实体并将我实际需要的任何内容映射到 View

public ActionResult Index()
{
    // Retrieve account from db
    var account = new Account() { Id = 1, Name = "Patrick", AboutMe = "I'm just another dude", ProfilePictureUrl = "", PrivacyLevel = PrivacyLevel.Private, Friends = new Collection<Account>() };
    // ViewModel abstracts the Entities and ensures behavour that only matters to the UI
    var accountViewModel = Mapper.Map<AccountViewModel>(account);

    return View(accountViewModel); // strongly typed view model
}

所以我的个人资料索引 View 可以使用我的枚举 View 模型

这是输出

现在，当我想更改我的隐私设置时，我可以创建一个新的 EditAccountViewModel，它允许我在下拉列表中提交一个新值

public class EditAccountViewModel
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string AboutMe { get; set; }
    public int NewSelectedPrivacyLevel { get; set; }
    public PrivacyLevelViewModel SelectedPrivacyLevel { get; set; }

    public SelectList PrivacyLevels
    {
        get
        {
            var items = Enum.GetValues(typeof (PrivacyLevelViewModel))
                .Cast<PrivacyLevelViewModel>()
                .Select(viewModel => new PrivacyLevelSelectItemViewModel()
                {
                    Text = viewModel.DescriptionAttr(),
                    Value = (int)viewModel,
                });

            //SelectPrivacyLevel was mapped by AutoMapper in the profile from 
            //original entity value to this viewmodel
            return new SelectList(items, "Value", "Text", (int) SelectedPrivacyLevel);
        }
    }
}

现在，一旦我发送了我的新更改值的帖子，有趣的部分是我如何使用更新的隐私设置修改数据库中的“真实”实体

在将表单提交回我的编辑操作时，您可以获得原始的真实数据库实体，然后如果 ViewModel 状态有效则合并更改

AutoMapper 允许您配置如何将 ViewModel 映射到实体，如果某些属性应该更改，从整数实体到 View 模型的字符串值，也许你想让枚举在“ View ”中真正成为一个字符串，并且只是数据库的枚举，使用自动映射器，它允许您配置所有这些场景，并通过约定如果您的 View 模型具有相同的属性，则无需配置“每个属性”属性名称/驼峰式到大写。

最后，在使用这些配置文件之前，您必须在应用程序入口点加载它们，例如 global.asax 或 Main。

AutoMapper 只需“配置”一次即可加载应用程序中定义的任何类型的配置文件。通过一些思考，您可以使用以下代码将所有配置文件加载到程序集中:

public class AutoMapperConfig
{
    public static void RegisterConfig()
    {
        Mapper.Initialize(config => GetConfiguration(Mapper.Configuration));
    }

    private static void GetConfiguration(IConfiguration configuration)
    {
        configuration.AllowNullDestinationValues = true;
        configuration.AllowNullCollections = true;

        IEnumerable<Type> profiles = Assembly.GetExecutingAssembly().GetTypes().Where(type => typeof(Profile).IsAssignableFrom(type));

        foreach (var profile in profiles)
        {
            configuration.AddProfile(Activator.CreateInstance(profile) as Profile);
        }
    }
}

我在我的 global.asax 中调用配置:

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();

    WebApiConfig.Register(GlobalConfiguration.Configuration);
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    AutoMapperConfig.RegisterConfig(); // AutoMapperConfig.cs
}

有关如何使用 AutoMapper 以及它如何使您受益的更多信息，请访问这里:

AutoMapper Github