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是怎麼實現日誌記錄功能的吧：
?| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
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!
寫入日誌以後，我們可以檢視日誌檔案，就像下面的格式：
通過基類使用LoggerASP.NET Boilerplate框架提供了MVC Controllers、Web API Controllers和Application service classes的基類（自己定義的控制器和應用服務，都必須要繼承ASP.NET Boilerplate的基類，換句話說，當你自定義的Web API controllers、mvc controllers，Application service classes都繼承了ASP.NET Boilerplate框架對應的基類，你就可以直接使用日誌記錄器）。 ?
| 1 2 3 4 5 6 7 8 |
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目錄下面。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
<?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的配置檔案：
?| 1 2 3 4 5 6 7 8 |
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，這意味著你可以記錄下來瀏覽器的日誌，實現程式碼如下：
| 1 |
abp.log.warn('a sample log message...');
|
附上：客戶端javascript的api，這裡要說明的是，你可以使用console.log在客戶端輸出日誌，但是這個API 不一定支援所有的瀏覽器，還有可能導致你的指令碼出現異常，你可以使用我們的api，我們的是安全的，你甚至可以過載或者擴充套件這些api。
?| 1 2 3 4 5 |
abp.log.debug('...');
abp.log.info('...');
abp.log.warn('...');
abp.log.error('...');
abp.log.fatal('...');
|
設定管理
介紹
每個應用程式需要儲存一些設定並在應用程式的某個地方使用這些設定。ABP框架提供強大的基礎架構，我們可以在服務端或者客戶端設定，來儲存/獲取應用程式、 租戶和使用者級別的配置。
設定通常是儲存在資料庫（或另一個來源）中，用名稱-值（name-value）字串對應的結構來表示。我們可以把非字串值轉換成字串值來儲存。
注意：關於ISettingStore介面
為了使用設定管理必須實現 ISettingStore 介面。你可以用自己的方式實現它，在module-zero專案中有完整的實現可以參考。
定義設定
使用設定之前必須要先定義。ABP框架是模組化設計，所以不同的模組可以有不同的設定。為了定義模組自己的設定，每個模組都應該建立繼承自SettingProvider 的派生類。設定提供程式示例如下所示：
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
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 為非同步呼叫)。它將返回當前設定的基於預設值、 應用程式、 租戶和使用者設定範圍的值(如設定範圍之前的一段中所述)。例子:
?| 1 2 3 4 |
//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 方法（以及同步版本）來更改應用程式，租戶和使用者分別的設定。
關於快取
快取在伺服器端設定管理，所以，我們不應直接使用儲存庫或資料庫更新語句改變設定的值。