【asp.net core 系列】8 實戰之 利用 EF Core 完成資料操作層的實現

月影西下發表於2020-06-09
ASP.NET

0. 前言

通過前兩篇，我們建立了一個專案，並規定了一個基本的資料層訪問介面。這一篇，我們將以EF Core為例演示一下資料層訪問介面如何實現，以及實現中需要注意的地方。

1. 新增EF Core

先在資料層實現層引入 EF Core：

cd Domain.Implements
dotnet add package Microsoft.EntityFrameworkCore

當前專案以SqlLite為例，所以再新增一個SqlLite資料庫驅動：

dotnet add package Microsoft.EntityFrameworkCore.SQLite

刪除 Domain.Implements 裡預設的Class1.cs 檔案，然後新增Insfrastructure目錄，建立一個 DefaultContext：

using Microsoft.EntityFrameworkCore;

namespace Domain.Implements.Insfrastructure
{
    public class DefaultContext : DbContext
    {
        private string ConnectStr { get; }
        public DefaultContext(string connectStr)
        {
            ConnectStr = connectStr;
        }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            optionsBuilder.UseSqlite(ConnectStr);//如果需要別的資料庫，在這裡進行修改
        }
    }
}

2. EF Core 批量載入模型

通常情況下，在使用ORM的時候，我們不希望過度的使用特性來標註實體類。因為如果後期需要變更ORM或者出現其他變動的時候，使用特性來標註實體類的話，會導致遷移變得複雜。而且大部分ORM框架的特性都依賴於框架本身，並非是統一的特性結構，這樣就會造成一個後果：本來應該是對呼叫方隱藏的實現就會被公開，而且在專案引用關係中容易出現迴圈引用。

所以，我在開發中會尋找是否支援配置類，如果使用配置類或者在ORM框架中設定對映關係，那麼就可以保證資料層的純淨，也能實現對呼叫方隱藏實現。

EF Core的配置類我們在《C# 資料訪問系列》中關於EF的文章中介紹過，這裡就不做過多介紹了（沒來得及看的小夥伴們不著急，後續會有一個簡單版的介紹）。

通常情況下，配置類我也會放在Domain.Implements專案中。現在我給大家介紹一下如何快速批量載入配置類：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.ApplyConfigurationsFromAssembly(Assembly.GetAssembly(this.GetType()),
		t => t.GetInterfaces().Any(i => t.Name.Contains("IEntityTypeConfiguration")));
}

現在版本的EF Core支援通過Assembly載入配置類，可以指定載入當前上下文類所在的Assembly，然後篩選實現介面中包含IEntityTypeConfiguration的類即可。

3. 使用EF Core實現資料操作

我們已經建立好了一個EF Context，那麼現在就帶領大家一起看一下，如何使用EF來實現 上一篇《「asp.net core」7 實戰之 資料訪問層定義》中介紹的資料訪問介面：

新建一個BaseRepository類，在Domain.Implements專案的Insfrastructure 目錄下：

using Domain.Infrastructure;
using Microsoft.EntityFrameworkCore;

namespace Domain.Implements.Insfrastructure
{
    public abstract class BaseRepository<T> : ISearchRepository<T>, IModifyRepository<T> where T : class
    {
        public DbContext Context { get; }
        protected BaseRepository(DbContext context)
        {
            Context = context;
        }
    }
}

先建立以上內容，這裡給Repository傳參的時候，使用的是EFCore的預設Context類不是我們自己定義的。這是我個人習慣，實際上並沒有其他影響。主要是為了對實現類隱藏具體的EF 上下文實現類。

在實現各介面方法之前，建立如下屬性：

public DbSet<T> Set { get => Context.Set<T>(); }

這是EF運算元據的核心所在。

3.1 實現IModifyRepository介面

先實現修改介面：

public T Insert(T entity)
{   
    return Set.Add(entity).Entity;
}

public void Insert(params T[] entities)
{
    Set.AddRange(entities);
}

public void Insert(IEnumerable<T> entities)
{
    Set.AddRange(entities);
}
public void Update(T entity)
{
    Set.Update(entity);
}

public void Update(params T[] entities)
{
    Set.UpdateRange(entities);
}

public void Delete(T entity)
{
    Set.Remove(entity);
}

