NuGet安装包

安装4.9版本以上

NLog.Web.AspNetCore包安装完，你会发现，它自带了NLog.Extensions.Logging，和NLog。

NLog：核心日志框架 NLog.Extensions.Logging：就是我们要使用的Nlog的扩展，这个包主要作用是将Nlog和netcore基础日志组件结合也是netcore日志组件的实现，即Nlog日志提供程序 NLog.Web.AspNetCore：是Aspnetcore使用的Nlog扩展包，和NLog.Extensions.Logging有异曲同工之妙，原理都差不多

NLog.config简单配置

在主项目的根目录下创建一个Nlog.config配置文件。

这是我简单配置的东西，输出日志到文件txt。
复杂的配置，和配置解释，看文章后面的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="logfile" xsi:type="File" 
            fileName="./wwwroot/Log/${shortdate}.txt"
            archiveAboveSize="1024"
            maxArchiveFiles="10"
            keepFileOpen="true"
            layout="〓时间:${time} —— 等级:${level} —— 方法:${callsite} —— 信息:${message} 〓"
            />
  </targets>
  <rules>
    <logger name="*" minlevel="info" writeTo="logfile" />
    <logger name="*" minlevel="error" writeTo="logfile" />
  </rules>
</nlog>

点击一下NLog.config，属性里面设置

项目运行时，编译后项目在项目里面的bin/下面。输出日志，需要输出到编译后的目录，大概就是这样，就选择下面的这个较新则复制

修改program.cs

方法1

这是直接用NLog.Web.AspNetCore包的拓展

这是官方给的用法demo：.net core 3.x NLog文档

using NLog.Web;

    public class Program
    {
        public static void Main(string[] args)
        {
            //var logger = NLog.Web.NLogBuilder.ConfigureNLog("NLog.config").GetCurrentClassLogger();
            CreateHostBuilder(args).Build().Run();
        }
        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                })
                .UseNLog();//UseNLog()就可以使用NLog日志记录
    }

方法2

Microsoft.Extensions.Logging是netcore框架自带的日志组件扩展
NLog.Extensions.Logging 就是Nlog包的扩展包，这个帮助我们快速的将Nlog注入到netcore容器中

using Microsoft.Extensions.Logging;
using NLog.Extensions.Logging;

    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }
        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
            .ConfigureLogging(logconfig =>
            {
                logconfig.ClearProviders();//这玩意的作用就是清除微软官方的日志，明显效果就是运行项目控制台什么都没有
                logconfig.AddNLog();
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
    }

使用Nlog记录日志

方法1

这里是上面修改program.cs里面的方法1，方法2的后续使用。
通过依赖注入，在类的构造函数里面，注入ILogger，泛型就是当前的类名，（试过随便写个类，都可以没问题），这里的泛型类名，给微软原生的控制台输出显示的，其实这个泛型对NLog没用。
在需要记录日志的地方，就记录一下，当然需要在类里面注入这个日志对象。

using Microsoft.Extensions.Logging;
public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;
    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }
    public IActionResult Index()
    {
        _logger.LogInformation("Hello, this is the index!");
        return View();
    }

方法2

直接用NLog包的引用也能在.Net Core项目里面记录日志，好像还更简单

using NLog;
private Logger logger = LogManager.GetCurrentClassLogger();
public LoginResult Login_api(LoginData data)
{
    logger.Info("执行了登录操作");
    return _loginBLL.Login_bll(data);
}

多个地方需要用，干脆依赖注入一下，在Startup.cs里面的ConfigureServices方法里面

LogManager.GetCurrentClassLogger()的返回结果就是Logger，所以在构造方法注入的时候，注入Logger对象

using NLog; 
public void ConfigureServices(IServiceCollection services)
 {
     services.AddSingleton(LogManager.GetCurrentClassLogger());
 }

注入以后就可以写日志了。这种方法，不用写一个暂时不知道有什么用的泛型

using NLog;
private Logger logger;
public LoginController(Logger log)
{
    logger = log;
}
public LoginResult Login_api(LoginData data)
{
    logger.Info("执行了登录操作");
    return _loginBLL.Login_bll(data);
}

