ABP(ASP.NET Boilerplate)是基于A(yíng)SP.NET的Web開(kāi)發(fā)框架,其在日志方面的功能非常強(qiáng)大,特別是審計(jì)跟蹤日志,下面我們就來(lái)進(jìn)行ABP框架中的日志功能完全解析

ASP.NET Boilerplate使用Castle Windsor's logging facility日志記錄工具，并且可以使用不同的日志類(lèi)庫(kù)，比如：Log4Net, NLog, Serilog... 等等。對(duì)于所有的日志類(lèi)庫(kù)，Castle提供了一個(gè)通用的接口來(lái)實(shí)現(xiàn)，我們可以很方便的處理各種特殊的日志庫(kù)，而且當(dāng)業(yè)務(wù)需要的時(shí)候，很容易替換日志組件。

譯者注釋?zhuān)篊astle是什么：Castle是針對(duì).NET平臺(tái)的一個(gè)開(kāi)源項(xiàng)目，從數(shù)據(jù)訪(fǎng)問(wèn)框架ORM到IOC容器，再到WEB層的MVC框架、AOP，基本包括了整個(gè)開(kāi)發(fā)過(guò)程中的所有東西。ASP.NET Boilerplate的ioc容器就是通過(guò)Castle實(shí)現(xiàn)的。

Log4Net 是asp.net下面最流行的一個(gè)日志庫(kù)組件， ASP.NET Boilerplate 模板也使用了Log4Net日志庫(kù)組件，但是呢，我們這里僅僅通過(guò)一行關(guān)鍵代碼就實(shí)現(xiàn)Log4Net 的依賴(lài)注入（具體說(shuō)明在下面的配置文件），所以，如果你想替換成自己的日志組件，也很容易。

獲取日志記錄器logger

不管你選擇哪一個(gè)日志庫(kù)組件，通過(guò)代碼來(lái)進(jìn)行日志記錄都是一樣的。（這里吐槽， Castle's 通用 ILogger 接口實(shí)在太牛逼了）。

下面進(jìn)入正題：(譯者注:下面的代碼是abp框架的Castle.Core源碼分析以及實(shí)現(xiàn))

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

接下來(lái)我們看一下 ASP.NET Boilerplate是怎么實(shí)現(xiàn)日志記錄功能的吧：

using Castle.Core.Logging; //1: 導(dǎo)入日志的命名空間，Castle.Core.Logging

public class TaskAppService : ITaskAppService

{ 

  //2:通過(guò)依賴(lài)注入獲取日志記錄器對(duì)象。

  這里先定義了一個(gè)ILogger類(lèi)型的public屬性L(fǎng)ogger，這個(gè)對(duì)象就是我們用來(lái)記錄日志的對(duì)象。在創(chuàng)建了TaskAppService對(duì)象（就是我們應(yīng)用中定義的任務(wù)）以后，通過(guò)屬性注入的方式來(lái)實(shí)現(xiàn)。

  public ILogger Logger { get; set; }

  public TaskAppService()

  { 

   //3: 如果沒(méi)有日志記錄器，將日志記錄器返回一個(gè)空的實(shí)例，不寫(xiě)日志。這是依賴(lài)注入的最佳實(shí)現(xiàn)方式，

   //  如果你不定義這個(gè)空的日志記錄器，當(dāng)我們獲取對(duì)象引用并且實(shí)例化的時(shí)候，就會(huì)產(chǎn)生異常。

   //  這么做，保證了對(duì)象不為空。所以，換句話(huà)說(shuō)，不設(shè)置日志記錄器，就不記錄日志，返回一個(gè)null的對(duì)象。

   //  NullLogger對(duì)象實(shí)際上什么都木有，空的。這么做，才能保證我們定義的類(lèi)在實(shí)例化時(shí)正常運(yùn)作。

   Logger = NullLogger.Instance;

  }

  public void CreateTask(CreateTaskInput input) 

  {

   //4: 寫(xiě)入日志

   Logger.Info("Creating a new task with description: " + input.Description);

   //TODO: save task to database... 

  } 

} 

寫(xiě)入日志以后，我們可以查看日志文件，就像下面的格式：

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

通過(guò)基類(lèi)使用Logger

