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

.Net项目中NLog的配置和使用实例详解

程序员文章站 2022-09-07 09:12:58
引言: 因为之前在项目开发中一直都是使用的log4net作为项目的日志记录框架,最近忽然感觉对它已经有点腻了,所以尝试着使用了nlog作为新项目的日志记录框架(当然作...

引言:

因为之前在项目开发中一直都是使用的log4net作为项目的日志记录框架,最近忽然感觉对它已经有点腻了,所以尝试着使用了nlog作为新项目的日志记录框架(当然作为一名有志向的攻城狮永远都不能只局限于眼前的技术,要不断的使用和学习新的技术)。当然serilog也是一个不错的日志记录框架哟,不过今天主要还是要讲述的是nlog在项目中的配置和使用。

nlog框架源码:https://github.com/nlog/nlog

一、导入nlog nuget package:

.Net项目中NLog的配置和使用实例详解

.Net项目中NLog的配置和使用实例详解

二、配置nlog 配置文件:

注意:在这里我是专门新建了一个nlog.config 配置文件用来进行独立配置,当然你也可以在web.config中完成相应的配置!!

nlog详细配置文件信息,请查看官网说明:

可参考晓晨大佬的nlog配置:

a、我的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">

 <targets>
 <!--此部分中的所有目标将自动异步-->
 <target name="asyncfile" xsi:type="asyncwrapper">
  <!--项目日志保存文件路径说明filename="${basedir}/保存目录,以年月日的格式创建/${shortdate}/${记录器名称}-${单级记录}-${shortdate}.txt"-->
  <target name="log_file" xsi:type="file"
    filename="${basedir}/projectlogs/${shortdate}/${logger}-${level}-${shortdate}.txt"
    layout="${longdate} | ${message} ${onexception:${exception:format=message} ${newline} ${stacktrace} ${newline}"
    archivefilename="${basedir}/archives/${logger}-${level}-${shortdate}-{#####}.txt"
    archiveabovesize="102400"
    archivenumbering="sequence"
    concurrentwrites="true"
    keepfileopen="false" />
 </target>
 <!--使用可自定义的着色将日志消息写入控制台-->
 <target name="colorconsole" xsi:type="coloredconsole" layout="[${date:format=hh\:mm\:ss}]:${message} ${exception:format=message}" />
 </targets>

 <!--规则配置,final - 最终规则匹配后不处理任何规则-->
 <rules>
 <logger name="microsoft.*" minlevel="info" writeto="" final="true" />
 <logger name="*" minlevel="info" writeto="asyncfile" />
 <logger name="*" minlevel="warn" writeto="colorconsole" />
 </rules>
</nlog>

b、nlog配置文件信息简单概述:

1、rules【规则】说明:

  规则是logger具有以下属性的元素:

name - 记录器名称过滤器 - 可能包含通配符(*和?)

minlevel - 记录的最低级别

maxlevel - 记录的*别

level - 单级记录

levels - 逗号分隔的记录级别列表

writeto - 逗号分隔的要写入的目标列表

final - 最终规则匹配后不处理任何规则

enabled- 设置为false禁用规则而不删除它

rulename- 规则标识符,允许使用configuration.findrulebyname和进行规则查找configuration.removerulebyname。

在nlog 4.6.4中引入

注意:虽然命名了规则logger,但它没有定义记录器。它引用一个或多个记录器。

通过将规则name模式与记录器名称匹配,将规则映射到记录器。规则name属性可以包括通配符(*和?),以通过通配

符匹配来匹配记录器名称。

* - 匹配0个或更多字符

? - 恰好匹配1个字符

2、targets【目标】:

  每个目标由一个target元素表示。每个目标需要两个属性:

name - 目标名称

type - 目标类型 - 例如“文件”,“数据库”,“邮件”。使用名称空间时,此属性已命名xsi:type。

除了这些属性之外,目标通常还接受其他参数,这些参数会影响诊断跟踪的写入方式。每个目标都有一组不同的参数,它们在项目主页上有详细描述,并且它们是上下文相关的。intellisense也可以在visual studio中使用。

例如,file目标接受filename定义输出文件名的参数,console目标具有error参数,该参数确定诊断跟踪是否写入标准错误(stderr)而不是进程的标准输出(stdout)。

此示例演示了一个targets定义多个目标的部分:两个文件,一个网络目标和outputdebugstring目标:

< targets >
< target name = “ f1 ” xsi :type = “ file ” filename = “ file1.txt ” />
< target name = “ f2 ” xsi :type = “ file ” filename = “ file2.txt ” /> 
< target name = “ n1 ” xsi :type = “ network ” address = “ tcp:// localhost:4001 ” />
< target name = “ ds ” xsi :type = “ outputdebugstring ” />
</ targets >

nlog提供了许多预定义的目标。实际上创建自己的目标非常容易 - 请参阅如何编写自定义目标。

三、nlog使用:

  在这里,我封装了一个nlog使用帮助类,提供给全站调用,这样就可以避免在不同的类中实例化nlog对象的步骤。

loggerhelper.cs:

/// <summary>
 /// nlog使用帮助类
 /// </summary>
 public class loggerhelper
 {
  /// <summary>
  /// 实例化nlog,即为获取配置文件相关信息
  /// </summary>
  private readonly nlog.logger _logger = logmanager.getcurrentclasslogger();

  private static loggerhelper _obj;

  public static loggerhelper _
  {
   get => _obj ?? (new loggerhelper());
   set => _obj = value;
  }

  #region debug,调试
  public void debug(string msg)
  {
   _logger.debug(msg);
  }

  public void debug(string msg, exception err)
  {
   _logger.debug(err, msg);
  }
  #endregion

  #region info,信息
  public void info(string msg)
  {
   _logger.info(msg);
  }

  public void info(string msg, exception err)
  {
   _logger.info(err, msg);
  }
  #endregion

  #region warn,警告
  public void warn(string msg)
  {
   _logger.warn(msg);
  }

  public void warn(string msg, exception err)
  {
   _logger.warn(err, msg);
  }
  #endregion

  #region trace,追踪
  public void trace(string msg)
  {
   _logger.trace(msg);
  }

  public void trace(string msg, exception err)
  {
   _logger.trace(err, msg);
  }
  #endregion

  #region error,错误
  public void error(string msg)
  {
   _logger.error(msg);
  }

  public void error(string msg, exception err)
  {
   _logger.error(err, msg);
  }
  #endregion

  #region fatal,致命错误
  public void fatal(string msg)
  {
   _logger.fatal(msg);
  }

  public void fatal(string msg, exception err)
  {
   _logger.fatal(err, msg);
  }
  #endregion
 }

四、运行记录结果:

  因为我在nlog.config配置文件中配置的日志存储路径为:projectlogs/当前时间(yyyy-mm-dd)/
如下图所示:

.Net项目中NLog的配置和使用实例详解

.Net项目中NLog的配置和使用实例详解

.Net项目中NLog的配置和使用实例详解

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对的支持。