但是吧，如果多层架构，在NLog安装在顶层的，底下几层项目没有安装NLog包，就无法注入。每一层都安装一个NLog包，吃多了吧，大可不必鸭。

日志文件展示

显示的单个日志最大为1024B，最多存在10个日志归档，打印的第17个日志归档，当前日志后面没有序号，归档日志有序号。如果当前是第17个日志，前面最大的归档序号就是16。7-16号。

按照我简单配置的格式打印的样子

总结

还是用在微软的ILogger拓展的NLog日志吧，多层项目都自带了ILogger的。

NLog.config详细配置

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="E:\log\ISP\internal-nlog.txt">
  <targets>
    <target xsi:type="File" name="allfile"     fileName="E:\log\ISP\nlog-all-${shortdate}.log" layout="${longdate}|${event-properties:item=EventId_Id:whenEmpty=0}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}" />
    <target xsi:type="File" name="ownFile-web" fileName="E:\log\ISP\nlog-own-${shortdate}.log" layout="${longdate}|${event-properties:item=EventId_Id:whenEmpty=0}|${uppercase:${level}}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}|${callsite}" />
  </targets>
  <rules>
    <logger name="*" minlevel="Trace" writeTo="allfile" />
    <logger name="Microsoft.*" maxlevel="Info" final="true" />
    <logger name="*" minlevel="Trace" writeTo="ownFile-web" />
  </rules>
</nlog>

nlog

nlog根节点里面包含了最常用的子节点 targets和 rules
关于nlog节点的属性说明：

autoReload：修改配置文件后是否允许自动加载无须重启程序 throwConfigExceptions：内部日志系统抛出异常 internalLogLevel：可选Trace|Debug|Info|Warn|Error|Fatal决定内部日志的级别 Off 关闭 internalLogFile：把内部的调试和异常信息都写入指定文件里

建议throwConfigExceptions的值设为“false”，这样由于日志引发的问题不至于导致应用程序的崩溃。

targets

targets定义了日志的目标或者说输出 ，在这里可以按需设置文件名称和格式，输出方式。
可以在targets节点里面写多个target节点。每个target节点代表一种输出方式，输出到控制台，输出到文本，输出到数据库等等。
甚至同一个输出目标，都是输出到文本，输出格式也可以大不相同。

target File属性

 <target xsi:type="File"
          name="String"
          layout="Layout"
          header="Layout"
          footer="Layout"
          encoding="Encoding"
          lineEnding="Enum"
          archiveAboveSize="Long"
          maxArchiveFiles="Integer"
          maxArchiveDays="Integer"
          archiveFileName="Layout"
          archiveNumbering="Enum"
          archiveDateFormat="String"
          archiveEvery="Enum"          
          archiveOldFileOnStartup="Boolean"
          archiveOldFileOnStartupAboveSize="Long"
          replaceFileContentsOnEachWrite="Boolean"
          fileAttributes="Enum"
          fileName="Layout"
          deleteOldFileOnStartup="Boolean"
          enableFileDelete="Boolean"
          createDirs="Boolean"
          concurrentWrites="Boolean"
          openFileFlushTimeout="Integer"
          openFileCacheTimeout="Integer"
          openFileCacheSize="Integer"
          networkWrites="Boolean"
          concurrentWriteAttemptDelay="Integer"
          concurrentWriteAttempts="Integer"
          bufferSize="Integer"
          autoFlush="Boolean"
          keepFileOpen="Boolean"
          forceManaged="Boolean"
          enableArchiveFileCompression="Boolean"
          cleanupFileName="Boolean"
          writeFooterOnArchivingOnly="Boolean"
          writeBom="Boolean" />

name：输出配置名称，可以自己定义，随便写，供rules使用
layout：日志的格式模板 自定义，里面的变量可以参考官方文档，本文末尾也有参考
header：头部格式
footer：脚部格式
encoding：编码格式，可以是utf-8或者其他字符集
lineEnding：行结束模式