public void Delete(params T[] entities)
{
    Set.RemoveRange(entities);
}

在修改介面裡，我預留了幾個方法沒有實現，因為這幾個方法使用EF Core自身可以實現，但實現會比較麻煩，所以這裡藉助一個EF Core的外掛：

dotnet add package Z.EntityFramework.Plus.EFCore

這是一個免費開源的外掛，可以直接使用。在Domain.Implements 中新增後，在BaseRepository 中新增如下引用：

using System.Linq;
using System.Linq.Expressions;

實現方法：

public void Update(Expression<Func<T, bool>> predicate, Expression<Func<T, T>> updator)
{
    Set.Where(predicate).UpdateFromQuery(updator);
}

public void Delete(Expression<Func<T, bool>> predicate)
{
    Set.Where(predicate).DeleteFromQuery();
}

public void DeleteByKey(object key)
{
    Delete(Set.Find(key));
}

public void DeleteByKeys(params object[] keys)
{
    foreach (var k in keys)
    {
        DeleteByKey(k);
    }
}

這裡根據主鍵刪除的方法有個問題，我們無法根據條件進行刪除，實際上如果約定泛型T是BaseEntity的子類，我們可以獲取到主鍵，但是這樣又會引入另一個泛型，為了避免引入多個泛型根據主鍵的刪除就採用了這種方式。

3.2 實現ISearchRepository 介面

獲取資料以及基礎統計介面：

public T Get(object key)
{
    return Set.Find(key);
}

public T Get(Expression<Func<T, bool>> predicate)
{
    return Set.SingleOrDefault(predicate);
}

public int Count()
{
    return Set.Count();
}

public long LongCount()
{
    return Set.LongCount();
}

public int Count(Expression<Func<T, bool>> predicate)
{
    return Set.Count(predicate);
}

public long LongCount(Expression<Func<T, bool>> predicate)
{
    return Set.LongCount(predicate);
}

public bool IsExists(Expression<Func<T, bool>> predicate)
{
    return Set.Any(predicate);
}

這裡有一個需要關注的地方，在使用條件查詢單個資料的時候，我使用了SingleOrDefault而不是FirstOrDefault。這是因為我在這裡做了規定，如果使用條件查詢，呼叫方應該能預期所使用條件是能查詢出最多一條資料的。不過，這裡可以根據實際業務需要修改方法：

  • Single 返回單個資料，如果資料大於1或者等於0,則丟擲異常
  • SingleOrDefault 返回單個資料，如果結果集沒有資料，則返回null，如果多於1，則丟擲異常
  • First 返回結果集的第一個元素，如果結果集沒有資料，則丟擲異常
  • FirstOrDefault 返回結果集的第一個元素，如果沒有元素則返回null

實現查詢方法：

public List<T> Search()
{
    return Query().ToList();
}

public List<T> Search(Expression<Func<T, bool>> predicate)
{
    return Query(predicate).ToList();
}

public IEnumerable<T> Query()
{
    return Set;
}

public IEnumerable<T> Query(Expression<Func<T, bool>> predicate)
{
    return Set.Where(predicate);
}

public List<T> Search<P>(Expression<Func<T, bool>> predicate, Expression<Func<T, P>> order)
{
    return Search(predicate, order, false);
}

public List<T> Search<P>(Expression<Func<T, bool>> predicate, Expression<Func<T, P>> order, bool isDesc)
{
    var source = Set.Where(predicate);
    if (isDesc)
    {
        source = source.OrderByDescending(order);
    }
    else
    {
        source = source.OrderBy(order);
    }
    return source.ToList();
}

這裡我儘量通過呼叫了引數最多的方法來實現查詢功能，這樣有一個好處，小夥伴們可以想一下哈。當然了，這是我自己覺得這樣會好一點。

實現分頁：

在實現分頁之前，我們知道當時我們定義的分頁引數類的排序欄位用的是字串，而不是lambda表示式，而Linq To EF需要一個Lambda表示才可以進行排序。這裡就有兩種方案，可以自己寫一個方法，實現字串到Lambda表示式的轉換；第二種就是借用三方庫來實現，正好我們之前引用的EF Core增強外掛裡有這個功能：

