基于 Entity FrameWork 6 Code-First

2019-09-29 本文已影响0人晓川君

一、背景介绍

最近开发中用到了本地数据库SQLite，正好刚刚学习了EF6框架，强大的Code-First功能印象深刻（真的不用再写Sql脚本了吗~），于是自然想到将两者结合起来，没想到这个过程中踩了几个大坑：

EF6的Code-First模式默认不支持SQLite，需要第三方扩展的支持
开发中一般需要将主程序和仓储层分开，只在仓储层引用和ORM相关的Dll，实际开发中发现主程序竟然还要引用EF6和SQLite并大量修改配置文件(其实根本就没有用到)

经过漫长的的折腾，终于基本实现了主程序和仓储层的分离，简单总结如下（实验环境为Visual Studio 2017 + .Net FrameWork 4.5.1）

二、SQLite的Code-First解决方案

网上许多文章都说EF6只能在DB-First模式下使用SQLite。虽然微软没有实现对SQLite的完美支持，但是已经有牛人替我们搞定了。在Nuget搜索SQLite.CodeFirst，然后开始我们的表演~

别以为到这就行了，不存在的

在自已的类中继承DbContext，然后在OnModelCreating中调用方法

    public class VRSContext : DbContext
    {
        public VRSContext() : base("name=LocalDB")
        {
            Configuration.ValidateOnSaveEnabled = false;
            Configuration.LazyLoadingEnabled = false;
        }

        public VRSContext(string connectionString)
            : base( new SQLiteConnection() { ConnectionString = connectionString }, true )
        {
            Configuration.ValidateOnSaveEnabled = false;
            Configuration.LazyLoadingEnabled = false;
        }

        public DbSet<Passenger> Passengers { get; set; }
        public DbSet<Record> Records { get; set; }

        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            var init = new SqliteCreateDatabaseIfNotExists<VRSContext>(modelBuilder);
            Database.SetInitializer(init);
        }
    }

其中，SqliteCreateDatabaseIfNotExists类实现了IDatabaseInitializer<>这一泛型接口，通过Database的静态方法实现了Code-First。作者一共实现了三种初始化器：

SqliteCreateDatabaseIfNotExists
SqliteDropCreateDatabaseAlways
SqliteDropCreateDatabaseWhenModelChanges

看名字大概就知道各自的功能了，想要深入了解的同学可以去原作者的Github学习源码，里面还有详细的Demo帮助我们更好的使用它。https://github.com/msallin/SQLiteCodeFirst

三、Main Assembly 与仓储层的分离

有了自己的DbContext类之后，我们可以自己编写的仓储层了。网上有很多资料，基本思路就是创建一个抽象类实现仓储接口，然后根据数据库表结构进行扩展，这里就不再赘述了。本以为写完就能愉快的下班了，可是在写一个简单的控制台程序测试一下，结果悲剧了：

无法从app.config中找到名为"System.Data.SqlClient"的Provider

除此之外，还可能出现诸如找不到连接字符串、默认工厂无法加载等等错误。这是因为主程序的配置文件中不包含相关的节点，于是想到将仓储层DLL的配置文件复制到主程序app.config里：

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
   <!--For more information on Entity Framework configuration, visit http://go.microsoft.com/fwlink/?LinkID=237468--> 
  <section name="entityFramework"
    type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"
    requirePermission="false"/>
  </configSections>
  <connectionStrings>
    <add name="LocalDB" connectionString="data source=.\Db\vrsDb.sqlite;foreign keys=true" providerName="System.Data.SQLite.EF6"/>
  </connectionStrings>
  <entityFramework>
    <defaultConnectionFactory type="System.Data.Entity.Infrastructure.LocalDbConnectionFactory, EntityFramework">
      <parameters>
        <parameter value="mssqllocaldb"/>
      </parameters>
    </defaultConnectionFactory>
    <providers>
      <provider invariantName="System.Data.SqlClient" type="System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer"/>
      <provider invariantName="System.Data.SQLite.EF6" type="System.Data.SQLite.EF6.SQLiteProviderServices, System.Data.SQLite.EF6"/>
      <provider invariantName="System.Data.SQLite" type="System.Data.SQLite.EF6.SQLiteProviderServices, System.Data.SQLite.EF6"/>
    </providers>
  </entityFramework>
  <system.data>
    <DbProviderFactories>
      <remove invariant="System.Data.SQLite.EF6"/>
      <add name="SQLite Data Provider (Entity Framework 6)" invariant="System.Data.SQLite.EF6"
        description=".NET Framework Data Provider for SQLite (Entity Framework 6)" type="System.Data.SQLite.EF6.SQLiteProviderFactory, System.Data.SQLite.EF6"/>
      <remove invariant="System.Data.SQLite"/>
      <add name="SQLite Data Provider" invariant="System.Data.SQLite" description=".NET Framework Data Provider for SQLite"
        type="System.Data.SQLite.SQLiteFactory, System.Data.SQLite"/></DbProviderFactories>
  </system.data>
