濮阳杆衣贸易有限公司

主頁 > 知識庫 > ABP框架中的日志功能完全解析

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

熱門標簽:臨沂智能電話機器人加盟 蘇州如何辦理400電話 外呼電話機器人成本 西寧呼叫中心外呼系統(tǒng)線路商 聯(lián)通官網(wǎng)400電話辦理 地圖標注軟件免費下載 百應(yīng)電話機器人外呼系統(tǒng) 400電話辦理怎么樣 網(wǎng)絡(luò)電話外呼系統(tǒng)上海

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

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

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

獲取日志記錄器logger

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

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

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

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

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

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

  public TaskAppService()
  { 
   //3: 如果沒有日志記錄器,將日志記錄器返回一個空的實例,不寫日志。這是依賴注入的最佳實現(xiàn)方式,
   //  如果你不定義這個空的日志記錄器,當我們獲取對象引用并且實例化的時候,就會產(chǎn)生異常。
   //  這么做,保證了對象不為空。所以,換句話說,不設(shè)置日志記錄器,就不記錄日志,返回一個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的基類(自己定義的控制器和應(yīng)用服務(wù),都必須要繼承ASP.NET Boilerplate的基類,換句話說,當你自定義的Web API controllers、mvc controllers,Application service classes都繼承了ASP.NET Boilerplate框架對應(yīng)的基類,你就可以直接使用日志記錄器)。

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

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

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

配置

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

默認的配置格式如下:

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

配置文件: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文件,寫入到數(shù)據(jù)庫等等。你能設(shè)置最小的日志等級,就像上面這個針對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.AddFacilityLoggingFacility>(f => f.UseLog4Net().WithConfig("log4net.config"));
    base.Application_Start(sender, e);
  }
}

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

Client side(客戶端)

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

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

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

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


審計跟蹤日志
ABP提供了能夠為應(yīng)用程序交互自動記錄日志的基礎(chǔ)設(shè)施,它能記錄你調(diào)用的方法的調(diào)用者信息和參數(shù)信息。從根本上來說,存儲區(qū)域包含:

  • tenant id(相關(guān)的租戶Id),
  • user id(請求用戶Id),
  • server name(請求的服務(wù)名稱【調(diào)用方法對應(yīng)的類】),
  • method name(調(diào)用方法名稱),
  • parameters(方法的參數(shù)【JSON格式】),
  • execution time(執(zhí)行時間),
  • duration (執(zhí)行耗時時間【通常是毫秒】),
  • IP address (客戶端IP地址),
  • computer name(客戶機名稱),
  • exception (異?!救绻椒⊕伋霎惓!浚┑刃畔?。

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

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

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

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

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

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

  //...
}

以下是審計配置的屬性:

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

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

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

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

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

通過屬性來啟用和禁用審計日志:
當你使用配置項來配置斷言選擇器時,你可以通過使用Audited和DisableAuditing特性標記到單個類或單個方法來實現(xiàn)審計系統(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類中除了MyMethod2明確標記不需要審計外,其他的方法都會被審計。Audited特性能夠幫助你只想保存審計日志的方法,進行審計日志保存。

您可能感興趣的文章:
  • 解析ABP框架中的數(shù)據(jù)傳輸對象與應(yīng)用服務(wù)
  • 詳解ABP框架的參數(shù)有效性驗證和權(quán)限驗證
  • 詳解ABP框架中領(lǐng)域?qū)拥念I(lǐng)域事件Domain events
  • 解析ABP框架中的事務(wù)處理和工作單元
  • 詳解ABP框架中的數(shù)據(jù)過濾器與數(shù)據(jù)傳輸對象的使用
  • 解析ABP框架領(lǐng)域?qū)又械膶嶓w類與倉儲類
  • 詳解ABP框架中Session功能的使用方法
  • 詳解ABP框架中的日志管理和設(shè)置管理的基本配置
  • ABP框架的基礎(chǔ)配置及依賴注入講解
  • ABP框架的體系結(jié)構(gòu)及模塊系統(tǒng)講解
  • ASP.NET樣板項目ABP框架的特性總結(jié)
  • 基于ASP.NET MVC的ABP框架入門學習教程
  • ABP框架中導航菜單的使用及JavaScript API獲取菜單的方法

標簽:中衛(wèi) 臨夏 慶陽 海西 甘肅 清遠 聊城

巨人網(wǎng)絡(luò)通訊聲明:本文標題《ABP框架中的日志功能完全解析》,本文關(guān)鍵詞  ABP,框架,中的,日志,功能,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。
  • 相關(guān)文章
  • 下面列出與本文章《ABP框架中的日志功能完全解析》相關(guān)的同類信息!
  • 本頁收集關(guān)于ABP框架中的日志功能完全解析的相關(guān)信息資訊供網(wǎng)民參考!
  • 推薦文章
    东乌珠穆沁旗| 楚雄市| 东山县| 南昌市| 偃师市| 扬中市| 堆龙德庆县| 米易县| 龙泉市| 定州市| 会泽县| 四平市| 都江堰市| 商河县| 岗巴县| 开原市| 宜春市| 清远市| 喀喇| 济宁市| 自贡市| 张家界市| 石阡县| 项城市| 繁昌县| 郸城县| 三明市| 东乌珠穆沁旗| 灵璧县| 邢台县| 荥经县| 闽侯县| 尼勒克县| 泾阳县| 浙江省| 龙门县| 天镇县| 沭阳县| 杨浦区| 鄄城县| 云梦县|