基于泛型的仓储模式的实体框架(1)

很久没有写博客了,一些读者也经常问问一些问题,不过最近我确实也很忙,除了处理日常工作外,平常主要的时间也花在了继续研究微软的实体框架( EntityFramework )方面了。这个实体框架加入了很多特性(例如LINQ等),目前也已经应用的比较成熟了,之所以一直没有整理成一个符合自己开发模式的实体框架,是因为这个框架和原来我的基于EnterpriseLibrary的模式还是有很大的不同,不过 实体框架推出来也很久了,目前也去到了EntityFramework6了,听说7也快出来了。

随着我自己参考阅读了大量的项目源码以及对实体框架各个技术点的学习深入,对其中很多的方面都有自己的一些见解和心得,希望通过这个系列,能够和读者一步步分析,一步步深入学习这个微软目前最为流行的.NET开发框架。本篇主要从基础开始一步步介绍基于泛型的仓储模式实体框架(The Entity Framework of Generic Repository Pattern ),希望大家耐心阅读。

1、实体框架的初步印象

最简单的实体框架,你可以在Winform或者Web项目里面添加一个【ADO.NET实体数据模型】项开始,一步步创建一个基于SqlServer的实体框架项目。最开始,我们可以不考虑什么设计模式,能够使用即可,因此我们可能创建一个比较简单的项目代码,这个有助于我们了解实体框架的一些基础工作原理。

为这个项目选定数据连接以及供测试使用的一两个表的对象,然后完成创建工作,这个【ADO.NET实体数据模型】创建完成后,我们可以看到项目里面添加了一个Model1.edmx的文件,并且同时生成了几个项目文件,其中包括了数据访问对象SqlserverContext和几个实体类(默认为表名称),我们也可以打开edmx的文件进行实体类属性的修改,如下所示。

默认生成后,我们就可以使用这个数据访问上下文对象SqlserverContext, 来进行相关的数据处理操作了,简单的测试代码如下所示。

        private void GetIntData()
        {
            //创建数据访问对象
            var context = new SqlserverContext();
                    
            //新建一个实体类并赋值    
            TB_Province info = new TB_Province();
            info.ID = 100001;
            info.ProvinceName = "测试省份";
            context.TB_Province.Add(info);
            context.SaveChanges();

            //根据主键判断记录是否存在
            TB_Province info2 = context.TB_Province.Find(info.ID);
            if (info2 != null)
            {
                Console.WriteLine("记录已存在!");

                //如果存在对象,先删除
                context.TB_Province.Remove(info2);
                context.SaveChanges();

                //检查是否删除对象
                info2 = context.TB_Province.Find(info.ID);
                if (info2 == null)
                {
                    Console.WriteLine("记录已删除!");
                }
            }
            
            //把记录全部获取并绑定到列表上。
            var list = context.TB_Province.ToList();
            this.dataGridView1.DataSource = list;
        }

最后获得的界面效果就是能够顺利执行各种操作后把记录显示出来到列表上了。

2、实体框架的工作原理

1)数据访问上下文对象介绍

从上面的代码我们可以看到,数据访问上下文对象SqlserverContext已经可以直接和数据库交互了,能够实现表对象基本增删改查的操作功能了,那么这个类是如何的呢?为什么具有这个功能呢?

我们先看看它的代码, SqlserverContext的类代码如下所示(代码为自动生成的)。

    public partial class SqlserverContext : DbContext
    {
        public SqlserverContext()
            : base("name=SqlserverContext")
        {
        }
    
        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            throw new UnintentionalCodeFirstException();
        }
    
        public virtual DbSet<TB_City> TB_City { get; set; }
        public virtual DbSet<TB_Province> TB_Province { get; set; }
        public virtual DbSet<TB_DictType> TB_DictType { get; set; }
    }

其中代码DbSet<TB_Province> TB_Province代表一个具体的数据访问对象,对表TB_Province的数据访问,其他的类似。我们查看.NET的内置对象DbSet的已经支持了一些常规的操作了。

而EMDX文件的本身是一个XML文件,它的内容如下所示。

实体框架本身通过XML映射的方式(ORM方式),封装了从数据库到实体类,以及实体类到数据库的交互过程,具体的过程我们可以参考下面的实体数据模型 (EDM)介绍。

2)实体数据模型 (EDM)介绍

Entity Framework 实体框架的要点是实体数据模型 (EDM),一个用于描述应用程序域对象的概念模型。 Entity Framework 实体框架让开发人员可以针对实体数据模型提出查询,而不必操心数据库的具体操作。 实体数据模型的实体以及实体之间的关系以 XML 形式定义,而开发人员基于该模型的实体来处理强类型化类。

在运行时,利用特定于数据库的 ADO.NET 提供程序,Entity Framework 实体框架将针对实体数据模型而创建的查询转换为存储查询(例如 T-SQL),然后送至数据库。 Entity Framework 将查询结果转换为由强类型化实体类所定义的对象。

