EFCore在Sqlite数据库中的应用实践

一、EF Core简介

1、Entity Framework (EF) Core 是轻量化、可扩展、开源和跨平台版的常用 Entity2、Framework 数据访问技术。

3、EF Core 可用作对象关系映射程序 (O/RM)，这可以实现以下两点：

a.使 .NET 开发人员能够使用.NET 对象处理数据库。

b.无需再像通常那样编写大部分数据访问代码。

4、EF Core 支持多个数据库引擎。

5、Code First ：先编写 C# 实体类，EF Core 会根据实体类之间的关系创建数据库；

6、Database First ：先设计和创建数据库，EF Core 根据数据库的表结构生成 C# 实体类。

二. SQLite 简介

SQLite 是一种轻量级、嵌入式的关系型数据库管理系统（RDBMS）。它是一个零配置的数据库引擎，不需要服务器，可以直接访问存储在文件中的数据库。SQLite 被广泛用于移动设备、嵌入式系统以及一些小型桌面应用程序中。

优点和特点:

1、零配置：无需服务器或配置，数据库就是一个普通文件。

2、轻量级：小巧、高效，适用于嵌入式设备和资源有限的环境。

3、跨平台：支持多种操作系统，包括 Windows、Linux、macOS 和各种嵌入式系统。

4、事务支持：支持 ACID（原子性、一致性、隔离性、持久性）事务特性。

三、 EF Core与SQLite数据库的结合使用

当我们使用 Entity Framework Core（EF Core）时，分层是一种良好的实践，它有助于代码的可维护性、可测试性和扩展性。以下是一个简单的 EF Core 分层应用的示例：

1、创建项目

①首先，创建一个新的.NET Core 项目

②安装 NuGet包

在项目目录中，安装以下Entity Framework Core 相关的 NuGet 包：

1、
Microsoft.EntityFrameworkCore

2、
Microsoft.EntityFrameworkCore.Design

3、
Microsoft.EntityFrameworkCore.Sqlite

2、创建实体类

①创建一个实体接口

public interface IEntityBase<TID>{   TID Id { get; set; }}

② 创建一个实体父类，让所有的实体类都继承自这个类

/// <summary>/// Entity父类/// </summary>public abstract class EntityBase : EntityBase<long>{}public abstract class EntityBase<TID> :IEntityBase<TID>{    [Key]    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]    public TID Id{ get; set; }}

③创建一个实体，让所有的实体类都继承自EntityBase这个父类，这将是数据库中的表。

public class UserEntity : UserEntity<long>{}[Table("t_info_Users")]public class UserEntity<TID> : EntityBase{    public string UserName { get; set; }    public string Email { get; set; }}

3、创建一个继承自 DbContext 的类，这个类将用于处理数据库交互

