解读ASP.NET5&MVC6系列教程9:日志框架

网络编程 ASP.NET 自学过程 分类:[default] 更新日期: 2015-10-31
这篇文章主要介绍了ASP.NET 5 日志框架,通过基于接口的编程机制和DI依赖注入机制,我们可以很容易实现第三方日志provider的扩展,从而将日志记录到我们想记录的任意地方,需要的朋友可以参考下

框架介绍

在之前的.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);
}

实现了上述两个接口,即可通过factoryAddProvider方法,将该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数据库。


> 本站内容系网友提交或本网编辑转载,其目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责。如涉及作品内容、版权和其它问题,请及时与本网联系,我们将在第一时间删除内容!

相关文章
  • 解读ASP.NET5&MVC6系列教程1:ASP.NET5简介
    这篇文章主要介绍ASP.NET 5简介以及对各个版本号进行解释,ASP.NET 5中新的变化,需要的朋友可以参考下.ASP.NET 5简介 ASP.NET 5是一个跨时代的改写,所有的功能和模块都进行了独立拆分,做到了彻底解耦.为了这些改写,微软也是蛮 拼的,几乎把.NET Framwrok全部改写了一遍,形成了一个.NET Core的东西. 在.NET C ...
  • 利用ASP.NETMVC和Bootstrap快速搭建响应式个人博客站(一)
    利用ASP.NETMVC和Bootstrap快速搭建响应式个人博客站(一)
    这篇文章主要介绍了利用ASP.NET MVC和Bootstrap快速搭建响应式个人博客站一的相关资料,需要的朋友可以参考下1.0 为什么要做这个博客站? 在工作学习中,经常要搜索查找各种各样的资料,每次找到相关资料后都会顺手添加到浏览器书签中,时间一长,书签也就满了.而且下次再点击这个书签时,可能就会忘记当时为什么要添加这个书签了,更有可能书签连接已经无效. ...
  • ASP.NETWebApi2实现多文件打包并下载文件的实例
    ASP.NETWebApi2实现多文件打包并下载文件的实例
    这篇文章主要介绍了ASP.NET Web Api 2利用ByteArrayContent和StreamContent实现多文件打包并下载的方法,提供源码下载,需要的朋友可以参考下.最近由于工作和个人事务,站点也好久没更新了,但这并不影响我对.NET的热情.站点的更新工作还是得想办法抽时间来完成的. 今天利用中午的时间来写一篇关于Asp.Net Web Api ...
  • ASP.NET(C#)WebApi通过文件流下载文件的实例
    这篇文章主要介绍了ASP.NETC# Web Api通过文件流下载文件的方法,提供源码下载,需要的朋友可以参考下.下载文件到本地是很多项目开发中需要实现的一个很简单的功能.说简单,是从具体的代码实现上来说的,.NET的文件下载方式有很多种,本示例给大家介绍的是ASP.NET Web Api方式返回HttpResponseMessage下载文件到本地.实现的方 ...
  • asp.netcore实现文件上传功能
    asp.netcore实现文件上传功能
    这篇文章主要为大家详细介绍了asp.net core实现文件上传功能,怎么做单文件和多文件上传,感兴趣的小伙伴们可以参考一下本文实例为大家分享了单文件上传.多文件上传的功能,供大家参考,具体内容如下 单文件上传 上传文件在Web应用程序中是一个常见的功能.在asp.net core中上传文件并保存在服务器上,是很容易的.下面就来演示一下怎么样在 ASP.NE ...
  • Yii2rbac权限控制之rule教程详解
    Yii2rbac权限控制之rule教程详解
    这篇文章主要介绍了Yii2 rbac权限控制之rule教程详解的相关资料,非常不错具有参考借鉴价值,需要的朋友可以参考下在我们之前Yii2搭建后台并实现rbac权限控制完整实例教程中,不知道你曾经疑惑过没有一个问题,rule表是做什么的,为什么在整个过程中我们都没有涉及到这张表? 相信我不说,部分人也都会去尝试,或百度或google,到头来也会竹篮打水,这部 ...
猜你喜欢