SQLite CodeFirst、Migration 的趟坑过程 [附源码]

负一、吐个槽

关于sqlite的CodeFirst，我找了很久，有很多博客都写过，但是真正好用的非常少，还有很多根本就是DBFirst的代码，真是坑的我够呛，研究了几天也算有点成果，整理一下，希望对路过的朋友有所帮助。

零、冷知识

1、sqlite.CodeFirst

使用NuGet安装的EF和sqlite可能是没有CodeFirst功能的，安装了“sqlite.CodeFirst”之后可以为sqlite提供CodeFirst的功能。

2、System.Data.sqlite.EF6.Migrations 数据库迁移

sqlite 是没有数据库迁移 MigrationsqlGenerator 功能的，我所查询的资料是这样的（有错请指正，非常感谢），甚至有人说得自己写一个数据迁移的功能，那是不是有点辛苦。

还好在 NuGet 上有一个“System.Data.sqlite.EF6.Migrations”（详细内容可以访问他的网站，网站上有说明文档），安装之后可以做简单的数据库修改，可以添加表中的列，但是并不能删除和修改列，因为 sqlite 并不认识 drop column 和 rename column，至于为什么不认识看下条。

3、sqlite不支持的语法

关于这个，可以自己百度查一下 ^ _ ^ ~

4、关于sqlite中的数据关系

我在试验的过程中，发现sqlite的数据关系并不可靠，尤其是EF的子查询我就没有尝试成功，还有使用外键的时候也并不正常。

5、sqlite 中的 Guid

在 sqlite 中使用 Guid 的时候，因为 sqlite 中 Guid 会使用 BLOB 类型来存储（就是二进制），所以用 Linq 直接 Id==id 是查不到东西的，使用 tostring 也得不到正确的格式，建议在使用 EF sqlite 的时候，使用 string 来存储 Guid 数据。

使用 sqlite 读取工具打开数据库文件，就会发现 Guid 是 BLOB 存储的，并且顺序和 C# 生成的 Guid 并不相同。（如果非要使用 Guid 可以研究一下 Guid 和二进制的转换。）

一、安装过程

OK 进入正题：

使用NuGet安装时，相关联的都会自动下载，所以这点还是很方便的，这里列一下安装完之后都有啥：
1. EntityFramework
2. EntityFramework.zh-Hans（中文说明）
3. sqlite.CodeFirst（实现CodeFirst）
4. System.Data.sqlite
5. System.Data.sqlite.Core
6. System.Data.sqlite.EF6
7. System.Data.sqlite.EF6.Migrations（提供数据库迁移）
8. System.Data.sqlite.Linq

安装过程就这样……

二、简单配置一下

虽然安装的时候会自动写入一些配置信息，但是还是可能有些遗漏，查漏补缺一下：

App.config 文件：

entityFramework->providers 下检查添加：

<provider invariantName="System.Data.sqlite" type="System.Data.sqlite.EF6.sqliteProviderServices,System.Data.sqlite.EF6" />

connectionStrings 下检查添加：

<add name="DefaultConnection" connectionString="data source=sqliter.db" providerName="System.Data.sqlite" />

三、数据库工具类

一个简单例子只需要4个类：
1. Entity 类（实体类）
2. Mapping 类（实体配置）
3. DbContext 类（数据库操作）
4. Configuration 类（设置信息）

首先来一个简单“栗子”：

Entity 类：

public class Bus
{
    public string Id { get; set; }
    public string Name { get; set; }
}
public class Person
{
    public string Id { get; set; }
    public string Name { get; set; }
}

Mapping 类：

public class Mapping
{
    public class BusMap : EntityTypeConfiguration<Bus>
    {
        public BusMap()
        {
        }
    }
    public class PersonMap : EntityTypeConfiguration<Person>
    {
        public PersonMap()
        {
        }
    }
}

DBContext 类：

public class sqliteDb : DbContext
{
    public sqliteDb() : base("DefaultConnection")
    {
        Database.SetInitializer(new MigrateDatabaseToLatestVersion<sqliteDb,Configuration>());
    }
    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
        modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
        modelBuilder.Configurations.AddFromAssembly(typeof(sqliteDb).Assembly);
    }
}

Configuration 类:

public class Configuration : DbMigrationsConfiguration<sqliteDb>
{
    public Configuration()
    {
        AutomaticMigrationsEnabled = true;
        AutomaticMigrationDataLossAllowed = true;
        SetsqlGenerator("System.Data.sqlite",new sqliteMigrationsqlGenerator());
    }

    protected override void Seed(sqliteDb context)
    {
        // This method will be called after migrating to the latest version.

        // You can use the DbSet<T>.AddOrUpdate() helper extension method 
        // to avoid creating duplicate seed data. E.g.
        //
        // context.People.AddOrUpdate(
        // p => p.FullName,
        // new Person { FullName = "Andrew Peters" },
        // new Person { FullName = "Brice Lambson" },
        // new Person { FullName = "Rowan Miller" }
        // );
        //
    }
}

四、操作代码

