主页 > 知识库 > ABP框架中的日志功能完全解析

ABP框架中的日志功能完全解析

热门标签:苹果 地方门户网站 呼叫中心 智能手机 电子围栏 服务器配置 解决方案 硅谷的囚徒呼叫中心

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.AddFacilityLoggingFacility>(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提供了能够为应用程序交互自动记录日志的基础设施,它能记录你调用的方法的调用者信息和参数信息。从根本上来说,存储区域包含:

  • tenant id(相关的租户Id),
  • user id(请求用户Id),
  • server name(请求的服务名称【调用方法对应的类】),
  • method name(调用方法名称),
  • parameters(方法的参数【JSON格式】),
  • execution time(执行时间),
  • duration (执行耗时时间【通常是毫秒】),
  • IP address (客户端IP地址),
  • computer name(客户机名称),
  • exception (异常【如果方法抛出异常】)等信息。

有了这些信息,我们不仅能够知道谁进行了操作,还能够估算出应用程序的性能及抛出的异常。甚至更多的,你可以得到有关应用程序的使用情况统计。

审计系统使用IAbpSession接口来获取当前用户Id和租户ID。

注意:关于IAuditingStore接口

审计系统使用IAuditingStore接口来保存审计信息。module-zero项目是这个接口的完整实现,当然你也可以通过自己的方式来实现这个接口。如果你不想自己实现这个接口,SimpleLogAuditingStore类可以直接拿来使用,它是实现方式是将审计信息写入日志中。

 配置:
可以在你的模块初始化方法(PreInitialize)中使用Configuration.Auditing的属性来配置审计,Auditing属性默认是启用状态(即true)。你可以禁用它,如下图所示:

public class MyModule : AbpModule
{
  public override void PreInitialize()
  {
    Configuration.Auditing.IsEnabled = false;
  }

  //...
}

以下是审计配置的属性:

IsEnabled: 用于设置完全启用或禁用审计系统。默认值:true.
IsEnabledForAnonymousUsers:如果设置成ture,未登陆的用户的审计日志也会保存。默认值: false.
MvcControllers: 在ASP.NET MVC 控制器中使用审计日志
IsEnabled: 在ASP.NET MVC中启用(true)或禁用(false)审计日志. 默认值: true.
IsEnabledForChildActions: 为MVC actions启用(true)或禁用(false)审计日志. 默认值: false.
Selectors: 选择使用其他类来处理审计日志的存储。

正如你所看到的,审计系统单独为mvc控制器提供了审计配置使之可以使用不同的方法来使用它。

Selectors是一个断言(推断类型)选择器列表,用于选择那种方式来保存审计日志。每一个选择器包含一个唯一的名称和一个断言。断言列表中默认的选择器,使用的是应用程序服务类。如下图所示:

Configuration.Auditing.Selectors.Add(
  new NamedTypeSelector(
    "Abp.ApplicationServices",
    type => typeof (IApplicationService).IsAssignableFrom(type)
  )
);

你可以在自己的模块初始化方法(PreInitialize)中添加自己的断言选择器。同样的,如果你不喜欢使用应用程序服务来保存审计日志,你也可以通过名称(name)来移除断言选择器,这就是为什么断言选择器的名称必须是唯一的(你也可以通过Linq的方式查找到选择器来移除它)。

通过属性来启用和禁用审计日志:
当你使用配置项来配置断言选择器时,你可以通过使用Audited和DisableAuditing特性标记到单个类或单个方法来实现审计系统的启用和禁用。例如:

[Audited]
public class MyClass
{
  public void MyMethod1(int a)
  {
    //...
  }

  [DisableAuditing]
  public void MyMethod2(string b)
  {
    //...
  }

  public void MyMethod3(int a, int b)
  {
    //...
  }
}

上述列子中,MyClass类中除了MyMethod2明确标记不需要审计外,其他的方法都会被审计。Audited特性能够帮助你只想保存审计日志的方法,进行审计日志保存。

您可能感兴趣的文章:
  • 解析ABP框架中的数据传输对象与应用服务
  • 详解ABP框架的参数有效性验证和权限验证
  • 详解ABP框架中领域层的领域事件Domain events
  • 解析ABP框架中的事务处理和工作单元
  • 详解ABP框架中的数据过滤器与数据传输对象的使用
  • 解析ABP框架领域层中的实体类与仓储类
  • 详解ABP框架中Session功能的使用方法
  • 详解ABP框架中的日志管理和设置管理的基本配置
  • ABP框架的基础配置及依赖注入讲解
  • ABP框架的体系结构及模块系统讲解
  • ASP.NET样板项目ABP框架的特性总结
  • 基于ASP.NET MVC的ABP框架入门学习教程
  • ABP框架中导航菜单的使用及JavaScript API获取菜单的方法

标签:德宏 喀什 房产 泰安 海口 吕梁 玉林 佳木斯

巨人网络通讯声明:本文标题《ABP框架中的日志功能完全解析》,本文关键词  ;如发现本文内容存在版权问题,烦请提供相关信息告之我们,我们将及时沟通与处理。本站内容系统采集于网络,涉及言论、版权与本站无关。
  • 相关文章
  • 收缩
    • 微信客服
    • 微信二维码
    • 电话咨询

    • 400-1100-266