在EF core 使用枚举类型

waitaction

已于 2024-05-08 15:22:10 修改

阅读量4.2k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： dotnet core 文章标签： .net

于 2019-03-18 15:00:35 首次发布

本文链接：https://blog.youkuaiyun.com/waitaction/article/details/88639152

dotnet core 专栏收录该内容

1 篇文章

订阅专栏

博客介绍了在EntityFramework Core中使用枚举的方法。因EF Core实体不直接支持枚举操作，以MsgInfo实体为例，原本字段SendState被生成int类型，不能修改为枚举。可新增枚举字段SendStateEnum，添加相关标记，操作时用其代替SendState，还提到旧方法已过时，可参考新文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在EntityFramework Core中的实体是不直接支持枚举类型的操作，这让我们在开发过程中带来不少的麻烦，下面总结一下在ef core中使用枚举的方法.

例如下面的MsgInfo实体，对应着数据库表MsgInfo，其中字段SendState发送状态在业务逻辑上有发送成功和发送失败两种枚举状态。但ef把它生成了int类型，而不是枚举，当然也不能修改成枚举，这样会导致ef写入和读取数据异常。

原来的实体

    public partial class MsgInfo
    {
        public string Id { get; set; }
        public string UserAddress { get; set; }
        public string Content { get; set; }
        public int SendState { get; set; }
    }

这里新增一个字段SendStateEnum设置为枚举类型，并使用 [NotMapped] 为不映射到数据库，为了防止输出HTTP时被序列化，也可以添加 [Newtonsoft.Json.JsonIgnore] 标记

需添加Nuget包Newtonsoft.Json

修改完的实体代码如下

修改实体

    public partial class MsgInfo
    {
        public string Id { get; set; }
        public string UserAddress { get; set; }
        public string Content { get; set; }
        public int SendState { get; set; }

        [NotMapped]
        [Newtonsoft.Json.JsonIgnore]
        public SendStateEnum SendStateEnum
        {
            get
            {
                switch (SendState)
                {
                    case (int)SendStateEnum.Fail:
                        return SendStateEnum.Fail;
                    case (int)SendStateEnum.Success:
                        return SendStateEnum.Success;
                    default:
                        return SendStateEnum.UnKnow;
                }
            }
            set
            {
                SendState = (int)value;
            }
        
        }
    }
    public enum SendStateEnum
    {
        Success = 1,
        Fail = 2,
        UnKnow =3 
    }

添加了SendStateEnum字段后，以后使用ef core操作或者读取SendStateEnum 代替了 SendState 字段

    using (var context = new FrameworkDbContext())
    {
        var result = context.MsgInfo.Where(m => m.SendStateEnum == SendStateEnum.Success);
    }

当然，为了防止原来的 SendState 字段被使用，可以添加标记 [Obsolete] 提醒用户该字段 SendState 已过时。

修改后的最终实体代码如下

    public partial class MsgInfo
    {
        public string Id { get; set; }
        public string UserAddress { get; set; }
        public string Content { get; set; }
        
        [Obsolete]
        public int SendState { get; set; }

        [NotMapped]
        [Newtonsoft.Json.JsonIgnore]
        public SendStateEnum SendStateEnum
        {
            get
            {
                switch (SendState)
                {
                    case (int)SendStateEnum.Fail:
                        return SendStateEnum.Fail;
                    case (int)SendStateEnum.Success:
                        return SendStateEnum.Success;
                    default:
                        return SendStateEnum.UnKnow;
                }
            }
            set
            {
                SendState = (int)value;
            } 
        }
    }
    public enum SendStateEnum
    {
        Success = 1,
        Fail = 2,
        UnKnow =3 
    }

以上方式已过时，新版本可以直接使用 https://docs.microsoft.com/en-us/ef/core/modeling/value-conversions