【asp.net core 系列】9 實戰之 UnitOfWork以及自定義程式碼生成

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

0. 前言

在前一篇中我們建立了一個基於EF的資料查詢介面實現基類，這一篇我將帶領大家講一下為這EF補充一些功能，並且提供一個解決避免寫大量配置類的方案。

1. SaveChanges的外移

在之前介紹EF Core的時候，我們提到過使用EF需要在每次使用之後，呼叫一次SaveChanges將資料提交給資料庫。在實際開發中，我們不能新增一條資料或者做一次修改就呼叫一次SaveChanges，這完全不現實。因為每次呼叫SaveChanges是EF向資料庫提交變更的時候，所以EF推薦的是每次執行完使用者的請求之後統一提交資料給資料庫。

這樣就會造成一個問題，可能也不是問題：我們需要一個介面來管理EF 的SaveChanges操作。

1.1 建立一個IUnitOfWork介面

通常我們會在Domain專案中新增一個IUnitOfWork介面，這個介面有一個方法就是SaveChanges，程式碼如下：

namespace Domain.Insfrastructure
{
    public interface IUnitOfWork
    {
        void SaveChanges();
    }
}

這個方法的意思表示到執行該方法的時候，一個完整的工作流程執行完成了。也就是說，當執行該方法後，當前請求不會再與資料庫發生連線。

1.2 實現IUnitOfWork介面

在 Domain.Implement中新增IUnitOfWork實現類：

using Domain.Insfrastructure;
using Microsoft.EntityFrameworkCore;

namespace Domain.Implements.Insfrastructure
{
    public class UnitOfWork: IUnitOfWork
    {
        private DbContext DbContext;
        public UnitOfWork(DbContext context)
        {
            DbContext = context;
        }

        public void SaveChanges()
        {
            DbContext.SaveChanges();
        }
    }
}

1.3 呼叫時機

到現在我們已經建立了一個UnitOfWork的方法，那麼問題來了，我們該在什麼時候呼叫呢，或者說如何呼叫呢？

我的建議是建立一個ActionFilter，針對所有的控制器進行SaveChanges進行處理。當然了，也可以在控制器中持有一個IUnitOfWork的示例，然後在Action結束的時候，執行SaveChanges。不過這樣存在一個問題，可能會存在遺漏的方法。所以我推薦這樣操作，這裡簡單演示一下如何建立攔截器：

在Web的根目錄下，建立一個Filters目錄，這個目錄裡用來儲存一些過濾器，建立我們需要的過濾器：

using Domain.Insfrastructure;
using Microsoft.AspNetCore.Mvc.Filters;

namespace Web.Filters
{
    public class UnitOfWorkFilterAttribute : ActionFilterAttribute
    {
        public IUnitOfWork UnitOfWork;

        public override void OnActionExecuted(ActionExecutedContext context)
        {
            UnitOfWork.SaveChanges();
        }
    }
}

使用一個ActionFilter可以很方便的解決一些容易遺漏但又必須執行的程式碼。這裡就先不介紹如何配置Filter的啟用和詳細介紹了，請允許我賣個關子。當然了，有些小夥伴肯定也能猜到這是一個Attribute類，所以可以按照Attribute給Controller打標記。

2. 建立一個簡單的程式碼生成方法

之前在介紹EF的時候，有個小夥伴跟我說，還要寫配置檔案啊，太麻煩了。是的，之前我介紹了很多關於寫配置檔案不使用特性的好處，但不解決這個問題就無法真正體檢配置類的好處。

雖然說，EF Core約定優先，但是如果預設約定的話，得在DBContext中宣告 DbSet<T> 來宣告這個欄位，實體類少的話，比較簡單。如果多個資料表的話，就會非常麻煩。

所以這時候就要使用工具類， 那麼簡單的分析一下，這個工具類需要有哪些功能：

  • 第一步，找到實體類並解析出實體類的類名
  • 第二步，生成配置檔案
  • 第三步，建立對應的Repository介面和實現類

很簡單的三步，但是難點就是找實體類並解析出實體類名。

在Util專案中新增一個Develop目錄，並建立Develop類：

namespace Utils.Develop
{
    public class Develop
    {
        
    }
}

定位當前類所在目錄，通過

Directory.GetCurrentDirectory()

這個方法可以獲取當前執行的DLL所在目錄，當然不同的編譯器在執行的時候，會有微妙的不同。所以我們需要以此為根據然後獲取專案的根目錄，一個簡單的方法，查詢*.sln 所在目錄：

public static string CurrentDirect
{
    get
    {
        var execute = Directory.GetCurrentDirectory();
        var parent = Directory.GetParent(execute);
        while(parent.GetFiles("*.sln",SearchOption.TopDirectoryOnly).Length == 0)
        {
            parent = parent.Parent;
            if(parent == null)
            {
                return null;
            }
        }
        return parent.FullName;
    }
}