ASP.NET Boilerplate框架提供了MVC Controllers、Web API Controllers和Application service classes的基類(lèi)（自己定義的控制器和應(yīng)用服務(wù)，都必須要繼承ASP.NET Boilerplate的基類(lèi)，換句話(huà)說(shuō)，當(dāng)你自定義的Web API controllers、mvc controllers，Application service classes都繼承了ASP.NET Boilerplate框架對(duì)應(yīng)的基類(lèi)，你就可以直接使用日志記錄器）。

public class HomeController : SimpleTaskSystemControllerBase 

{ 

  public ActionResult Index() 

  { 

   Logger.Debug("A sample log message..."); 

   return View(); 

  } 

} 

說(shuō)明：SimpleTaskSystemControllerBase這個(gè)基類(lèi)控制器是我們自己定義的基類(lèi)控制器，他必須繼承自 AbpController。

這樣實(shí)現(xiàn)，日志記錄器才能正常工作。當(dāng)然了，你也可以實(shí)現(xiàn)自己的基類(lèi)，這樣的話(huà)你也可以不使用依賴(lài)注入了。

配置

如果你在官網(wǎng)上通過(guò)ASP.NET Boilerplate templates 來(lái)生成了你的工程，Log4Net的所有配置都自動(dòng)生成了。

默認(rèn)的配置格式如下：

Log level: 日志記錄等級(jí)，有DEBUG, INFO, WARN, ERROR or FATAL5個(gè)。

Date and time: 日志記錄時(shí)間。

Thread number: 每行日志寫(xiě)時(shí)候的線(xiàn)程號(hào)。

Logger name: 日志記錄器的名字，通常情況就是類(lèi)名稱(chēng)。

Log text: 你寫(xiě)入的日志內(nèi)容。

配置文件：log4net.config 一般都在項(xiàng)目的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是一個(gè)非常強(qiáng)大和易用的日志庫(kù)組件，你可以寫(xiě)各種日志，比如寫(xiě)到txt文件，寫(xiě)入到數(shù)據(jù)庫(kù)等等。你能設(shè)置最小的日志等級(jí)，就像上面這個(gè)針對(duì)NHibernate的配置。不同的記錄器寫(xiě)不同的日志，等等。

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

最后，在工程的Global.asax 文件中，來(lái)定義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);

  }

}

幾行代碼就調(diào)用了Log4Net這個(gè)日志記錄組件，工程中的Log4Net庫(kù)是在 nuget package包中的，你也可以換成其他日志組件庫(kù)，但是代碼不用做任何改變。因?yàn)?，我們的框架是通過(guò)依賴(lài)注入實(shí)現(xiàn)日志記錄器的！

Client side（客戶(hù)端）

最后，更厲害的是，你還可以在客戶(hù)端調(diào)用日志記錄器。在客戶(hù)端，ASP.NET Boilerplate框架有對(duì)應(yīng)的 javascript 日志API，這意味著你可以記錄下來(lái)瀏覽器的日志，實(shí)現(xiàn)代碼如下：

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

 附上：客戶(hù)端javascript的api，這里要說(shuō)明的是，你可以使用console.log在客戶(hù)端輸出日志，但是這個(gè)API 不一定支持所有的瀏覽器，還有可能導(dǎo)致你的腳本出現(xiàn)異常，你可以使用我們的api，我們的是安全的，你甚至可以重載或者擴(kuò)展這些api。

abp.log.debug('...');

abp.log.info('...');

abp.log.warn('...');

abp.log.error('...'); 

abp.log.fatal('...');

審計(jì)跟蹤日志

ABP提供了能夠?yàn)閼?yīng)用程序交互自動(dòng)記錄日志的基礎(chǔ)設(shè)施，它能記錄你調(diào)用的方法的調(diào)用者信息和參數(shù)信息。從根本上來(lái)說(shuō)，存儲(chǔ)區(qū)域包含：

1.tenant id（相關(guān)的租戶(hù)Id），

2.user id（請(qǐng)求用戶(hù)Id），

3.server name（請(qǐng)求的服務(wù)名稱(chēng)【調(diào)用方法對(duì)應(yīng)的類(lèi)】），

4.method name（調(diào)用方法名稱(chēng)），

5.parameters（方法的參數(shù)【JSON格式】），

6.execution time（執(zhí)行時(shí)間），

7.duration （執(zhí)行耗時(shí)時(shí)間【通常是毫秒】），

8.IP address （客戶(hù)端IP地址），

9.computer name（客戶(hù)機(jī)名稱(chēng)），

10.exception （異?！救绻椒⊕伋霎惓！浚┑刃畔?。