实体数据模型 (EDM),由三个概念组成。概念模型由概念架构定义语言文件 (.csdl)来定义,映射由映射规范语言文件 (.msl),存储模型(又称逻辑模型)由存储架构定义语言文件 (.ssdl)来定义。这三者合在一起就是EDM模式。EDM模式在项目中的表现形式就是扩展名为.edmx的文件。这个包含EDM的文件可以使用Visual Studio中的EDM设计器来设计。由于这个文件本质是一个xml文件,可以手工编辑此文件来自定义CSDL、MSL与SSDL这三部分。

CSDL定义了EDM或者说是整个程序的灵魂部分 – 概念模型。这个文件完全以程序语言的角度来定义模型的概念。即其中定义的实体、主键、属性、关联等都是对应于.NET Framework中的类型。

SSDL这个文件中描述了表、列、关系、主键及索引等数据库中存在的概念。

MSL这个文件即上面所述的CSDL与SSDL的对应,主要包括CSDL中属性与SSDL中列的对应。

通过以上三个XML文件的映射关系,在程序里面,就主要是利用强类型数据的实体类进行处理了,而对实体类的任何处理修改,最终会解析后得到相应的数据库执行语句,然后进行提交处理了。

3、基于泛型的仓储模式实体框架

如果基于第一点来构建框架,虽然很快速,但是这样的做法在中大型的项目里肯定不可取,因为生成后的代码还需要进行多个步骤的修改调整,而且也没有很好实现重用的目的, 很多地方需要自己手动编码处理,结构也不是很清晰,因此需要对框架进行一步步的优化和提炼。

在介绍基于泛型的仓储模式实体框架(The Entity Framework of Generic Repository Pattern )前,我们先来回顾一下我之前的Winform开发框架分层结构,这个基于Enterprise Library的框架,常见的分层模式,可以分为UI层、BLL层、DAL层、IDAL层、Entity层、公用类库层等等。

这种分层可以在数据库设计完成后,可以通过代码生成工具,获取到表对象的信息和关系,直接快速生成相应的分层代码,从而实现架构、分层、命名规则等方面的一致化,并且是快速开发。

而且这种分层模式也是一种比较通用的分层结构了,那么我们要介绍的实体框架是否也可以依照这种方式来构建呢?是否可以结合代码生成工具的生成模板来进行整体性框架的开发呢?

下面我们来介绍一下泛型的仓储模式框架的具体实现过程。

1)实体类的代码如下所示(先按表名生成)。

    public partial class TB_City
    {
        public long ID { get; set; }
        public string CityName { get; set; }
        public string ZipCode { get; set; }
        public Nullable<long> ProvinceID { get; set; }
    }

2)数据访问基类接口层(定义了几个测试的基类接口)

    /// <summary>
    /// 数据访问层基类接口
    /// </summary>
    /// <typeparam name="T">实体对象类型</typeparam>
    public interface IBaseDAL<T> where T : class
    {
        T Get(object id);

        IList<T> GetAll(Expression<Func<T, bool>> whereCondition);

        IList<T> GetAll();
    }

3)数据访问层基类实现层

    /// <summary>
    /// 数据访问层基类实现层
    /// </summary>
    /// <typeparam name="T">实体对象类型</typeparam>
    public abstract class BaseDAL<T> : IBaseDAL<T>  where T : class
    {
        protected DbContext baseContext;
        protected IDbSet<T> objectSet;

        public BaseDAL(DbContext context)
        {
            this.baseContext = context;
            this.objectSet = this.baseContext.Set<T>();
        }

        public T Get(object id)
        {
            return objectSet.Find(id);
        }

        public IList<T> GetAll()
        {
            return objectSet.ToList<T>();;
        }

        public IList<T> GetAll(Expression<Func<T, bool>> whereCondition)
        {
            return objectSet.Where(whereCondition).ToList<T>();
        }
    }

4)具体数据访问对象接口定义(城市表为例)

    /// <summary>
    /// 城市数据访问层接口
    /// </summary>
    public interface ICityDAL : IBaseDAL<City>
    {
    }

5)具体数据访问对象实现层(城市表为例)

    /// <summary>
    /// 城市数据访问对象
    /// </summary>
    public class CityDAL : BaseDAL<TB_City> 
    {
        protected MyDataContext context;

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="context"></param>
        public CityDAL(MyDataContext context) :base(context)
        {
            this.context = context;
        }

6)数据仓储对象(上下文对象)

    public class MyDataContext : DbContext
    {
        public MyDataContext() : base("name=sqlserver")
        {
        }
    
        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            throw new UnintentionalCodeFirstException();
        }
    
        public virtual DbSet<TB_City> City { get; set; }
    }

BLL、IBLL的分层和数据访问层的类似,主要是提高一份,方便做业务整合实现而已,在此不再赘述。

最终实现仓储模式框架的分层结构如下所示。

以上就是我对基于泛型的仓储模式的实体框架的一个初探性的开端,下面会在这个系列里面继续分析其中存在的问题,并继续优化改良这个基于泛型的仓储模式的实体框架。希望大家喜欢并继续支持。