<<ABP文檔>> 審計日誌

文檔目錄

本節內容：

• 簡介
  • 關於 IAuditingStore
• 配置
• 通過特性啟用/禁用
• 註意

簡介

維基百科：“一個審計追蹤（也叫審計日誌）是一個安全相關的時序記錄、記錄組、和/或記錄源和目標，作為任何時候一個特殊操作帶來影響的一序列活動的書面文件”。

ABP提供一個基礎框架來自動記錄所有與應用的交互，它能記錄有意的方法調用和調用者信息與參數。

基本上，保存的欄位有：相關的租戶id，調用者id，被調用的服務名（被調用方法的類名），被調用的方法名，執行參數（序列化成Json），執行時間，執行時長（毫秒），客戶端IP，客戶端電腦名和異常（如果方法拋出一個異常）。

有了這些信息，我們不僅能知道誰做了操作，也能測量應用的性能和觀察異常，甚至更多，如你可以統計你應用的使用頻次。

審計系統使用IAbpSeesion來獲取當前UserId和TenantId。

應用服務、Mvc控制器、Web Api和Asp.net Core方法預設情況下被自動審計。

 關於 IAuditingStore

審計系統使用IAuditingStore來保存審計信息，雖然你可以用你自己的方式實現它，但在module-zero項目里已經完全實現。如果你沒有實現它，SimpleLogAuditingStore會被使用，它把審計信息寫入日誌。

配置

為配置審計，你可以在你的模塊的PreInitialize方法里使用Configuration.Auditing屬性。審計預設可用，你可以用如下方式禁用它：

public class MyModule : AbpModule
{
    public override void PreInitialize()
    {
        Configuration.Auditing.IsEnabled = false;
    }

    //...
}

這裡有一個審計配置列表：

• IsEnabled：啟用/禁用整個審計系統，預設：true。
• IsEnabledForAnonymousUsers：如果設為true，在用戶未登錄系統的情況下，也會保存審核日誌。預設為：false。
• Selectors：選擇其它類來保存審核日誌

Selectors是一個謂詞列表，用其它類型來保存審核日誌，一個選擇器有一個唯一的名稱和一個謂詞，在這個列表裡唯一預設的選擇器是用來選擇應用服務類的，它的定義如下所示：

Configuration.Auditing.Selectors.Add(
    new NamedTypeSelector(
        "Abp.ApplicationServices",
        type => typeof (IApplicationService).IsAssignableFrom(type)
    )
);

你可在你的模塊的PreInitialize方法里添加自己的選擇器，同樣，如果你不想為應用服務保存審計日誌，可通過名稱移除選擇器，這就是為什麼需要一個唯一的名稱的原因（如果你想，可以使用簡單的Linq在Selector里找到一個選擇器，並移除它）。

註意：除了標準的審計配置，Mvc和Asp.net Core模塊為Action定義了啟用/禁用審計日誌的配置。

通過特性啟用/禁用

雖然你可以通過配置選擇審計類，但你可以為一個單獨的類、方法使用Audited和DisableAuditing特性，例如：

[Audited]
public class MyClass
{
    public void MyMethod1(int a)
    {
        //...
    }

    [DisableAuditing]
    public void MyMethod2(string b)
    {
        //...
    }

    public void MyMethod3(int a, int b)
    {
        //...
    }
}

除了MyMethod2，MyClass類的其它方法都被審計了，因為MyMethod2顯式禁用了審計，Audited特性可用在一個方法上，只對關心的方法進行審計。

DisableAuditing可用在一個DTO的一個單獨的屬性上，因此，你可以在審計日誌里隱藏敏感數據，例如密碼。

註意

• 為記錄審計日誌，方法必須是public，private和protected方法會被忽略。
• 如果通過類引用調用一個方法，這個方法必須為virtual，如果類是通過它的介面被註入，那這就不是必要的（如通過註入IPersonService介面來使用PersonService類），ABP使用動態代理和攔截器，所以這又是必要的。這對於Mvc控制器的Action不適用，因為它們可能不為virtual。