脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → ASP.NET → 实用技巧 → 日志框架NLog

.Net使用日志框架NLog

 更新时间：2022年06月22日 15:07:40   作者：天方  
这篇文章介绍了.Net使用日志框架NLog的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

在Nuget中安装NLog

NLog可以直接使用Nuget安装：PM > Install-Package Nlog

使用NLog

NLog的使用方式基本上和其它的Log库差不多，分为Trace、Debug、Info、Error、Fatal五个等级

    private static Logger logger = LogManager.GetCurrentClassLogger();
    static void Main(string[] args)
    {
        logger.Trace("Trace Message");
        logger.Debug("Debug Message");
        logger.Info("Info Message");
        logger.Error("Error Message");
        logger.Fatal("Fatal Message");
    }

不过它提供的方法倒是蛮多的，光Trace就有42种重载形式。虽然功能强大事件好事，但某种程度上也增加了学习成本。

配置NLog

执行了上面的语句后，实际上是没有任何效果的。因为我们还没有配置日志的输出路径。这个输出路径一般是在配置文件中配置的（也支持硬编码），NLog支持两种配置文件格式

  • 配置信息嵌入在.NET应用程序标准的*.exe.config或者web.config文件里

  • 保存在独立文件里，也叫单一格式

第一张方式比较常规，但我不喜欢这种方式，因为它和其它与日志无关的配置写在一块儿了，不方便在不同的项目中共享配置。这里主要介绍下独立文件的方式。NLog支持如下三种文件名的配置文件："NLog.config"、"*.exe.nlog"和"NLog.dll.nlog"，我比较喜欢第一种。不管哪一种，其内容是一样的，一个简单的示例如下：

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <targets>
        <target name="console" xsi:type="Console" />
        <target name="debugger" xsi:type="Debugger" layout="${date:format=HH\:mm\:ss.fff}: ${message}" />
        <target name="error_file" xsi:type="File"
                        fileName="${basedir}/Logs/Error/${shortdate}/error.txt" maxArchiveFiles="30"
                        layout="${longdate} | ${level:uppercase=false} | ${message} ${onexception:${exception:format=tostring} ${newline} ${stacktrace} ${newline}" />
    </targets>
    <rules>
        <!--<logger name="*" writeTo="console" />-->
        <logger name="*" minlevel="Debug" writeTo="debugger" />
        <logger name="*" minlevel="Error" writeTo="error_file" />
    </rules>
</nlog>

它主要包括两个部分：输出目标target和路由规则rule。下面就分别介绍一下他们。

输出目标target

每个target代表一个输出目标，它主要包含两个属性：name和type。name是输出模板的名称，在后面的路由规则中使用，type则是输出类型，常见的有

  • Console        输出到控制台

  • Debugger     输出到

  • File        输出到文件

  • Mail        输出为邮件发送

  • Network        输出到网络地址

  • Database        输出到数据库

当选择某一种类型的时候，还需要配置相应的参数。如输出类型是File时，我们要配置日志路径filename，这里是可以使用一些变量的（花括号里面的部分），我这里的例子：

fileName="${basedir}/Logs/Error/${shortdate}/error.txt"

输出的日志格式为 /Log/2014-10-01/err.txt    每天生成一个文件夹，非常方便。

输出格式的控制：

有的时候，我们需要对时间、异常等这些对象的输出格式进行控制。它们可以通过修改layout参数来实现。这一部分是相对比较复杂的，不在本文讨论范围之列，有空的话我再专门介绍下。

顺便这儿也贴一个我常用的配置文档：

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <targets>
        <!--屏幕打印消息-->
        <target name="console" xsi:type="ColoredConsole"
                        layout="${date:format=HH\:mm\:ss}> ${message}"/>
        
        <!--VS输出窗口-->
        <target name="debugger" xsi:type="Debugger"
                        layout="${date:format=HH\:mm\:ss} | ${level:padding=-5} | ${message}" />

        <!--保存至文件-->
        <target name="error_file" xsi:type="File" maxArchiveFiles="30"
                        fileName="${basedir}/Logs/Error/${shortdate}/error.txt"
                        layout="${longdate} | ${level:uppercase=false:padding=-5} | ${message} ${onexception:${exception:format=tostring} ${newline} ${stacktrace} ${newline}" />
    </targets>
    <rules>
        <!--<logger name="*" writeTo="console" />-->
        <logger name="*" minlevel="Debug" writeTo="debugger" />
        <logger name="*" minlevel="Error" writeTo="error_file" />
    </rules>
</nlog>

路由规则rule

路由规则主要用于将日志和输出目标匹配起来，它一般有如下几个属性

  • name - 记录者的名字 (允许使用通配符*)

  • minlevel - 匹配日志范围的最低级别

  • maxlevel - 匹配日志范围的最高级别

  • level - 匹配的单一日志级别

  • levels - 匹配的一系列日志级别，由逗号分隔。

  • writeTo - 规则匹配时日志应该被写入的一系列目标，由逗号分隔。

