ABP(現代ASP.NET樣板開發框架)系列之8、ABP日誌管理
基於DDD的現代ASP.NET開發框架--ABP系列之8、ABP日誌管理
ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。
本文由東莞-天道提供翻譯
Server side(伺服器端)
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這個專案,也許這其中有能幫助到您的地方,也許有您的參與,這個專案可以發展得更好。
歡迎加ABP架構設計交流QQ群:134710707
相關推薦
ABP(現代ASP.NET樣板開發框架)系列之8、ABP日誌管理
基於DDD的現代ASP.NET開發框架--ABP系列之8、ABP日誌管理 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 本文由東莞-天道提供翻譯 Server side(伺服器端) ASP.NET Boilerpla
ABP(現代ASP.NET樣板開發框架)系列之10、ABP領域層——實體
基於DDD的現代ASP.NET開發框架--ABP系列之10、ABP領域層——實體 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 本文由深圳-Carl提供翻譯 實體是DDD(領域驅動設計)的核心概念之一。Eric Eva
ABP(現代ASP.NET樣板開發框架)系列之4、ABP模組系統
基於DDD的現代ASP.NET開發框架--ABP系列之4、ABP模組系統 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 本文由東莞-天道提供翻譯 ABP模組系統簡介 ABP框架提供了建立和組裝模組的基礎,一個模組
ABP(現代ASP.NET樣板開發框架)系列之6、ABP依賴注入
基於DDD的現代ASP.NET開發框架--ABP系列之6、ABP依賴注入 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 本文由 上海-半冷 提供翻譯 什麼是依賴注入 如果你已經知道依賴注入的概念,建構函式和屬性注入
ABP(現代ASP.NET樣板開發框架)系列之9、ABP設定管理
基於DDD的現代ASP.NET開發框架--ABP系列之9、ABP設定管理 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 本文由山東-李偉提供翻譯 介紹 每個應用程式需要儲存一些設定並在應用程式的某個地方使用這些設定。
ABP(現代ASP.NET樣板開發框架)系列之2、ABP入門教程
基於DDD的現代ASP.NET開發框架--ABP系列之2、ABP入門教程 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 ASP.NET Boilerplate是一個用最佳實踐和流行技術開發現代WEB應用程式的新起點,它旨在成為一個通用的
ABP(現代ASP.NET樣板開發框架)系列之17、ABP應用層——引數有效性驗證
基於DDD的現代ASP.NET開發框架--ABP系列之17、ABP應用層——引數有效性驗證 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 應用程式的輸入資料首先應該被檢驗是否有效。輸入的資料能被使用者或其他應用程式提
ABP(現代ASP.NET樣板開發框架)系列之16、ABP應用層——資料傳輸物件(DTOs)
基於DDD的現代ASP.NET開發框架--ABP系列之16、ABP應用層——資料傳輸物件(DTOs) ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 資料傳輸物件(Data Transfer Objects)用於應用層
ABP(現代ASP.NET樣板開發框架)系列之13、ABP領域層——資料過濾器(Data filters)
基於DDD的現代ASP.NET開發框架--ABP系列之13、ABP領域層——資料過濾器(Data filters) ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 介紹 在資料庫開發中,我們一般會運用軟刪除(soft
ABP(現代ASP.NET樣板開發框架)系列之21、ABP展現層——Javascript函式庫
基於DDD的現代ASP.NET開發框架--ABP系列之21、ABP展現層——Javascript函式庫 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 ASP.NET Boilerplate的js庫提供了一些讓java
ABP(現代ASP.NET樣板開發框架)系列之14、ABP領域層——領域事件(Domain events)
基於DDD的現代ASP.NET開發框架--ABP系列之14、ABP領域層——領域事件(Domain events) ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 在C#中,一個類可以定義其專屬的事件並且其它類可以註冊該事
ABP(現代ASP.NET樣板開發框架)系列之5、ABP啟動配置
基於DDD的現代ASP.NET開發框架--ABP系列之5、ABP啟動配置 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 本文由 東莞-天道 提供翻譯 譯者注:在看這一節的內容之前,建議大家先下載module-ze
ABP(現代ASP.NET樣板開發框架)系列之3、ABP分層架構
基於DDD的現代ASP.NET開發框架--ABP系列之3、ABP分層架構 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 前言 為了減少複雜性和提高程式碼的可重用性,採用分層架構是一種被廣泛接受的技術。為了實現分層的
ABP(現代ASP.NET樣板開發框架)系列之19、ABP應用層——審計日誌
基於DDD的現代ASP.NET開發框架--ABP系列之19、ABP應用層——審計日誌 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 維基百科定義:審計跟蹤(也稱為稽核日誌)是一個安全相關的時間順序記錄,記錄這些記錄的
ABP(現代ASP.NET樣板開發框架)系列之15、ABP應用層——應用服務(Application services)
基於DDD的現代ASP.NET開發框架--ABP系列之15、ABP應用層——應用服務(Application services) ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 本文由東莞-天道提供翻譯 應用服務用於將領
ABP(現代ASP.NET樣板開發框架)系列之23、ABP展現層——異常處理
基於DDD的現代ASP.NET開發框架--ABP系列之23、ABP展現層——異常處理 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 在 web 應用程式中,異常通常是在 MVC Controller actions
ABP(現代ASP.NET樣板開發框架)系列之1、ABP總體介紹
基於DDD的現代ASP.NET開發框架--ABP系列之1、ABP總體介紹 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 ASP.NET Boilerplate是一個用最佳實踐和流行技術開發現代WEB應用程式的新起點,它旨在成為一個通用的
ABP(現代ASP.NET樣板開發框架)系列之12、ABP領域層——工作單元(Unit Of work)
基於DDD的現代ASP.NET開發框架--ABP系列之12、ABP領域層——工作單元(Unit Of work) ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 通用連線和事務管理方法 連線和事務管理是使用資料庫的應用程
ABP(現代ASP.NET樣板開發框架)系列之22、ABP展現層——導航欄設定
基於DDD的現代ASP.NET開發框架--ABP系列之22、ABP展現層——導航欄設定 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 每一個WEB應用程式都有導航選單,Abp也為使用者提供了通用的建立和顯示選單方式。
ABP(現代ASP.NET樣板開發框架)系列之7、ABP Session管理
基於DDD的現代ASP.NET開發框架--ABP系列之7、ABP Session管理 ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。 簡介 如果一個應用程式需要登入,則它必須知道當前使用者執行了什麼操作。因此ASP.