一步一步学EF系列4升级篇实体与数据库的映射live writer真坑，第4次补发

Posted 2020-08-20 在西天取经的路上……

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了一步一步学EF系列4升级篇实体与数据库的映射live writer真坑，第4次补发相关的知识，希望对你有一定的参考价值。

前言

之前的几篇文章，被推荐到首页后，又被博客园下了，原因内容太少，那我要写多点呢，还是就按照这种频率进行写呢？本身我的意图这个系列就是想已最简单最容易理解的方式进行，每篇内容也不要太多，这样初学者容易理解学习，否则天花乱坠的一大篇初学者从头看到尾也要晕了。所以每次突出重点进行浓缩精华时的讲，当然我这样精简讲，你们要学深入的话，也还是要把有些概念学深入一下。也欢迎大家共同讨论学习。我这里创建了一个QQ群(435498053)，大家也可以加群交流。

正文

本篇还是作为之前的升级篇，其实前面2-3篇可以合并，但我觉得直接合并不能让人很容易理解，先来一篇最基础的，然后在循序渐进的进行深入和代码方面的封装简化。我们不废话了，接着上篇讲，上篇最后的时候大家还记得最终写好的代码吗？我把代码贴出来一块回顾一下。

       //实体集合
        public IDbSet<BlogUser> BlogUsers { get; set; }
        public IDbSet<Post> Posts { get; set; }
     
        /// <summary>
        /// 重写配置类
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            // base.OnModelCreating(modelBuilder);
            modelBuilder.Configurations.Add(new BlogUserConfiguration());
            modelBuilder.Configurations.Add(new PostConfiguration());
        }

上一篇我们提出这样写是为了简化在OnModelCreating中把每个表的配置写到这里，但是用心的朋友应该看到，你这样写其实也还是很麻烦啊！按照现在的写法难道我每次建一个实体都要在这里创建一个实体集合，然后在下面在加入一个modelBuilder.Configurations.Add(new XXXConfiguration());所以问题还是一样的存在。具体看下面

由代码可以看出，当前的上下文类与业务实体是强耦合的，分别耦合在DbSet<TEntity>的属性与OnModelCreating方法上。那解决办法呢？当然要解耦。对于属性，可以使用DbContext.Set<TEntity>()方法来实现指定实体的属性，对于OnModelCreating中的方法实现中的映射配置对象，则可提取一个通用接口，通过接口进行分别映射。那我们就分两步来讲解如何解耦！

一、提取一个IEntityMapper通用接口，通过接口进行分别映射。

1、定义接口的代码如下：

    /// <summary>
    ///     实体映射接口
    /// </summary>
    public interface IEntityMapper
    {
        ///<summary>
        ///     将当前实体映射对象注册到当前数据访问上下文实体映射配置注册器中
        /// </summary>
        /// <param name="configurations">实体映射配置注册器</param>
        void RegistTo(ConfigurationRegistrar configurations);
    }

2、在实体映射类中添加IEntityMapper的实现。我们已BlogUser作为实例演示。代码如下

/// <summary>
    /// 博客用户信息映射类
    /// </summary>
    public class BlogUserConfiguration : EntityTypeConfiguration<BlogUser>,IEntityMapper
    {
        public BlogUserConfiguration()
        {
            //设置主键
            HasKey(m => m.BlogUserId);
        }

        public void RegistTo(System.Data.Entity.ModelConfiguration.Configuration.ConfigurationRegistrar configurations)
        {
            configurations.Add(this);
            //throw new NotImplementedException();
        }
    }

3、这样定义好了，那是不是要考虑的是怎么能在OnModelCreating自动调用实现IEntityMapper进行自动注册呢！这里办法有很多，有知道IOC的朋友应该会想到用依赖注入的方式就可以，引入所有实现了IEntityMapper的类的对象。但是我这里先不用IOC组件干这个事情，我们还是先按照最传统的方式来进行。

我们具体要怎么做的思路都有了吧？就是引入所有实现了IEntityMapper的类的对象，然后遍历，调用其中的RegistTo进行实体映射类对象的添加。

第一步，获取所有实现了IEntityMapper的类的对象，看代码

     private static ICollection<IEntityMapper> GetAllEntityMapper()
        {
            ICollection<Assembly> EntityMapperAssemblies = EntityMapperAssemblies = new[]
                        {
                            Assembly.LoadFrom(Path.Combine(AppDomain.CurrentDomain.RelativeSearchPath, "EFCore.dll"))
                        };
            if (EntityMapperAssemblies.Count == 0)
            {
                throw new InvalidOperationException("上下文“{0}”初始化失败，请添加实体映射程序集");
            }
            Type baseType = typeof(IEntityMapper);
            Type[] mapperTypes = EntityMapperAssemblies.SelectMany(assembly => assembly.GetTypes())
                .Where(type => baseType.IsAssignableFrom(type) && type != baseType && !type.IsAbstract).ToArray();
            ICollection<IEntityMapper> result = mapperTypes.Select(type => Activator.CreateInstance(type) as IEntityMapper).ToList();
            return result;
        }

上面的这段我是参考过别人的代码的，具体哪个博客我不记得了，到时候找到我在添加上引用。原理也比较简单就是我加载我写实体类的EFCore.dll的程序集，这个dll名称要按你实际项目的dll名称为主，这个名字现在是我自己的demo。然后把实现IEntityMapper的类找到，然后通过CreateInstance创建该类型的实例，原理就这个。

第二步，遍历对象，调用其中的RegistTo进行实体映射类对象的添加