</configuration>

这一大坨配置文件是在安装System.Data.SQLite.EF6后，VS帮助我们自动生成的。保险起见，我参考上文提到Demo的做了一些修改，Demo链接如下：https://github.com/msallin/SQLiteCodeFirst/tree/master/SQLite.CodeFirst.Console。我们重新生成，运行，然后喜闻乐见的挂了。。。于是开始面向Google编程，大概有以下两种解决思路。

3.1 方案一：在主程序安装EntityFrameWork

https://stackoverflow.com/questions/18455747/no-entity-framework-provider-found-for-the-ado-net-provider-with-invariant-name
https://stackoverflow.com/questions/19821284/no-entity-framework-provider-found-for-the-ado-net-provider-with-invariant-name
这些问题下面的高票答案是在所有引用仓储层的项目里把EF再装一遍，或者引用EntityFrameWork.SqlServer.Dll然后再修改app.config。后一种方法改动稍微小一点，但我没成功过，可能是因为Sqlite还需要其他的Dll。第一种方法的确可行，但在逻辑上是有问题的，为什么我要在项目里添加我根本没用到的DLL呢？

3.2 方案二：基于代码的EntityFrameWork配置（推荐）

EF6中引入了基于代码的配置，可以不用在配置文件里去设置了。结合我们的项目，如果主程序在配置文件中找不到EF6的相关设置，就在运行时加载代码中的配置信息，这种方案不再需要在主程序引入大量笨重的Dll，只要一个仓储层的Dll就够了，是不是感觉全世界都美好了~

首先继承DbConfiguration类，在构造函数中指定正确的Provider

public class SQLiteConfiguration : DbConfiguration
{
    public SQLiteConfiguration()
    {
        SetProviderFactory("System.Data.SQLite", SQLiteFactory.Instance);
        SetProviderFactory("System.Data.SQLite.EF6", SQLiteProviderFactory.Instance);
        SetProviderServices("System.Data.SQLite", (DbProviderServices)SQLiteProviderFactory.Instance.GetService(typeof(DbProviderServices)));
    }
}

然后在我们的DbContext类上加上一行特性代码：

[DbConfigurationType(typeof(SQLiteConfiguration))]

至此已经可以实现分离了，但是还不够完美，我们还不能在主程序的app.config中配置连接字符串，不过这一点EF6已经帮我们想到了。首先创建连接工厂类，实现IDbConnectionFactory接口

public class SQLiteConnectionFactory : IDbConnectionFactory
{
    public DbConnection CreateConnection(string nameOrConnectionString)
    {
        return new SQLiteConnection(nameOrConnectionString);
    }
}

然后修改SQLiteConfiguration类：

    public class SQLiteConfiguration : DbConfiguration
    {
        public SQLiteConfiguration()
        {
            //设置默认连接工厂
            SetDefaultConnectionFactory(new SqLiteConnectionFactory());
            SetProviderFactory("System.Data.SQLite", SQLiteFactory.Instance);
            SetProviderFactory("System.Data.SQLite.EF6", SQLiteProviderFactory.Instance);
            SetProviderServices("System.Data.SQLite", (DbProviderServices)SQLiteProviderFactory.Instance.GetService(typeof(DbProviderServices)));
        }
    }

现在app.config文件只需要以下寥寥数行了，是不是清爽了许多？

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup> 
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
  </startup>
  <connectionStrings>
    <add name="LocalDB" connectionString="data source=.\Db2\vrsDb.sqlite;foreign keys=true" providerName="System.Data.SQLite.EF6"/>
  </connectionStrings>
</configuration>

注意，connectionStrings的name属性要和上下文类构造函数中指定的值一致，不然会找不到连接字符串

参考资料
[1]. https://www.entityframeworktutorial.net/entityframework6/code-based-configuration.aspx
[2]. https://stackoverflow.com/questions/20460357/problems-using-entity-framework-6-and-sqlite/24935665#24935665
[3]. https://stackoverflow.com/questions/22101150/sqlite-ef6-programmatically-set-connection-string-at-runtime/23105811#23105811