[Abp vNext 源碼分析] - 8. 審計日誌

来源:https://www.cnblogs.com/myzony/archive/2019/10/08/11634428.html

一、簡要說明 ABP vNext 當中的審計模塊早在 "依賴註入與攔截器" 一文中有所提及,但沒有詳細的對其進行分析。 審計模塊是 ABP vNext 框架的一個基本組件,它能夠提供一些實用日誌記錄。不過這裡的日誌不是說系統日誌,而是說介面每次調用之後的執行情況(執行時間、傳入參數、異常信息、請求 ...


一、簡要說明

ABP vNext 當中的審計模塊早在 依賴註入與攔截器一文中有所提及,但沒有詳細的對其進行分析。

審計模塊是 ABP vNext 框架的一個基本組件,它能夠提供一些實用日誌記錄。不過這裡的日誌不是說系統日誌,而是說介面每次調用之後的執行情況(執行時間、傳入參數、異常信息、請求 IP)。

除了常規的日誌功能以外,關於 實體聚合 的審計欄位介面也是存放在審計模塊當中的。(創建人創建時間修改人修改時間刪除人刪除時間

二、源碼分析

2.1. 審計日誌攔截器

2.1.1 審計日誌攔截器的註冊

Volo.Abp.Auditing 的模塊定義十分簡單,主要是提供了 審計日誌攔截器 的註冊功能。下麵代碼即在組件註冊的時候,會調用 AuditingInterceptorRegistrar.RegisterIfNeeded 方法來判定是否為實現類型(ImplementationType) 註入審計日誌攔截器。

public class AbpAuditingModule : AbpModule
{
    public override void PreConfigureServices(ServiceConfigurationContext context)
    {
        context.Services.OnRegistred(AuditingInterceptorRegistrar.RegisterIfNeeded);
    }
}

跳轉到具體的實現,可以看到內部會結合三種類型進行判斷。分別是 AuditedAttributeIAuditingEnabledDisableAuditingAttribute

前兩個作用是,只要類型標註了 AuditedAttribute 特性,或者是實現了 IAuditingEnable 介面,都會為該類型註入審計日誌攔截器。

DisableAuditingAttribute 類型則相反,只要類型上標註了該特性,就不會啟用審計日誌攔截器。某些介面需要 提升性能 的話,可以嘗試使用該特性禁用掉審計日誌功能。

public static class AuditingInterceptorRegistrar
{
    public static void RegisterIfNeeded(IOnServiceRegistredContext context)
    {
        // 滿足條件時,將會為該類型註入審計日誌攔截器。
        if (ShouldIntercept(context.ImplementationType))
        {
            context.Interceptors.TryAdd<AuditingInterceptor>();
        }
    }

    private static bool ShouldIntercept(Type type)
    {
        // 首先判斷類型上面是否使用了輔助類型。
        if (ShouldAuditTypeByDefault(type))
        {
            return true;
        }

        // 如果任意方法上面標註了 AuditedAttribute 特性,則仍然為該類型註入攔截器。
        if (type.GetMethods().Any(m => m.IsDefined(typeof(AuditedAttribute), true)))
        {
            return true;
        }

        return false;
    }

    //TODO: Move to a better place
    public static bool ShouldAuditTypeByDefault(Type type)
    {
        // 下麵就是根據三種輔助類型進行判斷,是否為當前 type 註入審計日誌攔截器。
        if (type.IsDefined(typeof(AuditedAttribute), true))
        {
            return true;
        }

        if (type.IsDefined(typeof(DisableAuditingAttribute), true))
        {
            return false;
        }

        if (typeof(IAuditingEnabled).IsAssignableFrom(type))
        {
            return true;
        }

        return false;
    }
}

2.1.2 審計日誌攔截器的實現

審計日誌攔截器的內部實現,主要使用了三個類型進行協同工作。它們分別是負責管理審計日誌信息的 IAuditingManager,負責創建審計日誌信息的 IAuditingHelper,還有統計介面執行時常的 Stopwatch

整個審計日誌攔截器的大體流程如下:

  1. 首先是判定 MVC 審計日誌過濾器是否進行處理。
  2. 再次根據特性,和類型進行二次驗證是否應該創建審計日誌信息。
  3. 根據調用信息,創建 AuditLogInfoAuditLogActionInfo 審計日誌信息。
  4. 調用 StopWatch 的計時方法,如果出現了異常則將異常信息添加到剛纔構建的 AuditLogInfo 對象中。
  5. 無論是否出現異常,都會進入 finally 語句塊,這個時候會調用 StopWatch 實例的停止方法,並統計完成執行時間。
public override async Task InterceptAsync(IAbpMethodInvocation invocation)
{
    if (!ShouldIntercept(invocation, out var auditLog, out var auditLogAction))
    {
        await invocation.ProceedAsync();
        return;
    }

    // 開始進行計時操作。
    var stopwatch = Stopwatch.StartNew();

    try
    {
        await invocation.ProceedAsync();
    }
    catch (Exception ex)
    {
        // 如果出現了異常,一樣的將異常信息添加到審計日誌結果中。
        auditLog.Exceptions.Add(ex);
        throw;
    }
    finally
    {
        // 統計完成,並將信息加入到審計日誌結果中。
        stopwatch.Stop();
        auditLogAction.ExecutionDuration = Convert.ToInt32(stopwatch.Elapsed.TotalMilliseconds);
        auditLog.Actions.Add(auditLogAction);
    }
}

可以看到,只有當 ShouldIntercept() 方法返回 true 的時候,下麵的統計等操作才會被執行。

protected virtual bool ShouldIntercept(
    IAbpMethodInvocation invocation, 
    out AuditLogInfo auditLog, 
    out AuditLogActionInfo auditLogAction)
{
    auditLog = null;
    auditLogAction = null;

    if (AbpCrossCuttingConcerns.IsApplied(invocation.TargetObject, AbpCrossCuttingConcerns.Auditing))
    {
        return false;
    }

    // 如果沒有獲取到 Scop,則返回 false。
    var auditLogScope = _auditingManager.Current;
    if (auditLogScope == null)
    {
        return false;
    }

    // 進行二次判斷是否需要存儲審計日誌。
    if (!_auditingHelper.ShouldSaveAudit(invocation.Method))
    {
        return false;
    }

    // 構建審計日誌信息。
    auditLog = auditLogScope.Log;
    auditLogAction = _auditingHelper.CreateAuditLogAction(
        auditLog,
        invocation.TargetObject.GetType(),
        invocation.Method, 
        invocation.Arguments
    );

    return true;
}

2.2 審計日誌的持久化

大體流程和我們上面說的一樣,不過好像缺少了重要的一步,那就是 持久化操作。你可以在 Volo.Abp.Auditing 模塊發現有 IAuditingStore 介面的定義,但是它的 SaveAsync() 方法卻沒有在攔截器內部被調用。同樣在 MVC 的審計日誌過濾器實現,你也會發現沒有調用持久化方法。

那麼我們的審計日誌是在什麼時候被持久化的呢?找到 SaveAsync() 被調用的地方,發現 ABP vNext 實現了一個審計日誌的 ASP.NET Core 中間件。

在這個中間件內部的實現比較簡單,首先通過一個判定方法,決定是否為本次請求執行 IAuditingManager.BeginScope() 方法。如果判定通過,則執行,否則不僅行任何操作。

public async Task InvokeAsync(HttpContext context, RequestDelegate next)
{
    if (!ShouldWriteAuditLog(context))
    {
        await next(context);
        return;
    }

    using (var scope = _auditingManager.BeginScope())
    {
        try
        {
            await next(context);
        }
        finally
        {
            await scope.SaveAsync();
        }
    }
}

可以看到,在這裡 ABP vNext 使用 IAuditingManager 構建,調用其 BeginScope() 構建了一個 IAuditLogSaveHandle 對象,並使用其提供的 SaveAsync() 方法進行持久化操作。

2.2.1 嵌套的持久化操作

在構造出來的 IAuditLogSaveHandle 對象裡面,還是使用的 IAuditingManager 的預設實現 AuditingManager 所提供的 SaveAsync() 方法進行持久化

閱讀源碼之後,發現了下麵兩個問題:

  1. IAuditingManager 沒有將持久化方法公開 出來,而是作為一個 protected 級別的方法。
  2. 為什麼還要藉助 IAuditLogSaveHandle 間接地調用 管理器的持久化方法。

這就要從中間件的代碼說起了,可以看到它是構造出了一個可以被釋放的 IAuditLogSaveHandle 對象。ABP vNext 這樣做的目的,就是可以嵌套多個 Scope,即 只在某個範圍內 才將審計日誌記錄下來。這種特性類似於 工作單元 的用法,其底層實現是 之前文章 講過的 IAmbientScopeProvider 對象。

例如在某個應用服務內部,我可以這樣寫代碼:

using (var scope = _auditingManager.BeginScope())
{
    await myAuditedObject1.DoItAsync(new InputObject { Value1 = "我是內部嵌套測試方法1。", Value2 = 5000 });
    using (var scope2 = _auditingManager.BeginScope())
    {
        await myAuditedObject1.DoItAsync(new InputObject {Value1 = "我是內部嵌套測試方法2。", Value2 = 10000});
        await scope2.SaveAsync();
    }
    await scope.SaveAsync();
}

想一下之前的代碼,在攔截器內部,我們是通過 IAuditingManager.Current 拿到當前可用的 IAuditLogScope ,而這個 Scope 就是在調用 IAuditingManager.BeginScope() 之後生成的

2.2.3 最終的持久化代碼

通過上述的流程,我們得知最後的審計日誌信息會通過 IAuditingStore 進行持久化。ABP vNext 為我們提供了一個預設的 SimpleLogAuditingStore 實現,其內部就是調用 ILogger 將信息輸出。如果需要將審計日誌持久化到資料庫,你可以實現 IAUditingStore 介面,覆蓋原有實現 ,或者使用 ABP vNext 提供的 Volo.Abp.AuditLogging 模塊。

2.3 審計日誌的序列化

審計日誌的序列化處理是在 IAuditingHelper 的預設實現內部被使用,可以看到構建審計日誌的方法內部,通過自定義的序列化器來將 Action 的參數進行序列化處理,方便存儲。

public virtual AuditLogActionInfo CreateAuditLogAction(
    AuditLogInfo auditLog,
    Type type, 
    MethodInfo method, 
    IDictionary<string, object> arguments)
{
    var actionInfo = new AuditLogActionInfo
    {
        ServiceName = type != null
            ? type.FullName
            : "",
        MethodName = method.Name,
        // 序列化參數信息。
        Parameters = SerializeConvertArguments(arguments),
        ExecutionTime = Clock.Now
    };

    //TODO Execute contributors

    return actionInfo;
}

protected virtual string SerializeConvertArguments(IDictionary<string, object> arguments)
{
    try
    {
        if (arguments.IsNullOrEmpty())
        {
            return "{}";
        }

        var dictionary = new Dictionary<string, object>();

        foreach (var argument in arguments)
        {
            // 忽略的代碼,主要作用是構建參數字典。
        }

        // 調用序列化器,序列化 Action 的調用參數。
        return AuditSerializer.Serialize(dictionary);
    }
    catch (Exception ex)
    {
        Logger.LogException(ex, LogLevel.Warning);
        return "{}";
    }
}

下麵就是具體序列化器的代碼:

public class JsonNetAuditSerializer : IAuditSerializer, ITransientDependency
{
    protected AbpAuditingOptions Options;

    public JsonNetAuditSerializer(IOptions<AbpAuditingOptions> options)
    {
        Options = options.Value;
    }

    public string Serialize(object obj)
    {
        // 使用 JSON.NET 進行序列化操作。
        return JsonConvert.SerializeObject(obj, GetSharedJsonSerializerSettings());
    }

    // ... 省略的代碼。
}

2.4 審計日誌的配置參數

針對審計日誌相關的配置參數的定義,都存放在 AbpAuditingOptions 當中。下麵我會針對各個參數的用途,對其進行詳細的說明。

public class AbpAuditingOptions
{
    //TODO: Consider to add an option to disable auditing for application service methods?

    // 該參數目前版本暫未使用,為保留參數。
    public bool HideErrors { get; set; }

    // 是否啟用審計日誌功能,預設值為 true。
    public bool IsEnabled { get; set; }

    // 審計日誌的應用程式名稱,預設值為 null,主要在構建 AuditingInfo 被使用。
    public string ApplicationName { get; set; }

    // 是否為匿名請求記錄審計日誌預設值 true。
    public bool IsEnabledForAnonymousUsers { get; set; }

    // 審計日誌功能的協作者集合,預設添加了 AspNetCoreAuditLogContributor 實現。
    public List<AuditLogContributor> Contributors { get; }

    // 預設的忽略類型,主要在序列化時使用。
    public List<Type> IgnoredTypes { get; }

    // 實體類型選擇器。
    public IEntityHistorySelectorList EntityHistorySelectors { get; }

    //TODO: Move this to asp.net core layer or convert it to a more dynamic strategy?
    // 是否為 Get 請求記錄審計日誌,預設值 false。
    public bool IsEnabledForGetRequests { get; set; }

    public AbpAuditingOptions()
    {
        IsEnabled = true;
        IsEnabledForAnonymousUsers = true;
        HideErrors = true;

        Contributors = new List<AuditLogContributor>();

        IgnoredTypes = new List<Type>
        {
            typeof(Stream),
            typeof(Expression)
        };

        EntityHistorySelectors = new EntityHistorySelectorList();
    }
}

2.4 實體相關的審計信息

在文章開始就談到,除了對 HTTP 請求有審計日誌記錄以外,ABP vNext 還提供了實體審計信息的記錄功能。所謂的實體的審計信息,指的就是實體繼承了 ABP vNext 提供的介面之後,ABP vNext 會自動維護實現的介面欄位,不需要開發人員自己再進行處理。

這些介面包括創建實體操作的相關信息 IHasCreationTimeIMayHaveCreatorICreationAuditedObject 以及刪除實體時,需要記錄的相關信息介面 IHasDeletionTimeIDeletionAuditedObject 等。除了審計日誌模塊定義的類型以外,在 Volo.Abp.Ddd.Domain 模塊的 Auditing 裡面也有很多審計實體的預設實現。

我在這裡就不再一一列舉,下麵僅快速講解一下 ABP vNext 是如何通過這些介面,實現對審計欄位的自動維護的。

在審計日誌模塊的內部,我們看到一個介面名字叫做 IAuditPropertySetter,它提供了三個方法,分別是:

public interface IAuditPropertySetter
{
    void SetCreationProperties(object targetObject);

    void SetModificationProperties(object targetObject);

    void SetDeletionProperties(object targetObject);
}

所以,這幾個方法就是用於設置創建信息、修改信息、刪除信息的。現在跳轉到預設實現 AuditPropertySetter,隨便找一個 SetCreationTime() 方法。該方法內部首先是判斷傳入的 object 是否實現了 IHasCreationTime 介面,如果實現了對其進行強制類型轉換,然後賦值即可。

private void SetCreationTime(object targetObject)
{
    if (!(targetObject is IHasCreationTime objectWithCreationTime))
    {
        return;
    }

    if (objectWithCreationTime.CreationTime == default)
    {
        objectWithCreationTime.CreationTime = Clock.Now;
    }
}

其他幾個 Set 方法大同小異,那我們看一下有哪些地方使用到了上述三個方法。

可以看到使用者就包含有 EF Core 模塊和 MongoDB 模塊,這裡我以 EF Core 模塊為例,猜測應該是傳入了實體對象過來。

果不其然...查看這個方法的調用鏈,發現是 DbContext 每次進行 SaveChanges/SaveChangesAsync 的時候,就會對實體進行審計欄位自動賦值操作。

三、總結

審計日誌是 ABP vNext 為我們提供的一個可選組件,當開啟審計日誌功能後,我們可以根據審計日誌信息快速定位問題。但審計日誌的開啟,也會較大的影響性能,因為每次請求都會創建審計日誌信息,之後再進行持久化。因此在使用審計日誌功能時,可以結合 DisableAuditingAttribute 特性和 IAuditingManager.BeginScope(),按需開啟審計日誌功能。

四、點擊我跳轉到文章目錄


您的分享是我們最大的動力!

更多相關文章
  • 1.ServiceStack.Redis封裝 封裝的Redis操作類名為RedisHandle,如下代碼塊(只展示部分代碼),它的特點: 1)使用連接池管理連接,見代碼中的PooledClientManager屬性。如果不用連接池,而是代碼直接RedisClient client = new Red ...
  • public partial class App : System.Windows.Application { protected override void OnStartup(StartupEventArgs e) { base.OnStartup(e); SetupWindow... ...
  • 框架採用.NetCore + Vue前後端分離,並且支持前端、後臺代碼業務動態擴展,框架內置了一套有著20多種屬性配置的代碼生成器,可靈活配置生成的代碼,代碼生成器界面配置完成即可生成單表/主從表的增、刪、改、查、導入、導出、上傳、審核基礎功能。只需要簡單瞭解即可上手開發 框架基礎功能已構建完成,可 ...
  • [toc] 前言 十一小長假在不知不覺間可都沒了,在這個小尾巴的空隙,把這兩天鼓搗的net core 3.0升級過程記錄一下,首先還是根據之前的順序一個個補充進來,先從Swagger的變化說起(新建工程什麼的不多說了,就是選擇的時候選3.0就可以了,2019新版更新後創建預設都是3.0)。 引入 按 ...
  • 類型和變數 [C#類型和變數(原文參考官方教程)]https://docs.microsoft.com/zh-cn/dotnet/csharp/tour-of-csharp/types-and-variables C#有兩種類型: 1. 值類型 1. 簡單類型 2. 枚舉類型 格式為 enum E ...
一周排行
  • 一、背景 代碼實例:https://gitee.com/D_C_L/CurtainEtcAOP.git我們實際系統中有很多操作,是不管做多少次,都應該產生一樣的效果或返回一樣的結果。 例如: 1. 前端重覆提交選中的數據,應該後臺只產生對應這個數據的一個反應結果。 2. 我們發起一筆付款請求,應該只 ...
  • 關鍵字:流程未來節點處理人 工作流快速開發平臺 工作流流設計 業務流程管理 asp.net 開源工作流 業務背景:一個流程在啟動起來後,是可以對一些節點計算出來處理人是誰,流程的走向。對於另外一些節點處理人有可能需要相關的人員調整的。在一些審批的環境下,需要把能夠計算出來的節點處理人在發起時計算出來... ...
  • 簡述 我們做軟體工作的雖然每天都離不開網路,可網路協議細節卻不是每個人都會接觸和深入瞭解。我今天就來和大家一起學習下Socket,並寫一個簡單的聊天程式。 一些基礎類 首先我們每天打開瀏覽器訪問網頁信息都是使用的HTTP/HTTPS協議,而HTTP是通過的TCP建立的連接。TCP底層又是通過的Soc ...
  • 點這裡進入ABP進階教程目錄 在功能按鈕區增加一個自定義按鈕 - Add(創建課程) 添加按鈕 打開展示層(即JD.CRS.Web.Mvc)的\wwwroot\view-resources\Views\Course\Index.js //用以存放Course查詢相關腳本 自帶按鈕已有五個我們再添加一 ...
  • 點這裡進入ABP進階教程目錄 我們嘗試在新增/編輯界面增加一個下拉框用來代替輸入框編輯Status 添加實體 打開領域層(即JD.CRS.Core)的Entitys目錄 //用以存放實體對象添加一個類StatusCode.cs //狀態信息 更新模型 更新查詢視圖模型 打開展示層(即JD.CRS.W ...
  • 在項目視圖中,找到-》輸出 視窗,在視窗中選擇ASP.NET Core Web伺服器,調試項目即可看到執行的sql語句 ...
  • 前言: 通過Fiddler抓取瀏覽器請求數據,相信大家已經都會用了,我們知道Fiddler是通過在本機計算器添加一個預設的代理伺服器來實現的抓包數據的,埠號為:8888。 其實當我們打開Fiddler的設置也可以看到: 然後查看本地計算器的網路代理設置: 基於上面的原理,Fiddler就實現了經過 ...
  • 場景 Winform控制項-DevExpress18下載安裝註冊以及在VS中使用: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100061243 在上面已經實現DevExpress的安裝之後,拖拽一個TreeList,然後怎樣給 ...
  • 場景 Winform控制項-DevExpress18下載安裝註冊以及在VS中使用: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100061243 DevExpress的TreeList怎樣設置數據源,從實例入手: https:/ ...
  • 場景 在開發中,經常會有一些全局作用域的常量、欄位、屬性、方法等。 需要將這些設置為全局作用域保存且其實例唯一。 註: 博客主頁: https://blog.csdn.net/badao_liumang_qizhi 關註公眾號 霸道的程式猿 獲取編程相關電子書、教程推送與免費下載。 實現 首先新建一 ...
x