详解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.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框架提供强大的基础架构，我们可以在服务端或者客户端设置，来存储/获取应用程序、 租户和用户级别的配置。

设置通常是存储在数据库（或另一个来源）中，用名称-值（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 方法（以及同步版本）来更改应用程序，租户和用户分别的设置。

关于缓存
缓存在服务器端设置管理，所以，我们不应直接使用存储库或数据库更新语句改变设置的值。