• CR - 在每行后插入 CR 字符 (ASCII 13)。
• CRLF - 在每行之后插入 CR LF 序列（ASCII 13、ASCII 10）
• 默认 - 在每行之后插入依赖于平台的行尾序列。
• LF - 在每行后插入 LF 字符 (ASCII 10)。
• 无 - 不插入任何行尾。

这个是官方给的解释及参考值
archiveAboveSize：以字节为单位的大小，超过该大小的日志文件将被自动存档
maxArchiveFiles：应保留的最大存档文件数。如果maxArchiveFiles小于或等于 0，则不删除旧文件
maxArchiveDays： 应保留的存档文件的最长期限。当archiveNumbering为时无效Rolling。如果maxArchiveDays小于或等于 0，则不删除旧文件
archiveFileName：要用于存档的文件的名称 可以指定日志，具体参考官方文档
archiveNumbering：对文件档案进行编号的方式
archiveDateFormat：指定用于存档编号的日期格式。此选项仅在“ArchiveNumbering”参数设置为 Date 或 DateAndSequence 时有效

• 默认： yyyyMMdd
• ArchiveEvery = 分钟时的默认值： yyyyMMddHHmm
• ArchiveEvery = 小时时的默认值： yyyyMMddHH
• ArchiveEvery = Month 时的默认值： yyyyMM
• ArchiveEvery = Year 时的默认值： yyyy

archiveEvery：指示是否在每次经过指定时间时自动归档日志文件

• 日 - 每天存档。
• 小时 - 每小时存档一次。
• 分钟 - 每分钟存档一次。
• 月 - 每月存档。
• 无 - 不要根据时间存档。
• 年 - 每年存档。
• 星期日 - 每个星期日存档。在 NLog 4.4.4 中引入。
• 星期一 - 每周一存档。在 NLog 4.4.4 中引入。
• 星期二 - 每个星期二存档。在 NLog 4.4.4 中引入。
• 星期三 - 每周三存档。在 NLog 4.4.4 中引入。
• 星期四 - 每个星期四存档。在 NLog 4.4.4 中引入。
• 星期五 - 每星期五存档。在 NLog 4.4.4 中引入。
• 星期六 - 每星期六存档。在 NLog 4.4.4 中引入。

如果当前时间段发生变化，文件将作为写入操作的一部分移动到存档中。例如，如果当前小时从 10 点更改为 11 点，则在 11:00 或之后发生的第一次写入将触发
archiveOldFileOnStartup：在启动时存档旧日志文件
archiveOldFileOnStartupAboveSize：启动时存档旧日志文件的文件大小阈值。默认值为 0，这意味着一旦启用archiveOldFileOnStartup就会归档文件。在 NLog 4.7 中引入
replaceFileContentsOnEachWrite：指示是否在每次写入时替换文件内容，而不是在末尾附加日志消息
fileAttributes：文件属性（仅限 Windows）

• 存档 - 文件应该被存档。
• 压缩的- 由于 .Net 限制，压缩将不起作用。您可以使用 enableArchiveFileCompression。
• DeleteOnClose - 关闭文件后删除文件。
• 设备 - 设备文件。
• 加密 - 加密文件。
• 隐藏 - 隐藏文件。
• NoBuffering - 系统打开一个没有系统缓存的文件。
• 普通 - 普通文件。
• NotContentIndexed - 内容索引服务不应为文件编制索引。
• PosixSemantics - 根据 POSIX 规则访问文件。
• 只读 - 只读
• ReadOnly - 只读文件。
• ReparsePoint - 重新解析点。
• SparseFile - 稀疏文件。
• 系统 - 系统文件。
• 临时 - 文件是临时的（应该保存在缓存中，如果可能的话不要写入磁盘）。
• WriteThrough - 系统通过任何中间缓存写入并直接进入磁盘。