有了這些信息，我們不僅能夠知道誰(shuí)進(jìn)行了操作，還能夠估算出應(yīng)用程序的性能及拋出的異常。甚至更多的，你可以得到有關(guān)應(yīng)用程序的使用情況統(tǒng)計(jì)。

審計(jì)系統(tǒng)使用IAbpSession接口來(lái)獲取當(dāng)前用戶(hù)Id和租戶(hù)ID。

注意：關(guān)于IAuditingStore接口

審計(jì)系統(tǒng)使用IAuditingStore接口來(lái)保存審計(jì)信息。module-zero項(xiàng)目是這個(gè)接口的完整實(shí)現(xiàn)，當(dāng)然你也可以通過(guò)自己的方式來(lái)實(shí)現(xiàn)這個(gè)接口。如果你不想自己實(shí)現(xiàn)這個(gè)接口，SimpleLogAuditingStore類(lèi)可以直接拿來(lái)使用，它是實(shí)現(xiàn)方式是將審計(jì)信息寫(xiě)入日志中。

配置：

可以在你的模塊初始化方法（PreInitialize）中使用Configuration.Auditing的屬性來(lái)配置審計(jì)，Auditing屬性默認(rèn)是啟用狀態(tài)（即true）。你可以禁用它

public class MyModule : AbpModule

{

  public override void PreInitialize()

  {

    Configuration.Auditing.IsEnabled = false;

  }

  //...

}

以下是審計(jì)配置的屬性：

IsEnabled: 用于設(shè)置完全啟用或禁用審計(jì)系統(tǒng)。默認(rèn)值：true.

IsEnabledForAnonymousUsers:如果設(shè)置成ture，未登陸的用戶(hù)的審計(jì)日志也會(huì)保存。默認(rèn)值: false.

MvcControllers: 在A(yíng)SP.NET MVC 控制器中使用審計(jì)日志

IsEnabled: 在A(yíng)SP.NET MVC中啟用（true）或禁用（false）審計(jì)日志. 默認(rèn)值: true.

IsEnabledForChildActions: 為MVC actions啟用（true）或禁用（false）審計(jì)日志. 默認(rèn)值: false.

Selectors: 選擇使用其他類(lèi)來(lái)處理審計(jì)日志的存儲(chǔ)。

正如你所看到的，審計(jì)系統(tǒng)單獨(dú)為mvc控制器提供了審計(jì)配置使之可以使用不同的方法來(lái)使用它。

Selectors是一個(gè)斷言(推斷類(lèi)型)選擇器列表，用于選擇那種方式來(lái)保存審計(jì)日志。每一個(gè)選擇器包含一個(gè)唯一的名稱(chēng)和一個(gè)斷言。斷言列表中默認(rèn)的選擇器，使用的是應(yīng)用程序服務(wù)類(lèi)。

Configuration.Auditing.Selectors.Add(

  new NamedTypeSelector(

    "Abp.ApplicationServices",

    type => typeof (IApplicationService).IsAssignableFrom(type)

  )

);

你可以在自己的模塊初始化方法（PreInitialize）中添加自己的斷言選擇器。同樣的，如果你不喜歡使用應(yīng)用程序服務(wù)來(lái)保存審計(jì)日志，你也可以通過(guò)名稱(chēng)(name)來(lái)移除斷言選擇器，這就是為什么斷言選擇器的名稱(chēng)必須是唯一的（你也可以通過(guò)Linq的方式查找到選擇器來(lái)移除它）。

通過(guò)屬性來(lái)啟用和禁用審計(jì)日志：

當(dāng)你使用配置項(xiàng)來(lái)配置斷言選擇器時(shí)，你可以通過(guò)使用Audited和DisableAuditing特性標(biāo)記到單個(gè)類(lèi)或單個(gè)方法來(lái)實(shí)現(xiàn)審計(jì)系統(tǒng)的啟用和禁用。例如：

[Audited]

public class MyClass

{

  public void MyMethod1(int a)

  {

    //...

  }

  [DisableAuditing]

  public void MyMethod2(string b)

  {

    //...

  }

  public void MyMethod3(int a, int b)

  {

    //...

  }

}

上述列子中，MyClass類(lèi)中除了MyMethod2明確標(biāo)記不需要審計(jì)外，其他的方法都會(huì)被審計(jì)。Audited特性能夠幫助你只想保存審計(jì)日志的方法，進(jìn)行審計(jì)日志保存。