2.1 獲取實體類

那麼獲取到根目錄之後，我們下一步就是獲取實體類。因為我們的實體類都要求是繼承BaseEntity或者名稱空間都是位於Data.Models下面。當然這個名稱都是根據實際業務場景約束的，這裡只是以當前專案舉例。那麼，我們可以通過以下方法找到我們設定的實體類：

public static Type[] LoadEntities()
{
    var assembly = Assembly.Load("Data");
    var allTypes = assembly.GetTypes();
    var ofNamespace = allTypes.Where(t => t.Namespace == "Data.Models" || t.Namespace.StartsWith("Data.Models."));
    var subTypes = allTypes.Where(t => t.BaseType.Name == "BaseEntity`1");
    return ofNamespace.Union(subTypes).ToArray();
}

通過 Assembly載入Data的程式集，然後選擇出符合我們要求的實體類。

2.2 編寫Repository介面

我們先約定Model的Repository介面定義在 Domain/Repository目錄下，所以它們的名稱空間應該是：

namespace Domain.Repository	
{
}

假設目錄情況與Data/Models下面的程式碼結構保持一致，然後生成程式碼應該如下：

public static void CreateRepositoryInterface(Type type)
{
    var targetNamespace = type.Namespace.Replace("Data.Models", "");
    if (targetNamespace.StartsWith("."))
    {
        targetNamespace = targetNamespace.Remove(0);
    }
    var targetDir = Path.Combine(new[]{CurrentDirect,"Domain", "Repository"}.Concat(
        targetNamespace.Split('.')).ToArray());
    if (!Directory.Exists(targetDir))
    {
        Directory.CreateDirectory(targetDir);
    }

    var baseName = type.Name.Replace("Entity","");

    if (!string.IsNullOrEmpty(targetNamespace))
    {
        targetNamespace = $".{targetNamespace}";
    }
    var file = $"using {type.Namespace};\r\n"
        + $"using Domain.Insfrastructure;\r\n"
        + $"namespace Domain.Repository{targetNamespace}\r\n"
        + "{\r\n"
        + $"\tpublic interface I{baseName}ModifyRepository : IModifyRepository<{type.Name}>\r\n" +
        "\t{\r\n\t}\r\n"
        + $"\tpublic interface I{baseName}SearchRepository : ISearchRepository<{type.Name}>\r\n" +
        "\t{\r\n\t}\r\n}";

    File.WriteAllText(Path.Combine(targetDir, $"{baseName}Repository.cs"), file);
}

2.3 編寫Repository的實現類

因為我們提供了一個基類，所以我們在生成方法的時候，推薦繼承這個類，那麼實現方法應該如下：

public static void CreateRepositoryImplement(Type type)
{
    var targetNamespace = type.Namespace.Replace("Data.Models", "");
    if (targetNamespace.StartsWith("."))
    {
        targetNamespace = targetNamespace.Remove(0);
    }

    var targetDir = Path.Combine(new[] {CurrentDirect, "Domain.Implements", "Repository"}.Concat(
        targetNamespace.Split('.')).ToArray());
    if (!Directory.Exists(targetDir))
    {
        Directory.CreateDirectory(targetDir);
    }
    var baseName = type.Name.Replace("Entity", "");
    if (!string.IsNullOrEmpty(targetNamespace))
    {
        targetNamespace = $".{targetNamespace}";
    }

    var file = $"using {type.Namespace};" +
        $"\r\nusing Domain.Implements.Insfrastructure;" +
        $"\r\nusing Domain.Repository{targetNamespace};" +
        $"\r\nusing Microsoft.EntityFrameworkCore;" +
        $"namespace Domain.Implements.Repository{targetNamespace}\r\n" +
        "{" +
        $"\r\n\tpublic class {baseName}Repository :BaseRepository<{type.Name}> ,I{baseName}ModifyRepository,I{baseName}SearchRepository " +
        "\r\n\t{" +
        $"\r\n\t\tpublic {baseName}Repository(DbContext context) : base(context)"+
        "\r\n\t\t{"+
        "\r\n\t\t}\r\n"+
        "\t}\r\n}";
    File.WriteAllText(Path.Combine(targetDir, $"{baseName}Repository.cs"), file);
}

2.4 配置檔案的生成

仔細觀察一下程式碼，可以發現整體都是十分簡單的。所以這篇就不掩飾如何生成配置檔案了，小夥伴們可以自行嘗試一下哦。具體實現可以等一下篇哦。

3. 總結

這一篇初略的介紹了兩個用來輔助EF Core實現的方法或類，這在開發中很重要。UnitOfWork用來確保一次請求一個工作流程，簡單的程式碼生成類讓我們能讓我們忽略那些繁重的建立同類程式碼的工作。

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

file

相關文章