.net如何優(yōu)雅的使用EFCore實例詳解

更新時間：2022年11月28日 16:04:37 作者：BruceNeter

這篇文章主要為大家介紹了.net如何優(yōu)雅的使用EFCore實例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

正文

EFCore是微軟官方的一款ORM框架，主要是用于實體和數(shù)據(jù)庫對象之間的操作。功能非常強大，在老版本的時候叫做EF，后來.net core問世，EFCore也隨之問世。

本文我們將用一個控制臺項目Host一個web服務(wù)，并且使用本地Mysql作為數(shù)據(jù)庫，使用EFCore的Code First模式進行數(shù)據(jù)操作。

DBSet清除計劃

以前使用EF/EFCore的開發(fā)者應(yīng)該都記得，需要在DBContext里寫好多DBSet，一個表對應(yīng)一個DBSet，然后在其他地方操作這些DBSet對相關(guān)的表進行增刪改查。作為一個開發(fā)，這些重復(fù)操作都是我們希望避免的，我們可以利用反射機制將這些類型通過框架自帶的方法循環(huán)注冊進去。

1.EF實體繼承統(tǒng)一的接口，方便我們反射獲取所有EF實體，接口可以設(shè)置一個泛型，來泛化我們的主鍵類型，因為可能存在不同的表的主鍵類型也不一樣。

統(tǒng)一的EF實體接口

public interface IEFEntity<TKey>
{
    public TKey Id { get; set; }
}

統(tǒng)一的接口實現(xiàn)類

public abstract class AggregateRoot<TKey> : IEFEntity<TKey>
{
    public TKey Id { get; set; }
}

用戶實體類

public class User : AggregateRoot<string>
{
    public string UserName { get; set; }
    public DateTime Birthday { get; set; }
    public virtual ICollection<Book> Books { get; set; }
}

2.利用反射獲取某個程序集下所有的實體類

public class EFEntityInfo
{
    public (Assembly Assembly, IEnumerable<Type> Types) EFEntitiesInfo => (GetType().Assembly, GetEntityTypes(GetType().Assembly));
    private IEnumerable<Type> GetEntityTypes(Assembly assembly)
    {
        //獲取當前程序集下所有的實現(xiàn)了IEFEntity的實體類
        var efEntities = assembly.GetTypes().Where(m => m.FullName != null
                                                        && Array.Exists(m.GetInterfaces(), t => t.IsGenericType && t.GetGenericTypeDefinition() == typeof(IEFEntity<>))
                                                        && !m.IsAbstract && !m.IsInterface).ToArray();
        return efEntities;
    }
}

3.DBContext實現(xiàn)類中OnModelCreating方法中注冊這些類型

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    //循環(huán)實體類型，并且通過Entity方法注冊類型
    foreach (var entityType in Types)
    {
        modelBuilder.Entity(entityType);
    }
    base.OnModelCreating(modelBuilder);
}

至此為止所有的實體類都被注冊到DBContext中作為DBSets,再也不需要一個個寫DBSet了，可以用過DbContext.Set<User>()獲取用戶的DBSet。

IEntityTypeConfiguration(表配置)

用數(shù)據(jù)庫創(chuàng)建過表的同學(xué)都知道，在設(shè)計表的時候，可以給表添加很多配置和約束，在Code First模式中，很多同學(xué)都是在對象中通過注解的方式配置字段。如下就配置了用戶名是不能為NULL和最大長度為500

[Required]
[MaxLength(500)]
public string UserName { get; set; }

也有的同學(xué)在DbContext中的OnModelCreating方法配置

modelBuilder.Entity<User>().Property(x => x.UserName).IsRequired();

這兩種方法，前者入侵行太強，直接代碼耦合到實體類中了，后者不夠清楚，把一大堆表的配置寫在一個方法里，當然了很多人說可以拆分不同的方法或者使用注釋分開。但是！不夠優(yōu)雅！
我們可以使用IEntityTypeConfiguration接口實現(xiàn)我們所想的優(yōu)雅的表配置。
1.創(chuàng)建一個配置基類，繼承自IEntityTypeConfiguration，做一些通用的配置，比如設(shè)置主鍵，一般都是id啦，還有軟刪除等。

public abstract class EntityTypeConfiguration<TEntity, TKey> : IEntityTypeConfiguration<TEntity>
       where TEntity : AggregateRoot<TKey>
{
    public virtual void Configure(EntityTypeBuilder<TEntity> builder)
    {
        var entityType = typeof(TEntity);
        builder.HasKey(x => x.Id);
        if (typeof(ISoftDelete).IsAssignableFrom(entityType))
        {
            builder.HasQueryFilter(d => EF.Property<bool>(d, "IsDeleted") == false);
        }
    }
}

2.創(chuàng)建用戶實體/表獨有的配置，比如設(shè)置用戶名的最大長度，以及seed一些數(shù)據(jù)

public class UserConfig : EntityTypeConfiguration<User, string>
{
    public override void Configure(EntityTypeBuilder<User> builder)
    {
        base.Configure(builder);
        builder.Property(x => x.UserName).HasMaxLength(50);
        //mock一條數(shù)據(jù)
        builder.HasData(new User()
        {
            Id = "090213204",
            UserName = "Bruce",
            Birthday = DateTime.Parse("1996-08-24")
        });
    }
}

