.Net 5 NLog组件的使用

在所有的应用程序中，日志文件是必须的，asp.net5 已经为我们提供了基本的日志记录服务，在Microsoft.Extensions.Logging这个名称空间中，但是框架提供的日志服务不能记录到文件，因此我们需要用到NLog或Log4Net等第三方日志包，记录到文件。

本篇一步一步介绍Nlog组件的使用方法，具体Nlog配置文件的参数规范随后再介绍。

详细步骤：

一、先用Nuget安装Nlog组件Nlog.Web.AspNetCore

 

 二、在项目Program类中,配置使用Nlog：

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using NLog.Web;

namespace PayAPI
{
    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                })
                .UseNLog(); //配置使用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"
      throwConfigExceptions="true"
      internalLogLevel="info"
      internalLogFile="logs\internal-nlog.txt">
	<!--autoReload：修改后自动加载，可能会有延迟-->
	<!--throwConfigExceptions：NLog日志系统抛出异常-->
	<!--internalLogLevel：内部日志的级别-->
	<!--internalLogFile：内部日志保存路径，日志的内容大概就是NLog的版本信息，配置文件的地址等等-->
	<!--输出日志的配置，用于rules读取-->
	<targets>
		<!--write logs to file-->
		<!--将日志写入文件中,fileName可以指定日志生成的路径-->
		<target xsi:type="File" name="allfile" fileName="logs\nlog-all-${shortdate}.log"
				 layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<!--同样是将文件写入日志中，写入的内容有所差别，差别在layout属性中体现。写入日志的数量有差别，差别在路由逻辑中体现-->
		<target xsi:type="File" name="ownFile-web" fileName="logs\nlog-my-${shortdate}.log"
				 layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<target xsi:type="Null" name="blackhole" />
	</targets>
	<rules>
		<!--路由顺序会对日志打印产生影响。路由匹配逻辑为顺序匹配。-->
		<!--All logs, including from Microsoft-->
		<logger name="*" minlevel="Trace" writeTo="allfile" />

		<!--Skip Microsoft logs and so log only own logs-->
		<!--以Microsoft打头的日志将进入此路由，由于此路由没有writeTo属性，所有会被忽略-->
		<!--且此路由设置了final，所以当此路由被匹配到时。不会再匹配此路由下面的路由。未匹配到此路由时才会继续匹配下一个路由-->
		<logger name="Microsoft.*" minlevel="Trace"  final="true" />
		<!--上方已经过滤了所有Microsoft.*的日志，所以此处的日志只会打印除Microsoft.*外的日志-->
		<logger name="*" minlevel="Trace" writeTo="ownFile-web" />
	</rules>
</nlog>

四、在Controller控制器中使用Nlog，引入名称控件using Microsoft.Extensions.Logging;  在控制器构造函数中注入logger对象

using Microsoft.Extensions.Logging;

namespace PayAPI.AllInPay.Controllers
{
    [Route("api/allin/[controller]")]
    [ApiController]
    public class BaseController : Controller
    {
        public readonly ILogger<BaseController> logger;
        public BaseControllerILogger<BaseController> _logger)
        {
            logger = _logger;
        }
    }
}

  五、在其他自定义函数中使用,引入名称空间NLog，可以在函数所在类中声明一个NLog实例

     using NLog;

     Logger logger = LogManager.GetCurrentClassLogger();

    也可以单独写一个NLog类供其他函数使用

using NLog;
using System;

namespace PayAPI.Common
{
    public class NLogHelper
    {
        private static Logger log = LogManager.GetCurrentClassLogger();
        
        public static void Error(object msg, Exception exp = null)
        {
            if (exp == null)
                log.Error(msg);
            else
                log.Error(msg + "\r\n " + exp.ToString());
        }
        public static void Error(string msg)
        {
            log.Error(msg);
        }
        public static void APPError(string msg)
        {
            log.Error(msg);
        }
        /// <summary>
        /// 
        /// </summary>
        /// <param name="msg">错误描述</param>
        /// <param name="msgf">错误来源</param>
        /// <param name="exp">Exception错误</param>
        public static void Error(object msg, string msgf = "", Exception exp = null)
        {
            if (!string.IsNullOrEmpty(msgf))
            {
                msg = msgf + "\r\n " + msg;
            }
            if (exp == null)
                log.Error(msg);
            else
                log.Error(msg + "\r\n " + exp.ToString());
        }
        public static void Debug(object msg, Exception exp = null)
        {
            if (exp == null)
                log.Debug(msg);
            else
                log.Debug(msg + "\r\n " + exp.ToString());
        }
        public static void Debug(string msg)
        {
                log.Debug(msg);
        }
        /// <summary>
        /// 
        /// </summary>
        /// <param name="msg">错误描述</param>
        /// <param name="msgf">错误来源</param>
        /// <param name="exp">Exception错误</param>
        public static void Debug(object msg, string msgf = "", Exception exp = null)
        {
            if (!string.IsNullOrEmpty(msgf))
            {
                msg = msgf + "\r\n " + msg;
            }
            if (exp == null)
                log.Debug(msg);
            else
                log.Debug(msg + "\r\n " + exp.ToString());
        }
        //public static void Info(string msg)
        //{
        //    if (!islog) return;
        //    log.Info(msg);
        //}
        public static void Info(string msg, Exception exp = null)
        {

            if (exp == null)
                log.Info(msg);
            else
                log.Info(msg + "\r\n " + exp.ToString());
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="msg">错误描述</param>
        /// <param name="msgf">错误来源</param>
        /// <param name="exp">Exception错误</param>
        public static void Info(object msg, string msgf = "", Exception exp = null)
        {
            if (!string.IsNullOrEmpty(msgf))
            {
                msg = msgf + "\r\n " + msg;
            }
            if (exp == null)
                log.Info(msg);
            else
                log.Info(msg + "\r\n " + exp.ToString());
        }
        public static void Warn(string msg)
        {
            log.Warn(msg);
        }
        public static void Warn(object msg, Exception exp = null)
        {
            if (exp == null)
                log.Warn(msg);
            else
                log.Warn(msg + "\r\n " + exp.ToString());
        }
        /// <summary>
        /// 
        /// </summary>
        /// <param name="msg">错误描述</param>
        /// <param name="msgf">错误来源</param>
        /// <param name="exp">Exception错误</param>
        public static void Warn(object msg, string msgf = "", Exception exp = null)
        {
            if (!string.IsNullOrEmpty(msgf))
            {
                msg = msgf + "\r\n " + msg;
            }
            if (exp == null)
                log.Warn(msg);
            else
                log.Warn(msg + "\r\n " + exp.ToString());
        }
    }
}

  以上使用Nlog组件，根据NLog配置文件中的设置信息， 会在编译生成目标文件的相对路径下生成logs文件夹来记录日志，日志按天来记录。