.Net Core学习教程之在Mvc中简单的使用日志组件

前言

本文是基于 .net core 2.0，只是蜻蜓点水，并非深入浅出。给大家介绍了关于.net core在mvc中使用日志组件的相关内容，分享出供大家参考学习，下面话不多说了，来一起看看详细的介绍吧

目录

使用内置的日志组件

简单过渡到第三方组件 - nlog 

使用内置的日志

下面使用控制器 homecontroller.cs 进行演示。

需要 using microsoft.extensions.logging;

方案一：

public class homecontroller : controller
 {
  private readonly ilogger _logger ;

  public homecontroller(iloggerfactory loggerfactory)
  {
   _logger = loggerfactory.createlogger(typeof(homecontroller));
  }
 }

方案二：

public class homecontroller : controller
 {
  private readonly ilogger _logger ;

  public homecontroller(ilogger<homecontroller> logger)
  {
   _logger = logger;
  }
 }

方案三：

public class homecontroller : controller
 {
  private readonly ilogger _logger ;

  public homecontroller(ilogger logger)
  {
   _logger = logger;
  }
 }

三种都是通过注入的方式获取日志记录器对象，在过去，我们会自己独立封装类似这些 debug、info 和 error 等不同日志等级的方法，现在我们看看内置的方法是如何使用的？ 

在 homecontroller 内添加 index() 方法进行测试。

public iactionresult index()
  {
   _logger.logdebug($"测试：{datetime.now.tostring(cultureinfo.invariantculture)}");
   _logger.logerror($"测试：{datetime.now.tostring(cultureinfo.invariantculture)}");
   _logger.loginformation($"测试：{datetime.now.tostring(cultureinfo.invariantculture)}");

   return json(guid.newguid());
  }

在输出结果中我们可以看到，不同日志的等级在控制台中会以不同的颜色进行标注。

 

每种级别的 log 都有多个方法重载，如 loginformation() ，示例演示的代码中使用的是比较简单一种，也就是最后一种。

//
    // 摘要:
    //   formats and writes an informational log message.
    //
    // 参数:
    //  logger:
    //   the microsoft.extensions.logging.ilogger to write to.
    //
    //  eventid:
    //   the event id associated with the log.
    //
    //  message:
    //   format string of the log message.
    //
    //  args:
    //   an object array that contains zero or more objects to format.
    public static void loginformation(this ilogger logger, eventid eventid, string message, params object[] args);
    //
    // 摘要:
    //   formats and writes an informational log message.
    //
    // 参数:
    //  logger:
    //   the microsoft.extensions.logging.ilogger to write to.
    //
    //  exception:
    //   the exception to log.
    //
    //  message:
    //   format string of the log message.
    //
    //  args:
    //   an object array that contains zero or more objects to format.
    public static void loginformation(this ilogger logger, exception exception, string message, params object[] args);
    //
    // 摘要:
    //   formats and writes an informational log message.
    //
    // 参数:
    //  logger:
    //   the microsoft.extensions.logging.ilogger to write to.
    //
    //  message:
    //   format string of the log message.
    //
    //  args:
    //   an object array that contains zero or more objects to format.
    public static void loginformation(this ilogger logger, string message, params object[] args);

其它细节以及详情，或者希望使用其它日志组件可参考官方文档：

简单过渡到第三方组件 - nlog

nuget 安装 nlog.web.aspnetcore（目前 nuget 最新为 4.4.1，但是官方的教程却是 4.5 的，小编使用 4.4.1 进行演示）。如需 4.5+ 可参考官方：https://github.com/nlog/nlog.web/wiki/getting-started-with-asp.net-core-2

下面演示如何将内置的组件简单的移植到 nlog 中。

先在根目录创建配置文件 nlog.config，记得将属性修改成始终复制到目录：

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/nlog.xsd"
   xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"
   autoreload="true"
   internalloglevel="info"
   internallogfile="c:\temp\internal-nlog.txt">


 <!-- the targets to write to -->
 <targets>
  <!-- write logs to file -->
  <target xsi:type="file" name="allfile" filename="c:\temp\nlog-all-${shortdate}.log"
      layout="${longdate}|${event-properties:item=eventid_id}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}" />

  <!-- another file log, only own logs. uses some asp.net core renderers -->
  <target xsi:type="file" name="ownfile-web" filename="c:\temp\nlog-own-${shortdate}.log"
      layout="${longdate}|${event-properties:item=eventid_id}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}" />
 </targets>

 <!-- rules to map from logger name to target -->
 <rules>
  <!--all logs, including from microsoft-->
  <logger name="*" minlevel="trace" writeto="allfile" />

  <!--skip non-critical microsoft logs and so log only own logs-->
  <logger name="microsoft.*" maxlevel="info" final="true" /> <!-- blackhole without writeto -->
  <logger name="*" minlevel="trace" writeto="ownfile-web" />
 </rules>
</nlog>

修改 startup.cs 类中的 configure() 方法，其它地方都不需要做出任何修改。

public void configure(iapplicationbuilder app, ihostingenvironment env, iloggerfactory loggerfactory)
    {
      loggerfactory.addnlog();  //添加nlog 
      env.configurenlog("nlog.config");  //读取nlog配置文件 

      //...    
    }

启动程序，你会发现：

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对的支持。