/// <summary>
        /// 重写配置类
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            // base.OnModelCreating(modelBuilder);
            //modelBuilder.Configurations.Add(new BlogUserConfiguration());
            //modelBuilder.Configurations.Add(new PostConfiguration());

            modelBuilder.Entity<BlogUser>().HasKey(m => m.BlogUserId);

            IEnumerable<IEntityMapper> EntityMappers = GetAllEntityMapper();
            if (EntityMappers == null)
            {
                return;
            }
            foreach (var mapper in EntityMappers)
            {
                mapper.RegistTo(modelBuilder.Configurations);
            }

        }

然后就完成了，运行你的代码。是不是也成功了。

我把完整的代码在附上

        /// <summary>
        /// 重写配置类
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            // base.OnModelCreating(modelBuilder);
            //modelBuilder.Configurations.Add(new BlogUserConfiguration());
            //modelBuilder.Configurations.Add(new PostConfiguration());

            modelBuilder.Entity<BlogUser>().HasKey(m => m.BlogUserId);

            IEnumerable<IEntityMapper> EntityMappers = GetAllEntityMapper();
            if (EntityMappers == null)
            {
                return;
            }
            foreach (var mapper in EntityMappers)
            {
                mapper.RegistTo(modelBuilder.Configurations);
            }

        }


        private static ICollection<IEntityMapper> GetAllEntityMapper()
        {
            ICollection<Assembly> EntityMapperAssemblies = EntityMapperAssemblies = new[]
                        {
                            Assembly.LoadFrom(Path.Combine(AppDomain.CurrentDomain.RelativeSearchPath, "EFCore.dll"))
                        };
            if (EntityMapperAssemblies.Count == 0)
            {
                throw new InvalidOperationException("上下文“{0}”初始化失败，请添加实体映射程序集");
            }
            Type baseType = typeof(IEntityMapper);
            Type[] mapperTypes = EntityMapperAssemblies.SelectMany(assembly => assembly.GetTypes())
                .Where(type => baseType.IsAssignableFrom(type) && type != baseType && !type.IsAbstract).ToArray();
            ICollection<IEntityMapper> result = mapperTypes.Select(type => Activator.CreateInstance(type) as IEntityMapper).ToList();
            return result;
        }

我这里作为演示也不要新建类进行封装，写的一起主要看起来方便而已。

二、对于属性，可以使用DbContext.Set<TEntity>()方法来实现指定实体的属性

上面我们通过提前了一个IEntityMapper接口实现了OnModelCreating里面的代码的解耦。那这里我们就要想办法处理如下的代码。

public IDbSet<BlogUser> BlogUsers { get; set; }
public IDbSet<Post> Posts { get; set; }
……
上面也提到了解决办法就是通过DbContext.Set<TEntity>()方法来实现指定实体的属性，具体怎么操作呢？其实这个要比处理配置类简单多了，当然也还是直接看代码。

public ActionResult Index()
 {
 
   var db= new BlogDbContext();

   return View(db.Posts.ToList());

}
这个代码是第一篇里面的，获取Posts里面的数据，然后返回的前台展示。还记得吗？不记得翻到第一篇看看。

上面的代码大家都见过第一篇里面的，那如果解耦的话这里用db.Posts是不是就不存在了，那要怎么做呢！同样看代码
public ActionResult Index()
        {
            var dbContext = new BlogDbContext();
            IQueryable
<Post> Posts = dbContext.Set<Post>
();
            return View(Posts.ToList());
        }
这个就是上面说的用DbContext.Set<TEntity>()方法来实现指定实体的属性。简单吗？一句话就可以搞定。

最后我把我们最终的源码发布一下

public BlogDbContext()
            : base()
        { }
        ///实体集合
        // public IDbSet<BlogUser> BlogUsers { get; set; }
        //public IDbSet<Post> Posts { get; set; }

        /// <summary>
        /// 重写配置类
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            // base.OnModelCreating(modelBuilder);
            //modelBuilder.Configurations.Add(new BlogUserConfiguration());
            //modelBuilder.Configurations.Add(new PostConfiguration());

            modelBuilder.Entity<BlogUser>().HasKey(m => m.BlogUserId);

            IEnumerable<IEntityMapper> EntityMappers = GetAllEntityMapper();
            if (EntityMappers == null)
            {
                return;
            }
            foreach (var mapper in EntityMappers)
            {
                mapper.RegistTo(modelBuilder.Configurations);
            }

        }


        private static ICollection<IEntityMapper> GetAllEntityMapper()
        {
            ICollection<Assembly> EntityMapperAssemblies = EntityMapperAssemblies = new[]
                        {
                            Assembly.LoadFrom(Path.Combine(AppDomain.CurrentDomain.RelativeSearchPath, "EFCore.dll"))
                        };
            if (EntityMapperAssemblies.Count == 0)
            {
                throw new InvalidOperationException("上下文“{0}”初始化失败，请添加实体映射程序集");
            }
            Type baseType = typeof(IEntityMapper);
            Type[] mapperTypes = EntityMapperAssemblies.SelectMany(assembly => assembly.GetTypes())
                .Where(type => baseType.IsAssignableFrom(type) && type != baseType && !type.IsAbstract).ToArray();
            ICollection<IEntityMapper> result = mapperTypes.Select(type => Activator.CreateInstance(type) as IEntityMapper).ToList();
            return result;
        }

现在如果你在新加一个实体类，就可以不用改这里呆任何一句代码了。已经完全解耦了。是不是蛮简单。