TinyFrame开篇：基于CodeFirst的ORM

前言

做项目的这段时间，由于比较忙，一直没有机会闲下来思考。正好趁目前手头活儿轻松点，就花了一两天时间搭建了一个比较简单的框架，名称暂时就叫做：TinyFrame吧。顾名思义，就是微框架的意思。虽然这个框架很小，但是包含了ORM，IOC，AOP以及Restful service支持。真所谓麻雀虽小，但是五脏俱全。今天主要讲解的就是基于CodeFirst的ORM实现方式。

在传统的开发思维中，我们一般都是先建立好数据库，然后布局各种Model类，最后调用。这种方式被称为DbFirst方式，也就是先有DataBase，然后再布局逻辑。而CodeFirst相反，是先建立好model，建立好需要的字段，然后由EntityFramework来自动生成数据库的表，看上去有点像DDD的开发方式。

下面就开始吧。

实现步骤解说

首先，我们以一个简易的图书借阅为例：在图书馆中，图书是有分类的，比如属于计算机类，还是属于文学类；图书是有存放位置的，比如存放于图书馆一楼，还是二楼；图书是有自身属性的，比如图书名称，图书作者等；图书借阅是需要人来参与的，所以会有学生这个集体；图书借阅需要知道谁借了什么书，什么时候到期等，是需要一个数据存储中心的。所以，综上所述，可以建立如下的Model来。

来看看数据关系图：

这里可以看到总共有五张表，他们的Model类创建如下：

Book实体类，主要用来描述图书的本身属性，一本书只能放置在一个地方，只能属于一个种类，有BookTypeID和BookPlaceID作为外键约束：

namespace BookStore.Data
{
    public class Book
    {
        public Book()
        {
            BookType = new BookType();
            BookPlace = new BookPlace();
        }

        public int ID { get; set; }
        public string Name { get; set; }
        public string Author { get; set; }
        public string Publishment { get; set; }
        public int BookTypeID { get; set; }
        public int BookPlaceID { get; set; }

        public BookType BookType { get; set; }
        public BookPlace BookPlace { get; set; }
    }
}

BookLend实体类，主要用来描述哪位学生借阅了什么书籍，一个学生可以借阅多本书籍，所以里面放了一个Student实体类，对应着多个Books，有BookID和StudentID作为外键约束：

namespace BookStore.Data
{
    public class BookLend
    {
        public BookLend()
        {
            Student = new Student();
            Books = new List<Book>();
        }
        public int ID { get; set; }
        public int LendDays { get; set; }
        public DateTime LendDate { get; set; }
        public int BookID { get; set; }
        public int StudentID { get; set; }

        public IList<Book> Books { get; set; }
        public Student Student { get; set; }
    }
}

BookPlace实体类，主要用来描述图书放置的位置：

namespace BookStore.Data
{
    public class BookPlace
    {
        public int ID { get; set; }
        public string Position { get; set; }
    }
}

BookType实体类，主要用来描述图书种类：

namespace BookStore.Data
{
    public class BookType
    {
        public int ID { get; set; }
        public string Name { get; set; }
    }
}

Student实体类，主要用来描述学生属性：

namespace BookStore.Data
{
    public class Student
    {
        public int ID { get; set; }
        public string Name { get; set; }
        public string Number { get; set; }
        public string Major { get; set; }
        public string TelPhone { get; set; }
        public string Address { get; set; }
        public Gender Gender { get; set; }
    }
}

 

这里还有个附加的枚举性别选项：

namespace BookStore.Data
{
    public enum Gender
    {
        Male = 0,    //男
        Female = 1    //女
    }
}

到这里，我们的Model就创建好了。

然后我们来创建ModelMapper。这种Mapper主要是用来设置各个字段的属性的。

BookMapper类：

namespace BookStore.Data
{
    public class BookMapper:EntityTypeConfiguration<Book>
    {
        public BookMapper()
        {
            this.ToTable("Book");

            this.HasKey(c => c.ID);
            this.Property(c => c.ID).HasDatabaseGeneratedOption(DatabaseGeneratedOption.Identity);
            this.Property(c => c.ID).IsRequired();

            this.Property(c => c.Name).HasMaxLength(255);
            this.Property(c => c.Name).IsRequired();

            this.Property(c => c.Author).HasMaxLength(255);
            this.Property(c => c.Author).IsOptional();

            this.Property(c => c.Publishment).HasMaxLength(255);
            this.Property(c => c.Publishment).IsRequired();

            this.HasRequired(c => c.BookType).WithMany().HasForeignKey(s => s.BookTypeID);
            this.HasRequired(c => c.BookPlace).WithMany().HasForeignKey(s => s.BookPlaceID);

        }
    }
}

第7行代码表示：对于Book实体类来说，最终将会在数据库中为其创建名称为Book的数据表。

第9行代码表示：这是一个主键。

第10行代码表示：这个主键是自增的。

第11行代码表示：这个主键是不能为空的。

第13，14行代码表示：这是一个普通属性，字段最大长度为255，不能为空。

第16，17行代码表示：这是一个普通属性，字段最大长度为255，可以为空。

