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

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

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

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

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

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

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

using Castle.Core.Logging; //1: 導(dǎo)入日志的命名空間，Castle.Core.Loggingpublic class TaskAppService : ITaskAppService{  //2:通過依賴注入獲取日志記錄器對象。 這里先定義了一個ILogger類型的public屬性Logger，這個對象就是我們用來記錄日志的對象。在創(chuàng)建了TaskAppService對象（就是我們應(yīng)用中定義的任務(wù)）以后，通過屬性注入的方式來實(shí)現(xiàn)。 public ILogger Logger { get; set; } public TaskAppService() {   //3: 如果沒有日志記錄器，將日志記錄器返回一個空的實(shí)例，不寫日志。這是依賴注入的最佳實(shí)現(xiàn)方式，  // 如果你不定義這個空的日志記錄器，當(dāng)我們獲取對象引用并且實(shí)例化的時候，就會產(chǎn)生異常。  // 這么做，保證了對象不為空。所以，換句話說，不設(shè)置日志記錄器，就不記錄日志，返回一個null的對象。  // NullLogger對象實(shí)際上什么都木有，空的。這么做，才能保證我們定義的類在實(shí)例化時正常運(yùn)作。  Logger = NullLogger.Instance; }  public void CreateTask(CreateTaskInput input)  {  //4: 寫入日志  Logger.Info("Creating a new task with description: " + input.Description);  //TODO: save task to database... } } 

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

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

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

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

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

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

•Log level: 日志記錄等級，有DEBUG, INFO, WARN, ERROR or FATAL5個。
•Date and time: 日志記錄時間。
•Thread number: 每行日志寫時候的線程號。
•Logger name: 日志記錄器的名字，通常情況就是類名稱。
•Log text: 你寫入的日志內(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是一個非常強(qiáng)大和易用的日志庫組件，你可以寫各種日志，比如寫到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.AddFacility<LoggingFacility>(f => f.UseLog4Net().WithConfig("log4net.config"));  base.Application_Start(sender, e); }}

幾行代碼就調(diào)用了Log4Net這個日志記錄組件，工程中的Log4Net庫是在 nuget package包中的，你也可以換成其他日志組件庫，但是代碼不用做任何改變。因?yàn)椋覀兊目蚣苁峭ㄟ^依賴注入實(shí)現(xiàn)日志記錄器的！

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

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

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

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

設(shè)置管理
介紹
每個應(yīng)用程序需要存儲一些設(shè)置并在應(yīng)用程序的某個地方使用這些設(shè)置。ABP框架提供強(qiáng)大的基礎(chǔ)架構(gòu)，我們可以在服務(wù)端或者客戶端設(shè)置，來存儲/獲取應(yīng)用程序、 租戶和用戶級別的配置。

設(shè)置通常是存儲在數(shù)據(jù)庫（或另一個來源）中，用名稱-值（name-value）字符串對應(yīng)的結(jié)構(gòu)來表示。我們可以把非字符串值轉(zhuǎn)換成字符串值來存儲。

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

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

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

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 類的構(gòu)造函數(shù)中有如下參數(shù)：

•Name (必填):必須具有全系統(tǒng)唯一的名稱。比較好的辦法是定義字符串常量來設(shè)置Name。
•Default value: 設(shè)置一個默認(rèn)值。此值可以是null 或空字符串。
•Scopes: 定義設(shè)置的范圍 (見下文)。
•Display name: 一個可本地化的字符串，用于以后在UI中顯示設(shè)置的名稱。
•Description: 一個可本地化的字符串，用于以后在UI中顯示設(shè)置的描述。
•Group: 可用于設(shè)置組。這僅僅是UI使用，不用于設(shè)置管理。
•IsVisibleToClients: 設(shè)置為 true 將使設(shè)置在客戶端可用。
在創(chuàng)建設(shè)置提供程序(SettingProvider)之后，我們應(yīng)該在預(yù)初始化(PreIntialize)方法中注冊我們的模塊:

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

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

•Application：應(yīng)用程序范圍設(shè)置用于用戶/租戶獨(dú)立的設(shè)置。例如，我們可以定義一個名為"SmtpServerAddress"的設(shè)置，當(dāng)發(fā)送電子郵件時，獲取服務(wù)器的 IP 地址。如果此設(shè)置有一個單一的值 (不基于用戶改變)，那么我們可以定義它為應(yīng)用程序范圍。
•Tenant：如果應(yīng)用程序是多租戶的，我們可以定義特定于租戶的設(shè)置。
•User：我們可以使用的用戶范圍的設(shè)置來為每個用戶存儲/獲取設(shè)置的值。
SettingScopes 枚舉具有Flags屬性，所以我們可以定義一個具有多個作用域的設(shè)置。

設(shè)置范圍是分層的。例如，如果我們定義設(shè)置范圍為"Application | Tenant | User"并嘗試獲取當(dāng)前設(shè)置的值;

•我們獲取特定用戶的值，如果它定義 (重寫) User。
•如果沒有，我們獲取特定的租戶值，如果它定義 (重寫) Tenant。
•如果沒有，我們獲取應(yīng)用的值，如果它定義Application。
•如果沒有，我們得到的默認(rèn)值。
默認(rèn)值可以是 null 或空字符串。如果可以，建議為設(shè)置提供一個默認(rèn)值。

獲取設(shè)置值
定義設(shè)置后，我們可以在服務(wù)器和客戶端獲取到它的當(dāng)前值。

(1)服務(wù)器端（Server side）
ISettingManager 用于執(zhí)行設(shè)置操作。我們可以在應(yīng)用程序中任何地方注入和使用它。ISettingManager 定義了很多獲取設(shè)置值方法。

最常用的方法是 GetSettingValue (或GetSettingValueAsync 為異步調(diào)用)。它將返回當(dāng)前設(shè)置的基于默認(rèn)值、 應(yīng)用程序、 租戶和用戶設(shè)置范圍的值(如設(shè)置范圍之前的一段中所述)。例子:

//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 有泛型和異步版本，如上所示。也有方法來獲取特定的租戶或用戶的設(shè)置值或所有設(shè)置值的列表。

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

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

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

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

關(guān)于緩存
緩存在服務(wù)器端設(shè)置管理，所以，我們不應(yīng)直接使用存儲庫或數(shù)據(jù)庫更新語句改變設(shè)置的值。