【asp.net core 系列】9 實(shí)戰(zhàn)之 UnitOfWork以及自定義代碼生成

0. 前言

在前一篇中我們創(chuàng)建了一個(gè)基于EF的數(shù)據(jù)查詢接口實(shí)現(xiàn)基類，這一篇我將帶領(lǐng)大家講一下為這EF補(bǔ)充一些功能，并且提供一個(gè)解決避免寫大量配置類的方案。

1. SaveChanges的外移

在之前介紹EF Core的時(shí)候，我們提到過(guò)使用EF需要在每次使用之后，調(diào)用一次SaveChanges將數(shù)據(jù)提交給數(shù)據(jù)庫(kù)。在實(shí)際開(kāi)發(fā)中，我們不能添加一條數(shù)據(jù)或者做一次修改就調(diào)用一次SaveChanges，這完全不現(xiàn)實(shí)。因?yàn)槊看握{(diào)用SaveChanges是EF向數(shù)據(jù)庫(kù)提交變更的時(shí)候，所以EF推薦的是每次執(zhí)行完用戶的請(qǐng)求之后統(tǒng)一提交數(shù)據(jù)給數(shù)據(jù)庫(kù)。

這樣就會(huì)造成一個(gè)問(wèn)題，可能也不是問(wèn)題：我們需要一個(gè)接口來(lái)管理EF 的SaveChanges操作。

1.1 創(chuàng)建一個(gè)IUnitOfWork接口

通常我們會(huì)在Domain項(xiàng)目中添加一個(gè)IUnitOfWork接口，這個(gè)接口有一個(gè)方法就是SaveChanges，代碼如下：

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

這個(gè)方法的意思表示到執(zhí)行該方法的時(shí)候，一個(gè)完整的工作流程執(zhí)行完成了。也就是說(shuō)，當(dāng)執(zhí)行該方法后，當(dāng)前請(qǐng)求不會(huì)再與數(shù)據(jù)庫(kù)發(fā)生連接。

1.2 實(shí)現(xiàn)IUnitOfWork接口

在 Domain.Implement中添加IUnitOfWork實(shí)現(xiàn)類：

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 調(diào)用時(shí)機(jī)

到現(xiàn)在我們已經(jīng)創(chuàng)建了一個(gè)UnitOfWork的方法，那么問(wèn)題來(lái)了，我們?cè)撛谑裁磿r(shí)候調(diào)用呢，或者說(shuō)如何調(diào)用呢？

我的建議是創(chuàng)建一個(gè)ActionFilter，針對(duì)所有的控制器進(jìn)行SaveChanges進(jìn)行處理。當(dāng)然了，也可以在控制器中持有一個(gè)IUnitOfWork的示例，然后在Action結(jié)束的時(shí)候，執(zhí)行SaveChanges。不過(guò)這樣存在一個(gè)問(wèn)題，可能會(huì)存在遺漏的方法。所以我推薦這樣操作，這里簡(jiǎn)單演示一下如何創(chuàng)建攔截器：

在Web的根目錄下，創(chuàng)建一個(gè)Filters目錄，這個(gè)目錄里用來(lái)存儲(chǔ)一些過(guò)濾器，創(chuàng)建我們需要的過(guò)濾器：

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();
        }
    }
}

使用一個(gè)ActionFilter可以很方便的解決一些容易遺漏但又必須執(zhí)行的代碼。這里就先不介紹如何配置Filter的啟用和詳細(xì)介紹了，請(qǐng)?jiān)试S我賣個(gè)關(guān)子。當(dāng)然了，有些小伙伴肯定也能猜到這是一個(gè)Attribute類，所以可以按照Attribute給Controller打標(biāo)記。

2. 創(chuàng)建一個(gè)簡(jiǎn)單的代碼生成方法

之前在介紹EF的時(shí)候，有個(gè)小伙伴跟我說(shuō)，還要寫配置文件啊，太麻煩了。是的，之前我介紹了很多關(guān)于寫配置文件不使用特性的好處，但不解決這個(gè)問(wèn)題就無(wú)法真正體檢配置類的好處。

雖然說(shuō)，EF Core約定優(yōu)先，但是如果默認(rèn)約定的話，得在DBContext中聲明 DbSet<T> 來(lái)聲明這個(gè)字段，實(shí)體類少的話，比較簡(jiǎn)單。如果多個(gè)數(shù)據(jù)表的話，就會(huì)非常麻煩。

所以這時(shí)候就要使用工具類， 那么簡(jiǎn)單的分析一下，這個(gè)工具類需要有哪些功能：

  • 第一步，找到實(shí)體類并解析出實(shí)體類的類名
  • 第二步，生成配置文件
  • 第三步，創(chuàng)建對(duì)應(yīng)的Repository接口和實(shí)現(xiàn)類

很簡(jiǎn)單的三步，但是難點(diǎn)就是找實(shí)體類并解析出實(shí)體類名。

在Util項(xiàng)目中添加一個(gè)Develop目錄，并創(chuàng)建Develop類：

namespace Utils.Develop
{
    public class Develop
    {
        
    }
}

定位當(dāng)前類所在目錄，通過(guò)

Directory.GetCurrentDirectory()

這個(gè)方法可以獲取當(dāng)前執(zhí)行的DLL所在目錄，當(dāng)然不同的編譯器在執(zhí)行的時(shí)候，會(huì)有微妙的不同。所以我們需要以此為根據(jù)然后獲取項(xiàng)目的根目錄，一個(gè)簡(jiǎn)單的方法，查找*.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 獲取實(shí)體類

那么獲取到根目錄之后，我們下一步就是獲取實(shí)體類。因?yàn)槲覀兊膶?shí)體類都要求是繼承BaseEntity或者命名空間都是位于Data.Models下面。當(dāng)然這個(gè)名稱都是根據(jù)實(shí)際業(yè)務(wù)場(chǎng)景約束的，這里只是以當(dāng)前項(xiàng)目舉例。那么，我們可以通過(guò)以下方法找到我們?cè)O(shè)置的實(shí)體類：

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();
}

通過(guò) Assembly加載Data的程序集，然后選擇出符合我們要求的實(shí)體類。

2.2 編寫Repository接口

我們先約定Model的Repository接口定義在 Domain/Repository目錄下，所以它們的命名空間應(yīng)該是：

namespace Domain.Repository 
{
}

假設(shè)目錄情況與Data/Models下面的代碼結(jié)構(gòu)保持一致，然后生成代碼應(yīng)該如下：

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的實(shí)現(xiàn)類

因?yàn)槲覀兲峁┝艘粋€(gè)基類，所以我們?cè)谏煞椒ǖ臅r(shí)候，推薦繼承這個(gè)類，那么實(shí)現(xiàn)方法應(yīng)該如下：

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 配置文件的生成

仔細(xì)觀察一下代碼，可以發(fā)現(xiàn)整體都是十分簡(jiǎn)單的。所以這篇就不掩飾如何生成配置文件了，小伙伴們可以自行嘗試一下哦。具體實(shí)現(xiàn)可以等一下篇哦。

3. 總結(jié)

這一篇初略的介紹了兩個(gè)用來(lái)輔助EF Core實(shí)現(xiàn)的方法或類，這在開(kāi)發(fā)中很重要。UnitOfWork用來(lái)確保一次請(qǐng)求一個(gè)工作流程，簡(jiǎn)單的代碼生成類讓我們能讓我們忽略那些繁重的創(chuàng)建同類代碼的工作。

更多內(nèi)容煩請(qǐng)關(guān)注我的博客《高先生小屋》

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容