第22，23行代码表示：在BookType表和BookPlace表中存在外键依赖。需要注意的是，如果Model类中定义了BookTypeID和BookPlaceID，这里一定要用HasForeignKey方法来指明。否则，可以利用Map方法来隐式指定。

接下来的Mapper就不一一解释了：

BookLendManager类：

namespace BookStore.Data
{
    public class BookLendMapper : EntityTypeConfiguration<BookLend>
    {
        public BookLendMapper()
        {
            this.ToTable("BookLend");

            this.HasKey(c=>c.ID);
            this.Property(c => c.ID).HasDatabaseGeneratedOption(DatabaseGeneratedOption.Identity);
            this.Property(c => c.ID).IsRequired();

            this.Property(c => c.LendDays).IsRequired();

            this.Property(c => c.LendDate).IsRequired();
            this.Property(s => s.LendDate).HasColumnType("smalldatetime");

            this.HasRequired(c => c.Books).WithMany().HasForeignKey(s=>s.BookID);
            this.HasRequired(c => c.Student).WithMany().HasForeignKey(s =>s.StudentID);
        }
    }
}

BookPlaceMapper类：

namespace BookStore.Data
{
    public class BookPlaceMapper : EntityTypeConfiguration<BookPlace>
    {
        public BookPlaceMapper()
        {
            this.ToTable("BookPlace");

            this.HasKey(c=>c.ID);
            this.Property(c => c.ID).HasDatabaseGeneratedOption(DatabaseGeneratedOption.Identity);
            this.Property(c => c.ID).IsRequired();

            this.Property(c => c.Position).IsRequired();
            this.Property(c => c.Position).HasMaxLength(255);
        }
    }
}

BookTypeMapper类：

namespace BookStore.Data.Mapper
{
    public class BookTypeMapper : EntityTypeConfiguration<BookType>
    {
        public BookTypeMapper()
        {
            this.ToTable("BookType");

            this.HasKey(c => c.ID);
            this.Property(c => c.ID).HasDatabaseGeneratedOption(DatabaseGeneratedOption.Identity);
            this.Property(c => c.ID).IsRequired();

            this.Property(c => c.Name).IsRequired();
            this.Property(c => c.Name).HasMaxLength(255);
        }
    }
}

StudentMapper类：

namespace BookStore.Data
{
    public class StudentMapper : EntityTypeConfiguration<Student>
    {
        public StudentMapper()
        {
            this.ToTable("Student");

            this.HasKey(c=>c.ID);
            this.Property(c => c.ID).HasDatabaseGeneratedOption(DatabaseGeneratedOption.Identity);
            this.Property(c => c.ID).IsRequired();

            this.Property(c => c.Name).IsRequired();
            this.Property(c => c.Name).HasMaxLength(255);

            this.Property(c => c.Number).IsRequired();
            this.Property(c => c.Number).HasMaxLength(12);

            this.Property(c => c.Major).IsOptional();
            this.Property(c => c.Major).HasMaxLength(255);

            this.Property(c => c.Address).IsOptional();
            this.Property(c => c.Address).HasMaxLength(255);

            this.Property(c => c.Gender).IsRequired();
        }
    }
}

当我们写完这些mapper的时候，工作已经完成一大半了，剩下的就是如何将其自动创建到数据库中的问题了。

这里我们需要用到EF的SetInitializer方法：

首先创建一个BookContext，继承自DbContext类，然后在构造中书写以下代码，以便实现数据实体类迁移：

public BookContext()
           : base("BookConnection")
       {
           Configuration.ProxyCreationEnabled = false;
           Configuration.LazyLoadingEnabled = false;
           Database.SetInitializer(new MigrateDatabaseToLatestVersion<BookContext, BookContextMConfig>());
       }

然后重写其OnModelCreating方法,将Mapper类加入到ModelBuilder中:

   protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            modelBuilder.Configurations.Add(new BookMapper());
            modelBuilder.Configurations.Add(new BookLendMapper());
            modelBuilder.Configurations.Add(new BookTypeMapper());
            modelBuilder.Configurations.Add(new BookPlaceMapper());
            modelBuilder.Configurations.Add(new StudentMapper());
            modelBuilder.Configurations.Add(new ManagerMapper());
            base.OnModelCreating(modelBuilder);
        }

其中需要注意BookContextMConfig这个类,它需要继承DbMigrationsConfiguration类:

    public class BookContextMConfig : DbMigrationsConfiguration<BookContext>
    {
        public BookContextMConfig()
        {
            this.AutomaticMigrationDataLossAllowed = true;
            this.AutomaticMigrationsEnabled = true;
        }
    }

这样我们的一个完整的ORM就封装好了.通过访问BookContext对象,我们就可以从数据库获得与之对应的实体类.

最后还要注意，需要将数据库连接写到配置文件中：

  <connectionStrings>
    <add name="BookConnection" connectionString="server=180-server;database=BookConnection;uid=sa;pwd=*****" providerName="System.Data.SqlClient" />
  </connectionStrings>

 

当这个实例运行起来的时候,我们就可以看到数据库中的表被自动创建了.并且实例化BookContext对象之后,我们可以获取到所有的Books,Students,BookTypes,BookPlaces,BookLends。

下一节主要来说明如何进行IOC注入。