當然還有很多配置可以設(shè)置，比如索引，導(dǎo)航屬性，唯一鍵等。如下圖書實體

public class BookConfig : EntityTypeConfiguration<Book, long>
{
    public override void Configure(EntityTypeBuilder<Book> builder)
    {
        base.Configure(builder);
        builder.Property(x => x.Id).ValueGeneratedOnAdd(); //設(shè)置book的id自增
        builder.Property(x => x.BookName).HasMaxLength(500).IsRequired();
        builder.HasIndex(x => x.Author);//作者添加索引
        builder.HasIndex(x => x.SN).IsUnique();//序列號添加唯一索引
        builder.HasOne(r => r.User).WithMany(x=>x.Books)
            .HasForeignKey(r => r.UserId).IsRequired();//導(dǎo)航屬性，本質(zhì)就是創(chuàng)建外鍵，雖然查詢很方便，生產(chǎn)中不建議使用?。?！
    }
}

3.DBContext中應(yīng)用配置

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.HasCharSet("utf8mb4 ");
    var (Assembly, Types) = _efEntitysInfo.EFEntitiesInfo;
    foreach (var entityType in Types)
    {
        modelBuilder.Entity(entityType);
    }
    //只需要將配置類所在的程序集給到，它會自動加載
    modelBuilder.ApplyConfigurationsFromAssembly(Assembly);
    base.OnModelCreating(modelBuilder);
}

Repository(倉儲)

這個不過分介紹，特別是基于http的微服務(wù)中基本都有這個。

1.創(chuàng)建一個倉儲基類，對于不同的實體，創(chuàng)建一樣的增刪改查方法。

簡單寫幾個查詢的方法定義。

public interface IAsyncRepository<TEntity, Tkey> where TEntity : class
{
    IQueryable<TEntity> All();
    IQueryable<TEntity> All(string[] propertiesToInclude);
    IQueryable<TEntity> Where(Expression<Func<TEntity, bool>> filter);
    IQueryable<TEntity> Where(Expression<Func<TEntity, bool>> filter, string[] propertiesToInclude);
}

2.創(chuàng)建倉儲實現(xiàn)類，將DBContext注入到構(gòu)造中

public class GenericRepository<TEntity, Tkey> : IAsyncRepository<TEntity, Tkey> where TEntity : class
{
    protected readonly LibraryDbContext _dbContext;
    public GenericRepository(LibraryDbContext dbContext)
    {
        _dbContext = dbContext;
    }
    ~GenericRepository()
    {
        _dbContext?.Dispose();
    }
    public virtual IQueryable<TEntity> All()
    {
        return All(null);
    }
    public virtual IQueryable<TEntity> All(string[] propertiesToInclude)
    {
        var query = _dbContext.Set<TEntity>().AsNoTracking();
        if (propertiesToInclude != null)
        {
            foreach (var property in propertiesToInclude.Where(p => !string.IsNullOrWhiteSpace(p)))
            {
                query = query.Include(property);
            }
        }
        return query;
    }
}

Autofac

1.注入DBContext到Repository的構(gòu)造方法中，并且注入Repository

public class EFCoreEleganceUseEFCoreModule : Module
{
    protected override void Load(ContainerBuilder builder)
    {
        base.Load(builder);
        builder.RegisterModule<EFCoreEleganceUseDomainModule>(); //注入domain模塊
        builder.RegisterGeneric(typeof(GenericRepository<,>))//將dbcontext注入到倉儲的構(gòu)造中
                .UsingConstructor(typeof(LibraryDbContext))
                .AsImplementedInterfaces()
                .InstancePerDependency();
        builder.RegisterType<WorkUnit>().As<IWorkUnit>().InstancePerDependency();
    }
}

2.Domain注入EFEntityInfo

public class EFCoreEleganceUseDomainModule : Module
{
    protected override void Load(ContainerBuilder builder)
    {
        builder.RegisterType<EFEntityInfo>().SingleInstance();
    }
}

數(shù)據(jù)庫配置

1.注入DBContext，從配置文件讀取數(shù)據(jù)庫配置，然后根據(jù)開發(fā)/生產(chǎn)環(huán)境做一些特殊處理

var mysqlConfig = hostContext.Configuration.GetSection("Mysql").Get<MysqlOptions>();
var serverVersion = new MariaDbServerVersion(new Version(mysqlConfig.Version));
services.AddDbContextFactory<LibraryDbContext>(options =>
{
    options.UseMySql(mysqlConfig.ConnectionString, serverVersion, optionsBuilder =>
    {
        optionsBuilder.MinBatchSize(4);
        optionsBuilder.CommandTimeout(10);
        optionsBuilder.MigrationsAssembly(mysqlConfig.MigrationAssembly);//遷移文件所在的程序集
        optionsBuilder.UseQuerySplittingBehavior(QuerySplittingBehavior.SplitQuery);
    }).UseQueryTrackingBehavior(QueryTrackingBehavior.NoTracking);
    //開發(fā)環(huán)境可以打開日志記錄和顯示詳細的錯誤
    if (hostContext.HostingEnvironment.IsDevelopment())
    {
        options.EnableSensitiveDataLogging();
        options.EnableDetailedErrors();
    }
});