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 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> <level value="WARN" /> </logger> </log4net>