public partial class Form1 : Form
{
    //创建Bus
    Bus Bus = new Bus() { Id = Guid.NewGuid().ToString(),Name = "11 路" };
    public Form1()
    {
        InitializeComponent();
    }
    private void Form1_Load(object sender,EventArgs e)
    {
        //默认往数据库添加一个Bus
        using (sqliteDb db = new sqliteDb())
        {
            db.Set<Bus>().Add(Bus);
            db.SaveChanges();
        }
    }
    //添加人员
    void InsertPerson(string name)
    {
        using (sqliteDb db = new sqliteDb())
        {
            Bus dbBus = db.Set<Bus>().Where(x => x.Id == Bus.Id).FirstOrDefault();
            db.Set<Person>().Add(new Person() { Id = Guid.NewGuid().ToString(),Name = name,Bus = dbBus });
            db.SaveChanges();
        }
    }
    //删除人员
    void DeletePerson(string id)
    {
        using (sqliteDb db = new sqliteDb())
        {
            Person p = new Person() { Id = id };
            Person person = db.Set<Person>().Attach(p);
            db.Set<Person>().Remove(person);
            db.SaveChanges();
        }
    }
    //更新人员
    void UpdatePerson(string id,string name)
    {
        using (sqliteDb db = new sqliteDb())
        {
            Person p = db.Set<Person>().Where(x => x.Id == id).FirstOrDefault();
            p.Name = name;
            db.SaveChanges();
        }
    }

    #region 点击按钮操作
    private void BtInsert_Click(object sender,EventArgs e)
    {
        //清空文本框
        TbTxt.Text = "";
        //插入人员
        InsertPerson(TbInsert.Text);
        //显示人员信息
        using (sqliteDb db = new sqliteDb())
        {
            List<Person> persons = db.Set<Person>().ToList();
            if (persons != null)
            {
                persons.ForEach(x =>
                {
                    TbTxt.Text += x.Id + " " + x.Name + Environment.NewLine;
                });
            }
        }
    }
    private void BtDelete_Click(object sender,EventArgs e)
    {
        TbTxt.Text = "";
        DeletePerson(TbDelete.Text);
        using (sqliteDb db = new sqliteDb())
        {
            List<Person> persons = db.Set<Person>().ToList();
            if (persons != null)
            {
                persons.ForEach(x =>
                {
                    TbTxt.Text += x.Id + " " + x.Name + Environment.NewLine;
                });
            }
        }
    }
    private void BtUpdate_Click(object sender,EventArgs e)
    {
        TbTxt.Text = "";
        UpdatePerson(TbUpdate.Text,DateTime.Now.ToString("mm:ss"));
        using (sqliteDb db = new sqliteDb())
        {
            List<Person> persons = db.Set<Person>().ToList();
            if (persons != null)
            {
                persons.ForEach(x =>
                {
                    TbTxt.Text += x.Id + " " + x.Name + Environment.NewLine;
                });
            }
        }
    }
    private void BtSelect_Click(object sender,EventArgs e)
    {
        TbTxt.Text = "";
        if (TbSelect.Text == "")
        {
            //查询所有人员信息
            using (sqliteDb db = new sqliteDb())
            {
                List<Person> persons = db.Set<Person>().ToList();
                if (persons != null)
                {
                    persons.ForEach(x =>
                    {
                        TbTxt.Text += x.Id + " " + x.Name + Environment.NewLine;
                    });
                }
            }
        }
        else
        {
            //根据Id查询人员
            using (sqliteDb db = new sqliteDb())
            {
                Person person = db.Set<Person>().Where(x => x.Id == TbSelect.Text).FirstOrDefault();
                TbTxt.Text = person.Id + " " + person.Name + Environment.NewLine;
            }
        }
    }
    #endregion
}

长了点，但一看就懂的。

五、异常处理

一、“System.InvalidOperationException”类型的未经处理的异常在 EntityFramework.dll 中发生

其他信息: No Entity Framework provider found for the ADO.NET provider with invariant name ‘System.Data.sqlite’. Make sure the provider is registered in the ‘entityFramework’ section of the application config file. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information.

解决：App.config中，使用NuGet安装了sqlite，sqlite.Core,EF……之后，默认的配置是这样的：

<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" />
</providers>

而异常提示 provider with invariant name ‘System.Data.sqlite’，所以只需要加上这行provider 配置就可以。

<providers>
  <provider invariantName="System.Data.sqlite" type="System.Data.sqlite.EF6.sqliteProviderServices,System.Data.sqlite.EF6" />
</providers>

二、“System.InvalidOperationException”类型的未经处理的异常在 EntityFramework.dll 中发生

其他信息: Unable to determine the principal end of an association between the types ‘sqliter.TestEF.DbTool.IdCard’ and ‘sqliter.TestEF.DbTool.Student’. The principal end of this association must be explicitly configured using either the relationship fluent API or data annotations.

解决：在MVC中如果数据库表关系是一对一的，需要加 [required] ，如：

public class Employee
{
    //员工必须有工牌
    [required]
    public virtual ECard ECard { get; set; }
}

三、“System.Data.Entity.Validation.DbEntityValidationException”类型的未经处理的异常在 EntityFramework.dll 中发生

其他信息: Validation Failed for one or more entities. See ‘EntityValidationErrors’ property for more details.

解决：检查是否有字段是必须的。

注：可以通过catch来获取更详细的提示：

catch (DbEntityValidationException dbEx)
{
    foreach (var validationErrors in dbEx.EntityValidationErrors)
    {
        foreach (var validationError in validationErrors.ValidationErrors)
        {
            Console.WriteLine(
                    "Class: {0},Property: {1},Error: {2}",validationErrors.Entry.Entity.GetType().FullName,validationError.PropertyName,validationError.ErrorMessage);
        }
    }
}

代码下载

完整源码