詳解ABP框架中的日誌管理和設置管理的基本配置

日誌管理

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.Loggingpublic 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!

寫入日誌以後，我們可以查看日誌文件，就像下面的格式：

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框架提供強大的基礎架構，我們可以在服務端或者客戶端設置，來存儲/獲取應用程序、 租戶和用戶級別的配置。

設置通常是存儲在數據庫（或另一個來源）中，用名稱-值（name-value）字符串對應的結構來表示。我們可以把非字符串值轉換成字符串值來存儲。

注意：關於ISettingStore接口

為了使用設置管理必須實現ISettingStore 接口。你可以用自己的方式實現它，在module-zero項目中有完整的實現可以參考。

定義設置

使用設置之前必須要先定義。 ABP框架是模塊化設計，所以不同的模塊可以有不同的設置。為了定義模塊自己的設置，每個模塊都應該創建繼承自SettingProvider 的派生類。設置提供程序示例如下所示：

 public class MySettingProvider : SettingProvider{ public override IEnumerable<SettingDefinition> GetSettingDefinitions(SettingDefinitionProviderContext context) { return new[] { new SettingDefinition( SmtpServerAddress, 127.0.0.1 ), new SettingDefinition( PassiveUsersCanNotLogin, true, scopes: SettingScopes.Application | SettingScopes.Tenant ) , new SettingDefinition( SiteColorPreference, red, scopes: SettingScopes.User, isVisibleToClients: true ) }; }}

GetSettingDefinitions 方法返回SettingDefinition 對象。 SettingDefinition 類的構造函數中有如下參數：

•Name (必填):必須具有全系統唯一的名稱。比較好的辦法是定義字符串常量來設置Name。

•Default value: 設置一個默認值。此值可以是null 或空字符串。

•Scopes: 定義設置的範圍(見下文)。

•Display name: 一個可本地化的字符串，用於以後在UI中顯示設置的名稱。

•Description: 一個可本地化的字符串，用於以後在UI中顯示設置的描述。

•Group: 可用於設置組。這僅僅是UI使用，不用於設置管理。

•IsVisibleToClients: 設置為true 將使設置在客戶端可用。

在創建設置提供程序(SettingProvider)之後，我們應該在預初始化(PreIntialize)方法中註冊我們的模塊:

Configuration.Settings.Providers.Add<MySettingProvider>();設置提供程序會自動註冊依賴注入。所以，設置提供程序可以注入任何依賴項(如存儲庫) 來生成設置定義的一些其它來源。

設置範圍

有三個設置範圍(或級別) 在SettingScopes 枚舉中定義:

•Application：應用程序範圍設置用於用戶/租戶獨立的設置。例如，我們可以定義一個名為SmtpServerAddress的設置，當發送電子郵件時，獲取服務器的IP 地址。如果此設置有一個單一的值(不基於用戶改變)，那麼我們可以定義它為應用程序範圍。

•Tenant：如果應用程序是多租戶的，我們可以定義特定於租戶的設置。

•User：我們可以使用的用戶範圍的設置來為每個用戶存儲/獲取設置的值。

SettingScopes 枚舉具有Flags屬性，所以我們可以定義一個具有多個作用域的設置。

設置範圍是分層的。例如，如果我們定義設置範圍為Application | Tenant | User並嘗試獲取當前設置的值;

•我們獲取特定用戶的值，如果它定義(重寫) User。

•如果沒有，我們獲取特定的租戶值，如果它定義(重寫) Tenant。

•如果沒有，我們獲取應用的值，如果它定義Application。

•如果沒有，我們得到的默認值。

默認值可以是null 或空字符串。如果可以，建議為設置提供一個默認值。

獲取設置值

定義設置後，我們可以在服務器和客戶端獲取到它的當前值。

(1)服務器端（Server side）

ISettingManager 用於執行設置操作。我們可以在應用程序中任何地方注入和使用它。 ISettingManager 定義了很多獲取設置值方法。

最常用的方法是GetSettingValue (或GetSettingValueAsync 為異步調用)。它將返回當前設置的基於默認值、 應用程序、 租戶和用戶設置範圍的值(如設置範圍之前的一段中所述)。例子:

 //Getting a boolean value (async call)var value1 = await SettingManager.GetSettingValueAsync<bool>(PassiveUsersCanNotLogin);//Getting a string value (sync call)var value2 = SettingManager.GetSettingValue(SmtpServerAddress);

GetSettingValue 有泛型和異步版本，如上所示。也有方法來獲取特定的租戶或用戶的設置值或所有設置值的列表。

由於ISettingManager使用廣泛，一些特定的基類(如ApplicationService、 DomainService 和AbpController) 有一個名為SettingManager的屬性。如果我們從這些類繼承，就無需顯式地註入它。

(2)客戶端

如果定義設置時將IsVisibleToClients 設置為true，就可以在客戶端使用javascript得到它的當前值。 abp.setting 命名空間定義所需的函數和對象。示例:

var currentColor = abp.setting.get(SiteColorPreference);也有getInt 和getBoolean 這樣的方法。你可以使用abp.setting.values 對象獲取所有值。請注意，如果你在服務器端更改設置，客戶端不會知道這種變化，除非刷新頁面或者以某種方式重新加載頁面或者通過代碼手動更新。

更改設置

ISettingManager 定義了ChangeSettingForApplicationAsync，ChangeSettingForTenantAsync 和ChangeSettingForUserAsync 方法（以及同步版本）來更改應用程序，租戶和用戶分別的設置。

關於緩存

緩存在服務器端設置管理，所以，我們不應直接使用存儲庫或數據庫更新語句改變設置的值。