看上去有好几个属性，实际上用起来还是比较简单的，例如我前面的三条规则解释如下：

    <logger name="*" writeTo="console" />    将所有的日志输出到控制台中
    <logger name="*" minlevel="Debug" writeTo="debugger" />            将Debug级别以上的日志输出到Debugger中
    <logger name="*" minlevel="Error" writeTo="error_file" />        将Error级别以上的日志输出到文件中

另外，NLOG支持配置多个路由规则，可以非常方便我们的输出。

简单的封装：

前面已经列举过NLog的使用方法，虽然其使用并不算发杂，但一个简单的Wrapper可以降低使用门槛，规范使用方式，甚至方便后期切换日志框架，很多时候还是非常有必要的。这里给一个简单的封装：

    class Logger
    {
        NLog.Logger logger;

        private Logger(NLog.Logger logger)
        {
            this.logger = logger;
        }

        public Logger(string name)
            :this(NLog.LogManager.GetLogger(name))
        {
        }

        public static Logger Default { get; private set; }
        static Logger()
        {
            Default = new Logger(NLog.LogManager.GetCurrentClassLogger());
        }

        public void Debug(string msg, params object[] args)
        {
            logger.Debug(msg, args);
        }

        public void Debug(string msg, Exception err)
        {
            logger.Debug(msg, err);
        }

        public void Info(string msg, params object[] args)
        {
            logger.Info(msg, args);
        }

        public void Info(string msg, Exception err)
        {
            logger.Info(msg, err);
        }

        public void Trace(string msg, params object[] args)
        {
            logger.Trace(msg, args);
        }

        public void Trace(string msg, Exception err)
        {
            logger.Trace(msg, err);
        }

        public void Error(string msg, params object[] args)
        {
            logger.Error(msg, args);
        }

        public void Error(string msg, Exception err)
        {
            logger.Error(msg, err);
        }

        public void Fatal(string msg, params object[] args)
        {
            logger.Fatal(msg, args);
        }

        public void Fatal(string msg, Exception err)
        {
            logger.Fatal(msg, err);
        }
    }

到此这篇关于.Net使用日志框架NLog的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • Asp.net配合easyui实现返回json数据实例

    Asp.net配合easyui实现返回json数据实例

    这篇文章主要介绍了Asp.net配合easyui实现返回json数据的方法,实例分析了Asp.net配合easyui返回json数据时出现的问题及解决方法,非常具有实用价值的技巧,需要的朋友可以参考下
    2014-12-12
  • ASP.NET MVC5验证系列之Remote Validation

    ASP.NET MVC5验证系列之Remote Validation

    这篇文章主要为大家详细介绍了ASP.NET MVC5验证系列之Remote Validation，感兴趣的小伙伴们可以参考一下
    2016-07-07
  • asp.net中CSharpThinking扩展方法分析

    asp.net中CSharpThinking扩展方法分析

    这篇文章主要介绍了asp.net中CSharpThinking扩展方法,实例讲述了扩展方法的特征及应用,具有一定的参考借鉴价值,需要的朋友可以参考下
    2014-11-11
  • asp.core 同时兼容JWT身份验证和Cookies 身份验证两种模式(示例详解)

    asp.core 同时兼容JWT身份验证和Cookies 身份验证两种模式(示例详解)

    这篇文章主要介绍了asp.core 同时兼容JWT身份验证和Cookies 身份验证两种模式,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-02-02
  • asp.net类库中添加WebService引用出现问题解决方法

    asp.net类库中添加WebService引用出现问题解决方法

    在Web项目内添加WebService的引用是件很简单的事情,不过对于一些新手朋友来说，就没有那么简单了,因为在添加的过程中总会遇到一些困难,接下来详细介绍如何解决，感兴趣的你可不要错过了啊
    2013-02-02
  • Asp.Net设计模式之单例模式详解

    Asp.Net设计模式之单例模式详解

    这篇文章主要为大家详细介绍了Asp.Net设计模式之单例模式的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-11-11
  • ASP.NET返回上一页面的实现代码

    ASP.NET返回上一页面的实现代码

    今天用ASP.NET做一个类似淘宝中的订单管理系统，遇到的问题：主界面通过一个超链接跳转到子界面后，试了好长时间还是无法从子界面返回主界面。
    2011-04-04
  • Asp.net 页面导航的几种方法与比较 分享

    Asp.net 页面导航的几种方法与比较 分享

    在ASP.NET应用中，Web表单之间的导航有多种方式：用超级链接，用Response.Redirect，用Server.Transfer，或者用Server.Execute。本文将分析这四种导航方式的异同及其优缺点，帮助你选择最佳的导航方式。
    2013-07-07
  • Winform控件SaveFileDialog用于保存文件

    Winform控件SaveFileDialog用于保存文件

    这篇文章主要为大家详细介绍了Winform SaveFileDialog保存文件对话框的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-03-03
  • VS2017调用MySQL 8.0的方法

    VS2017调用MySQL 8.0的方法

    这篇文章主要为大家详细介绍了VS2017调用MySQL 8.0的方法，附上C++程序，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2019-06-06

最新评论