var list = context.Customers.OrderByDescendingDynamic(x => "x.Name").ToList();

這是它給出的示例。

我們可以先依此來寫一份實現方法：

public PageModel<T> Search(PageCondition<T> condition)
{
    var result = new PageModel<T>
    {
        TotalCount = LongCount(condition.Predicate),
        CurrentPage = condition.CurrentPage,
        PerpageSize = condition.PerpageSize,
    };
    var source = Query(condition.Predicate);
    if (condition.Sort.ToUpper().StartsWith("a")) // asc
    {
        source = source.OrderByDynamic(t => $"t.{condition.OrderProperty}");
    }
    else // desc
    {
        source = source.OrderByDescendingDynamic(t => $"t.{condition.OrderProperty}");
    }
    var items = source.Skip((condition.CurrentPage -1)* condition.PerpageSize).Take(condition.PerpageSize);
    result.Items = items.ToList();
    return result;
}

回到第一種方案：

我們需要手動寫一個字串的處理方法，先在Utils專案建立以下目錄：Extend>Lambda，並在目錄中新增一個ExtLinq類，程式碼如下：

using System.Linq;
using System.Linq.Expressions;
using System.Text.RegularExpressions;

namespace Utils.Extend.Lambda
{
    public static class ExtLinq
    {
        public static IQueryable<T> CreateOrderExpression<T>(this IQueryable<T> source, string orderBy, string orderAsc)
        {
            if (string.IsNullOrEmpty(orderBy)|| string.IsNullOrEmpty(orderAsc)) return source;
            var isAsc = orderAsc.ToLower() == "asc";
            var _order = orderBy.Split(',');
            MethodCallExpression resultExp = null;
            foreach (var item in _order)
            {
                var orderPart = item;
                orderPart = Regex.Replace(orderPart, @"\s+", " ");
                var orderArry = orderPart.Split(' ');
                var orderField = orderArry[0];
                if (orderArry.Length == 2)
                {
                    isAsc = orderArry[1].ToUpper() == "ASC";
                }
                var parameter = Expression.Parameter(typeof(T), "t");
                var property = typeof(T).GetProperty(orderField);
                var propertyAccess = Expression.MakeMemberAccess(parameter, property);
                var orderByExp = Expression.Lambda(propertyAccess, parameter);
                resultExp = Expression.Call(typeof(Queryable), isAsc ? "OrderBy" : "OrderByDescending",
                    new[] {typeof(T), property.PropertyType},
                    source.Expression, Expression.Quote(orderByExp));
            }

            return resultExp == null
                ? source
                : source.Provider.CreateQuery<T>(resultExp);
        }
    }
}

暫時不用關心為什麼這樣寫，後續會為大家分析的。

然後回過頭來再實現我們的分頁，先新增Utils 到Domain.Implements專案中

cd ../Domain.Implements # 進入Domain.Implements 專案目錄
dotnet add reference ../Utils

public PageModel<T> Search(PageCondition<T> condition)
{
    var result = new PageModel<T>
    {
        TotalCount = LongCount(condition.Predicate),
        CurrentPage = condition.CurrentPage,
        PerpageSize = condition.PerpageSize,
    };
    var source = Set.Where(condition.Predicate).CreateOrderExpression(condition.OrderProperty, condition.Sort);
    var items = source.Skip((condition.CurrentPage -1)* condition.PerpageSize).Take(condition.PerpageSize);
    result.Items = items.ToList();
    return result;
}

記得新增引用：

using Utils.Extend.Lambda;

在做分頁的時候，因為前臺傳入的引數大多都是字串的排序欄位，所以到後端需要程式字串到欄位的處理。這裡的處理利用了C# Expression的一個技術，這裡就不做過多介紹了。後續在.net core高階篇中會有介紹。

4. 總結

到目前為止，看起來我們已經成功實現了利用EF Core為我們達成 資料操作和查詢的目的。但是，別忘了EF Core需要手動呼叫一個SaveChanges方法。下一篇，我們將為大家介紹如何優雅的執行SaveChanges方法。

這一篇介紹到這裡，雖然說明不是很多，但是這也是我在開發中總結的經驗。

更多內容煩請關注我的部落格《高先生小屋》

file

相關文章