解读ASP.NET 5 & MVC6系列教程（9）：日志框架

框架介绍

在之前的.net中，微软还没有提供过像样的日志框架，目前能用的一些框架比如log4net、nlog、commonlogging使用起来多多少少都有些费劲，和java的slf4j根本无法相比。但在新版的asp.net5中，可谓是牛气冲天，微软提供的microsoft.framework.logging框架集可谓就是.net版的slf4j，提供相应的接口，其它第三方组件可以根据接口实现自己的实现。

iloggerfactory接口

iloggerfactory接口是日志的入库点，在系统中通过依赖注入可以获取该接口的实例，并根据该示例创建日志记录器ilogger来记录日志，示例如下：

var factory = serviceprovider.getrequiredservice<iloggerfactory>();
 var logger1 = factory.createlogger(typeof(homecontroller).fullname); //createlogger
 var logger2 = factory.createlogger<homecontroller>(); //createlogger

 logger1.log(loglevel.information, 1, null, null, null); // 日志记录
 logger1.loginformation("123"); // 扩展方法
 logger1.logerror("123"); // 扩展方法

或者，你也可以在startup.cs的configure方法中，从loggerfactory参数中获取上述示例。

iloggerfactory接口的定义如下：

public interface iloggerfactory
{
 //日志最小记录级别
 loglevel minimumlevel { get; set; }

 //创建日志记录实例
 ilogger createlogger(string categoryname); //一般是根据功能模块或类名进行分类

 void addprovider(iloggerprovider provider); // 添加日志记录provider（如第三方实现）
}

在该接口的实现中，我们可以设置日志的最小记录基本，其类别如下：

public enum loglevel
{
 debug = 1,
 verbose = 2,
 information = 3,
 warning = 4,
 error = 5,
 critical = 6,
}

也可以添加第三方实现的provider，比如添加一个控制台版本的实现：

public static iloggerfactory addconsole(this iloggerfactory factory)
{
 factory.addprovider(new consoleloggerprovider((category, loglevel) => loglevel >= loglevel.information));
 return factory;
}

然后通过createlogger方法创建日志记录器实例，最后再记录日志。

iloggerprovider和ilogger

所有的第三方实现都需要实现iloggerprovider接口和ilogger接口，其中接口很简单，就是实现创建ilogger接口的方法即可，代码如下：

public interface iloggerprovider
{
 ilogger createlogger(string name); //创建给定类别的ilgger实例
}

而ilogger的实现，也相对简单，除了实现通用的日志记录方法以外，还需要实现一个日志级别判断的方法以及一个作用域创建方法，接口定义如下：

public interface ilogger
{
 //支持大多数日志记录的通用方法，其它访问通过扩展方法进行完善
 void log(loglevel loglevel, int eventid, object state, exception exception, func<object, exception, string> formatter);

 //判断是否可以记录给定的日志级别
 bool isenabled(loglevel loglevel);

 //开启一个逻辑操作作用域
 idisposable beginscopeimpl(object state);
}

实现了上述两个接口，即可通过factory的addprovider方法，将该provider添加到实例中，达到记录日志的目的。asp.net 5中目前的默认实现了4中日志记录provider，分别是：console、nlog、serilog、trace，注册这些provider的时候，均可以使用扩展方法，实例如下：

loggerfactory.addconsole()
loggerfactory.addnlog(new nlog.logfactory())
loggerfactory.addserilog(new loggerconfiguration())
var testswitch = new sourceswitch("testswitch", "level will be set to warning for this test");
factory.addtracesource(testswitch, new consoletracelistener());

ilogger的扩展方法

为了方便记录日志，微软在microsoft.framework.logging.loggerextensions上，针对6个级别的日志记录均定义了6个如下形式的扩展方法，实例如下：

public static void loginformation(this ilogger logger, string message)
public static void loginformation(this ilogger logger, int eventid, string message)
public static void loginformation(this ilogger logger, string format, params object[] args)
public static void loginformation(this ilogger logger, int eventid, string format, params object[] args)
public static void loginformation(this ilogger logger, ilogvalues state, exception error = null)
public static void loginformation(this ilogger logger, int eventid, ilogvalues state, exception error = null)

// 其它debug、verbose、warning、error、critical也都遵循logxxxx()规则.

所以使用的时候，我们可以使用像logdebug()、logerror()这样的方法来进行快速记录日志。另外，该类还为warning、error、critical三个级别，又分别定义了2个扩展方法，示例如下：

public static void logwarning(this ilogger logger, string message, exception error)
public static void logwarning(this ilogger logger, int eventid, string message, exception error)

有些这些扩展方法，使用起来估计打遍天下无敌手了。

总结

通过基于接口的编程机制和di依赖注入机制，我们可以很容易实现第三方日志provider的扩展，从而将日志记录到我们想记录的任意地方，如mongodb等nosql数据库。