程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> ASP.NET >> ASP.NET基礎 >> ABP框架中的日志功能完全解析

ABP框架中的日志功能完全解析

編輯:ASP.NET基礎

ASP.NET Boilerplate使用Castle Windsor's logging facility日志記錄工具,並且可以使用不同的日志類庫,比如:Log4Net, NLog, Serilog... 等等。對於所有的日志類庫,Castle提供了一個通用的接口來實現,我們可以很方便的處理各種特殊的日志庫,而且當業務需要的時候,很容易替換日志組件。

譯者注釋:Castle是什麼:Castle是針對.NET平台的一個開源項目,從數據訪問框架ORM到IOC容器,再到WEB層的MVC框架、AOP,基本包括了整個開發過程中的所有東西。ASP.NET Boilerplate的ioc容器就是通過Castle實現的。

Log4Net 是asp.net下面最流行的一個日志庫組件, ASP.NET Boilerplate 模板也使用了Log4Net日志庫組件,但是呢,我們這裡僅僅通過一行關鍵代碼就實現Log4Net 的依賴注入(具體說明在下面的配置文件),所以,如果你想替換成自己的日志組件,也很容易。

獲取日志記錄器logger

不管你選擇哪一個日志庫組件,通過代碼來進行日志記錄都是一樣的。(這裡吐槽, Castle's 通用 ILogger 接口實在太牛逼了)。

下面進入正題:(譯者注:下面的代碼是abp框架的Castle.Core源碼分析以及實現)

1、首先呢,我們要先處理日志記錄器對象logger, ASP.NET Boilerplate框架使用了dependency injection依賴注入技術,我們可以很方便的使用依賴注入生成日志記錄器對象logger。

接下來我們看一下 ASP.NET Boilerplate是怎麼實現日志記錄功能的吧:

using Castle.Core.Logging; //1: 導入日志的命名空間,Castle.Core.Logging

public class TaskAppService : ITaskAppService
{ 
  //2:通過依賴注入獲取日志記錄器對象。
  這裡先定義了一個ILogger類型的public屬性Logger,這個對象就是我們用來記錄日志的對象。在創建了TaskAppService對象(就是我們應用中定義的任務)以後,通過屬性注入的方式來實現。
  public ILogger Logger { get; set; }

  public TaskAppService()
  { 
   //3: 如果沒有日志記錄器,將日志記錄器返回一個空的實例,不寫日志。這是依賴注入的最佳實現方式,
   //  如果你不定義這個空的日志記錄器,當我們獲取對象引用並且實例化的時候,就會產生異常。
   //  這麼做,保證了對象不為空。所以,換句話說,不設置日志記錄器,就不記錄日志,返回一個null的對象。
   //  NullLogger對象實際上什麼都木有,空的。這麼做,才能保證我們定義的類在實例化時正常運作。
   Logger = NullLogger.Instance;
  }
 
  public void CreateTask(CreateTaskInput input) 
  {
   //4: 寫入日志
   Logger.Info("Creating a new task with description: " + input.Description);

   //TODO: save task to database... 
  } 
} 

寫入日志以後,我們可以查看日志文件,就像下面的格式:

INFO 2014-07-13 13:40:23,360 [8 ] SimpleTaskSystem.Tasks.TaskAppService - Creating a new task with description:Remember to drink milk before sleeping!
 
通過基類使用Logger

ASP.NET Boilerplate框架提供了MVC Controllers、Web API Controllers和Application service classes的基類(自己定義的控制器和應用服務,都必須要繼承ASP.NET Boilerplate的基類,換句話說,當你自定義的Web API controllers、mvc controllers,Application service classes都繼承了ASP.NET Boilerplate框架對應的基類,你就可以直接使用日志記錄器)。

public class HomeController : SimpleTaskSystemControllerBase 
{ 
  public ActionResult Index() 
  { 
   Logger.Debug("A sample log message..."); 
   return View(); 
  } 
} 

說明:SimpleTaskSystemControllerBase這個基類控制器是我們自己定義的基類控制器,他必須繼承自 AbpController。

這樣實現,日志記錄器才能正常工作。當然了,你也可以實現自己的基類,這樣的話你也可以不使用依賴注入了。

配置

如果你在官網上通過ASP.NET Boilerplate templates 來生成了你的工程,Log4Net的所有配置都自動生成了。

默認的配置格式如下:

  • Log level: 日志記錄等級,有DEBUG, INFO, WARN, ERROR or FATAL5個。
  • Date and time: 日志記錄時間。
  • Thread number: 每行日志寫時候的線程號。
  • Logger name: 日志記錄器的名字,通常情況就是類名稱。
  • Log text: 你寫入的日志內容。

配置文件:log4net.config 一般都在項目的web目錄下面。

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
 <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender" >
  <file value="Logs/Logs.txt" />
  <appendToFile value="true" />
  <rollingStyle value="Size" />
  <maxSizeRollBackups value="10" />
  <maximumFileSize value="10000KB" />
  <staticLogFileName value="true" />
  <layout type="log4net.Layout.PatternLayout">
    <conversionPattern value="%-5level %date [%-5.5thread] %-40.40logger - %message%newline" />
  </layout>
 </appender>
 <root>
  <appender-ref ref="RollingFileAppender" />
  <level value="DEBUG" />
 </root>
 <logger name="NHibernate">
  <level value="WARN" />
 </logger>
</log4net>

Log4Net是一個非常強大和易用的日志庫組件,你可以寫各種日志,比如寫到txt文件,寫入到數據庫等等。你能設置最小的日志等級,就像上面這個針對NHibernate的配置。不同的記錄器寫不同的日志,等等。

具體的用法大家可以參照:http://logging.apache.org/log4net/release/config-examples.html

最後,在工程的Global.asax 文件中,來定義Log4Net的配置文件:

public class MvcApplication : AbpWebApplication
{
  protected override void Application_Start(object sender, EventArgs e)
  {
    IocManager.Instance.IocContainer.AddFacility<LoggingFacility>(f => f.UseLog4Net().WithConfig("log4net.config"));
    base.Application_Start(sender, e);
  }
}

幾行代碼就調用了Log4Net這個日志記錄組件,工程中的Log4Net庫是在 nuget package包中的,你也可以換成其他日志組件庫,但是代碼不用做任何改變。因為,我們的框架是通過依賴注入實現日志記錄器的!

Client side(客戶端)

最後,更厲害的是,你還可以在客戶端調用日志記錄器。在客戶端,ASP.NET Boilerplate框架有對應的 javascript 日志API,這意味著你可以記錄下來浏覽器的日志,實現代碼如下:

abp.log.warn('a sample log message...'); 

 附上:客戶端javascript的api,這裡要說明的是,你可以使用console.log在客戶端輸出日志,但是這個API 不一定支持所有的浏覽器,還有可能導致你的腳本出現異常,你可以使用我們的api,我們的是安全的,你甚至可以重載或者擴展這些api。

abp.log.debug('...');
abp.log.info('...');
abp.log.warn('...');
abp.log.error('...'); 
abp.log.fatal('...');


審計跟蹤日志
ABP提供了能夠為應用程序交互自動記錄日志的基礎設施,它能記錄你調用的方法的調用者信息和參數信息。從根本上來說,存儲區域包含:

  • tenant id(相關的租戶Id),
  • user id(請求用戶Id),
  • server name(請求的服務名稱【調用方法對應的類】),
  • method name(調用方法名稱),
  • parameters(方法的參數【JSON格式】),
  • execution time(執行時間),
  • duration (執行耗時時間【通常是毫秒】),
  • IP address (客戶端IP地址),
  • computer name(客戶機名稱),
  • exception (異常【如果方法拋出異常】)等信息。

有了這些信息,我們不僅能夠知道誰進行了操作,還能夠估算出應用程序的性能及拋出的異常。甚至更多的,你可以得到有關應用程序的使用情況統計。

審計系統使用IAbpSession接口來獲取當前用戶Id和租戶ID。

注意:關於IAuditingStore接口

審計系統使用IAuditingStore接口來保存審計信息。module-zero項目是這個接口的完整實現,當然你也可以通過自己的方式來實現這個接口。如果你不想自己實現這個接口,SimpleLogAuditingStore類可以直接拿來使用,它是實現方式是將審計信息寫入日志中。

 配置:
可以在你的模塊初始化方法(PreInitialize)中使用Configuration.Auditing的屬性來配置審計,Auditing屬性默認是啟用狀態(即true)。你可以禁用它,如下圖所示:

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

  //...
}