public class AppDbContext : DbContext{    public DbSet<UserEntity> UserEntity { get; set; }    // 其他实体类...    protected override voidOnConfiguring(DbContextOptionsBuilder options)     => options.UseSqlite($"Data Source=mydatabase.db");}

4、为了更好地组织代码，创建一个仓储类，处理对数据库的具体操作

①定义Repository接口，指定新增、删除等方法。

/// <summary>///Repository接口/// </summary>/// <typeparam name="T"></typeparam>public interface IRepository<T, TID>{    /// <summary>    /// 事务    /// </summary>    /// <returns></returns>    IDbContext Transaction BeginTransaction();    /// <summary>    /// 查询    /// </summary>    /// <returns></returns>    IQueryable<T> Query();    /// <summary>    /// 新增    /// </summary>    /// <param name="entity"></param>    void Add(T entity);        /// <summary>    /// 批量新增    /// </summary>    /// <param name="entity"></param>    void AddRange(IEnumerable<T> entity);    /// <summary>    /// 删除    /// </summary>    /// <param name="entity"></param>    void Delete(T entity);    /// <summary>    /// 同步保存    /// </summary>    /// <param name="entity"></param>     void Save();    /// <summary>    /// 批量删除    /// </summary>    /// <param name="entity"></param>    void RemoveRange(IEnumerable<T> entity);    /// <summary>    /// 异步保存    /// </summary>    /// <returns></returns>    Task SaveAsync();    /// <summary>    /// 获取上下文    /// </summary>    /// <returns></returns>    DbContext GetDbContext();}

②实现Repository类。

public class Repository<T, TID> : IDisposable, IRepository<T, TID> where T :EntityBase<TID>{    /// <summary>    /// DB上下文    /// </summary>    private DbContext Context;    /// <summary>    /// 实体集合    /// </summary>    private DbSet<T> DbSet;    public Repository()   {       Context = new AppDbContext();       DbSet = Context.Set<T>();    }    public Repository(DbContext context){       Context = context ?? new AppDbContext();       DbSet = Context.Set<T>();    }    ~Repository()    {       Context.Dispose();    }    publicDbContext GetDbContext()    {       return Context;    }    /// <summary>    /// 事务    /// </summary>    /// <returns></returns>    public IDbContextTransaction BeginTransaction(){       return Context.Database.BeginTransaction();    }    /// <summary>    /// 查询    /// </summary>    /// <returns></returns>    public IQueryable<T> Query()    {        return DbSet;    }    /// <summary>    /// 新增    /// </summary>    /// <param name="entity"></param>    public void Add(T entity){       DbSet.Add(entity);    }    /// <summary>    /// 批量新增    /// </summary>    /// <param name="entity"></param>    public voidAddRange(IEnumerable<T> entity){       DbSet.AddRange(entity);    }    /// <summary>    /// 删除    /// </summary>    /// <param name="entity"></param>    public void Delete(T entity){       DbSet.Remove(entity);    }    /// <summary>    /// 批量删除    /// </summary>    /// <param name="entity"></param>    public voidRemoveRange(IEnumerable<T> entity)    {       DbSet.RemoveRange(entity);    }    /// <summary>    /// 同步保存    /// </summary>    public void Save(){       Context.SaveChanges();    }    /// <summary>    /// 异步保存    /// </summary>    /// <returns></returns>    public TaskSaveAsync(){       return Context.SaveChangesAsync();    }    private bool disposedValue;    protected virtual void Dispose(bool disposing)    {       if (!disposedValue)       {           if (disposing)           {               Context.Dispose();               // TODO:释放托管状态(托管对象)           }           // TODO:释放未托管的资源(未托管的对象)并重写终结器           // TODO:将大型字段设置为 null           disposedValue = true;       }    }    // // TODO: 仅当“Dispose(bool disposing)”拥有用于释放未托管资源的代码时才替代终结器    // ~Repository()    // {    //    // 不要更改此代码。请将清理代码放入“Dispose(bool disposing)”方法中    //    Dispose(disposing: false);    // }    public void Dispose(){       // 不要更改此代码。请将清理代码放入“Dispose(bool disposing)”方法中       Dispose(disposing: true);       GC.SuppressFinalize(this);    }}

5、利用Repository实现一个表格的增删改查操作

①定义ServiceBase接口

public interface IServiceBase<T, TID> :IRepository<T, TID> where T : IEntityBase<TID>{    /// <summary>    /// 新增通过实体    /// </summary>    /// <param name="Entity"></param>    /// <returns></returns>    ExcuteResult InsertByEntity(T Entity);    /// <summary>    /// 批量新增通过实体    /// </summary>    /// <param name="Entities"></param>    /// <returns></returns>    ExcuteResult InsertByEntity(List<T> Entities);    /// <summary>    /// 删除通过ID    /// </summary>    /// <param name="id"></param>    /// <returns></returns>    ExcuteResult DeleteByID(TID id);    /// <summary>    /// 删除通过实体    /// </summary>    /// <param name="Entity"></param>    /// <returns></returns>    ExcuteResult DeleteByEntity(T Entity);    /// <summary>    /// 更新通过实体    /// </summary>    /// <param name="Entity"></param>    /// <returns></returns>    ExcuteResult UpdateByEntity(T Entity);    /// <summary>    /// 获取通过ID    /// </summary>    /// <param name="id"></param>    /// <returns></returns>    ExcuteResult<T> GetByID(TID id);    /// <summary>    /// 获取通过实体    /// </summary>    /// <param name="Entity"></param>    /// <returns></returns>    ExcuteResult<T> GetByEntity(T Entity);}

② 实现ServiceBase类,让所有用户服务类继承这个父类

public class ServiceBase<T, TID> : Repository<T, TID>, IServiceBase<T,TID> where T :EntityBase<TID>, new(){    public ServiceBase() : base()    {    }    public ServiceBase(AppDbContext appDbContext) : base(appDbContext)    {    }    public ExcuteResult InsertByEntity(T Entity)    {       try       {                  Add(Entity);           Save();           return ExcuteResult.CreateSuccessResult();       }       catch (Exception ex)       {           return new ExcuteResult($"增加{nameof(T)}失败:{ex.Message}");       }    }    public ExcuteResult InsertByEntity(List<T> Entities)    {       try       {           AddRange(Entities);           Save();           return ExcuteResult.CreateSuccessResult();       }       catch (Exception ex)       {           return new ExcuteResult($"增加{nameof(T)}失败:{ex.Message}");       }    }    public ExcuteResult DeleteByEntity(T Entity)    {       return DeleteByID(Entity.Id);    }    public ExcuteResult DeleteByID(TID id)    {       try       {           var Data = GetByID(id);           if (!Data.IsSuccess) return new ExcuteResult(Data.Message);           Delete(Data.Content);           Save();       }       catch (Exception ex)       {           return new ExcuteResult($"移除{nameof(T)}失败:{ex.Message}");       }       return ExcuteResult.CreateSuccessResult();    }    public ExcuteResult UpdateByEntity(T Entity)    {       try       {           if (Entity.Id == null)           return new ExcuteResult($"更新对象失败,对象的id为空!");           var ret = GetByID(Entity.Id);           if (ret.IsSuccess && ret.Content != null)           {               var retUpdate = ret.Content.UpdateEntityValue(Entity);               if (!retUpdate.IsSuccess)               return retUpdate;           }           else           {               return ret;           }           Save();       }       catch (Exception ex)       {           return new ExcuteResult($"增加{nameof(T)}失败:{ex.Message}");       }       return ExcuteResult.CreateSuccessResult();    }    public ExcuteResult<T> GetByEntity(T Entity)    {       return GetByID(Entity.Id);    }    public ExcuteResult<T> GetByID(TID id)    {       try       {           var Data = Query().Where(b => b.Id.Equals(id)).FirstOrDefault();           if (Data == null)           return new ExcuteResult<T>($"{typeof(T)}Id: {id} is null");           return ExcuteResult.CreateSuccessResult(Data);       }       catch (Exception ex)       {           return new ExcuteResult<T>(ex.Message);       }    }}

③创建用户服务接口

public interface IUserEntityService{    /// <summary>    /// 获取用户信息    /// </summary>    /// <param name="user"></param>    /// <returns></returns>    ExcuteResult<UserEntity> GetUserEntity(UserEntity user);    /// <summary>    /// 获取用户信息    /// </summary>    /// <param name="Id"></param>    /// <returns></returns>    ExcuteResult<UserEntity> GetUserEntityById(long Id);    /// <summary>    /// 添加用户信息    /// </summary>    /// <param name="user"></param>    /// <returns>ID</returns>    ExcuteResult InsetUserEntity(UserEntity user);    /// <summary>    /// 删除用户信息    /// </summary>    /// <param name="Id"></param>    /// <returns></returns>    ExcuteResult DeleteUserEntity(long Id);    /// <summary>    /// 批量添加    /// </summary>    /// <param name="users"></param>    /// <returns></returns>    ExcuteResult InsetUserEntity(List<UserEntity> users);    /// <summary>    /// 更新    /// </summary>    /// <param name="user"></param>    /// <returns></returns>    ExcuteResult UpdataUserEntity(UserEntity user);}

④实现用户服务接口

public class UserEntityService : IUserEntityService{      publiC ExcuteResult DeleteUserEntity(long Id)      {         using (var serviceBase = new ServiceBase<UserEntity, long>(new AppDbContext()))         {             return serviceBase.DeleteByID(Id);         }      }      public ExcuteResult<UserEntity> GetUserEntity(UserEntity user)      {         using (var serviceBase = new ServiceBase<UserEntity, long>(new AppDbContext()))         {             return serviceBase.GetByEntity(user);         }      }      public ExcuteResult<UserEntity> GetUserEntityById(long Id)      {           using (var serviceBase = new ServiceBase<UserEntity, long>(new AppDbContext()))           {               return serviceBase.GetByID(Id);           }      }      public ExcuteResult InsetUserEntity(UserEntity user)      {           using (var serviceBase = new ServiceBase<UserEntity, long>(new AppDbContext()))           {               return serviceBase.InsertByEntity(user);           }      }      public ExcuteResult InsetUserEntity(List<UserEntity> users)      {           using (var serviceBase = new ServiceBase<UserEntity, long>(new AppDbContext()))           {               return serviceBase.InsertByEntity(users);           }      }      public ExcuteResult UpdataUserEntity(UserEntity user)      {           using (var serviceBase = new ServiceBase<UserEntity, long>(new AppDbContext()))           {               return serviceBase.UpdateByEntity(user);           }      }}

6、在应用层注入服务类和仓储类，可以编写业务逻辑和调用仓储类。

四、数据库的迁移

Entity Framework Core（EF Core）支持 SQLite 数据库迁移。可以使用 EF Core 的 Migration 工具来管理 SQLite 数据库模式的变更。

以下是使用 EF Core 进行 SQLite 数据库迁移的一般步骤：

1、打开程序包管理控制台

2、生成迁移：Add-Migration InitialCreate

3、应用迁移：Update-Database