fileName:要写入的文件的名称
deleteOldFileOnStartup: 指示是否在启动时删除旧日志文件,此选项仅在“FileName”参数表示单个文件时有效。
enableFileDelete:指示是否启用删除日志文件
createDirs:是否创建不存在的目录
keepFileOpen：指示是否在每次记录事件时保持日志文件打开，将此属性更改为 true 将大大提高性能，但也会保持文件句柄锁定。启用此选项时，请考虑设置openFileCacheTimeout = 30，因为它将允许存档操作并对被删除的日志文件做出反应。
concurrentWrites：当使用keepFileOpen = true时，支持从同一机器主机上的多个进程优化并发写入同一日志文件。通过使用一种特殊的技术，它可以让文件从多个进程中打开。如果只有单个进程（和单个 AppDomain）应用程序正在记录日志，那么设置为concurrentWrites = False会更快。
openFileCacheTimeout：文件保持打开的最大秒数。如果此数字为负数，则文件在一段时间不活动后不会自动关闭
openFileCacheSize：要保持打开的文件数。在单个 File 目标写入多个文件（例如按级别或按记录器拆分）的情况下，将此设置为更高的值可能会提高性能
openFileFlushTimeout：显式刷新文件缓冲区之间的秒数。有助于确保文件缓冲区在autoFlush = false时最终被刷新
networkWrites：指示是否由不同网络主机上的多个进程并发写入日志文件。
concurrentWriteAttemptDelay：在尝试再次写入文件之前等待的延迟（以毫秒为单位）。整数默认值：1
实际延迟是一个介于 0 和此参数中指定的值之间的随机值。在每次失败的尝试中，延迟基数加倍为 ConcurrentWriteAttempts 次。
concurrentWriteAttempts：在 NLog 丢弃日志消息之前尝试写入文件的次数
bufferSize：以字节为单位的日志文件缓冲区大小。整数默认值：32768
autoFlush： 指示是否在每条日志消息后自动刷新文件缓冲区，禁用它会提高性能
forceManaged：指示文件目标应仅使用托管方法。这会禁用某些选项
enableArchiveFileCompression：指示是否将存档文件压缩为 zip 文件
cleanupFileName：在写入文件之前，检查文件名是否包含非法字符（取决于操作系统）。如果写入大量消息，这可能代价高昂。清理缓存为固定名称（无布局渲染器）。将此设置false为最佳性能（但要注意文件名，如果错误，则不会写入任何内容）
writeFooterOnArchivingOnly：指示是否应仅在归档文件时写入页脚
writeBom：指示是否在创建的文件中写入 BOM（字节顺序标记）

JSON/xml Log-file

Nlog不光能记录普通的log文件，还可以记录json格式的问题

<?xml version="1.0" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <targets>
        <target name="jsonfile" xsi:type="File" fileName="${basedir}/file.json">
            <layout xsi:type="JsonLayout">
                <attribute name="time" layout="${date:format=O}" />
                <attribute name="message" layout="${message}" />
                <attribute name="logger" layout="${logger}"/>
                <attribute name="level" layout="${level}"/>
            </layout>
        </target>
    </targets>
    <rules>
        <logger name="*" minlevel="Debug" writeTo="jsonfile" />
    </rules>
</nlog>

可以记录xml格式的文件呢

<?xml version="1.0" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <targets>
        <target name="csvfile" xsi:type="File" fileName="${basedir}/file.csv">
            <layout xsi:type="CSVLayout">
                <column name="time" layout="${longdate}" />
                <column name="message" layout="${message}" />
                <column name="logger" layout="${logger}"/>
                <column name="level" layout="${level}"/>
            </layout>
        </target>
    </targets>
    <rules>
        <logger name="*" minlevel="Debug" writeTo="csvfile" />
    </rules>
</nlog>

rules

rules里面的的子节点logger

name：记录者的名字，*全局匹配，就是都可以，都记录 writeTo：规则匹配时日志应该被写入的一系列target，和target节点的name对应，由逗号分隔。 minlevel：最低级别 maxlevel：最高级别 level：单一日志级别 levels：一系列日志级别，由逗号分隔。

<logger name="*" minlevel="Trace" writeTo="allfile" />

layout属性表附录