以下是審計配置的屬性:

IsEnabled: 用於設置完全啟用或禁用審計系統。默認值:true.
IsEnabledForAnonymousUsers:如果設置成ture,未登陸的用戶的審計日志也會保存。默認值: false.
MvcControllers: 在ASP.NET MVC 控制器中使用審計日志
IsEnabled: 在ASP.NET MVC中啟用(true)或禁用(false)審計日志. 默認值: true.
IsEnabledForChildActions: 為MVC actions啟用(true)或禁用(false)審計日志. 默認值: false.
Selectors: 選擇使用其他類來處理審計日志的存儲。

正如你所看到的,審計系統單獨為mvc控制器提供了審計配置使之可以使用不同的方法來使用它。

Selectors是一個斷言(推斷類型)選擇器列表,用於選擇那種方式來保存審計日志。每一個選擇器包含一個唯一的名稱和一個斷言。斷言列表中默認的選擇器,使用的是應用程序服務類。如下圖所示:

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

你可以在自己的模塊初始化方法(PreInitialize)中添加自己的斷言選擇器。同樣的,如果你不喜歡使用應用程序服務來保存審計日志,你也可以通過名稱(name)來移除斷言選擇器,這就是為什麼斷言選擇器的名稱必須是唯一的(你也可以通過Linq的方式查找到選擇器來移除它)。

通過屬性來啟用和禁用審計日志:
當你使用配置項來配置斷言選擇器時,你可以通過使用Audited和DisableAuditing特性標記到單個類或單個方法來實現審計系統的啟用和禁用。例如:

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

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

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

上述列子中,MyClass類中除了MyMethod2明確標記不需要審計外,其他的方法都會被審計。Audited特性能夠幫助你只想保存審計日志的方法,進行審計日志保存。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved