欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2023-12-03 09:29:16
asp.net boilerplate使用castle windsor's logging facility日志记录工具,并且可以使用不同的日志类库,比如:log4net,...

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

  • 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特性能够帮助你只想保存审计日志的方法,进行审计日志保存。