ASP.NET Core开发教程之Logging利用NLog写日志文件

下面是关于“ASP.NET Core开发教程之Logging利用NLog写日志文件”的完整攻略，包含两个示例说明。

简介

在ASP.NET Core应用程序中，我们可以使用Logging来记录应用程序的日志。NLog是一个流行的日志记录库，可以帮助我们将日志记录到文件、数据库等不同的目标中。在本攻略中，我们将介绍如何使用NLog来记录日志文件。

步骤

在ASP.NET Core应用程序中使用NLog记录日志文件时，我们可以通过以下步骤来实现：

安装NLog和NLog.Web.AspNetCore包。
在appsettings.json文件中配置NLog。
在Startup.cs文件中添加NLog。
在代码中使用ILogger接口记录日志。

示例

示例1：记录日志到文件

在本示例中，我们将使用NLog将日志记录到文件中。我们可以通过以下步骤来实现：

安装NLog和NLog.Web.AspNetCore包：

dotnet add package NLog
dotnet add package NLog.Web.AspNetCore

在上面的命令中，我们使用dotnet命令来安装NLog和NLog.Web.AspNetCore包。

在appsettings.json文件中配置NLog：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    },
    "NLog": {
      "targets": {
        "file": {
          "type": "File",
          "fileName": "${basedir}/logs/${shortdate}.log",
          "layout": "${longdate} ${level} ${message} ${exception}"
        }
      },
      "rules": [
        {
          "logger": "*",
          "minLevel": "Trace",
          "writeTo": "file"
        }
      ]
    }
  }
}

在上面的代码中，我们在Logging节点下添加了一个NLog节点，并定义了一个名为“file”的目标，将日志记录到“logs”目录下的以日期命名的文件中。

在Startup.cs文件中添加NLog：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory loggerFactory)
{
    // 添加NLog
    loggerFactory.AddNLog();

    // ...
}

在上面的代码中，我们在Configure方法中添加了NLog。

在代码中使用ILogger接口记录日志：

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public IActionResult Index()
    {
        _logger.LogInformation("Hello, world!");
        return View();
    }
}

在上面的代码中，我们在HomeController中注入了ILogger接口，并在Index方法中使用ILogger接口记录了一条日志。

运行应用程序，查看效果。

示例2：记录日志到数据库

在本示例中，我们将使用NLog将日志记录到数据库中。我们可以通过以下步骤来实现：

安装NLog和NLog.Web.AspNetCore包：

dotnet add package NLog
dotnet add package NLog.Web.AspNetCore
dotnet add package NLog.Targets.Database

在上面的命令中，我们使用dotnet命令来安装NLog、NLog.Web.AspNetCore和NLog.Targets.Database包。

在appsettings.json文件中配置NLog：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    },
    "NLog": {
      "targets": {
        "database": {
          "type": "Database",
          "dbProvider": "System.Data.SqlClient",
          "connectionString": "Data Source=(localdb)\\MSSQLLocalDB;Initial Catalog=MyDatabase;Integrated Security=True",
          "commandText": "INSERT INTO Logs (Date, Level, Message, Exception) VALUES (@Date, @Level, @Message, @Exception);",
          "parameters": [
            {
              "name": "@Date",
              "layout": "${date}"
            },
            {
              "name": "@Level",
              "layout": "${level}"
            },
            {
              "name": "@Message",
              "layout": "${message}"
            },
            {
              "name": "@Exception",
              "layout": "${exception}"
            }
          ]
        }
      },
      "rules": [
        {
          "logger": "*",
          "minLevel": "Trace",
          "writeTo": "database"
        }
      ]
    }
  }
}

在上面的代码中，我们在Logging节点下添加了一个NLog节点，并定义了一个名为“database”的目标，将日志记录到数据库中。

在Startup.cs文件中添加NLog：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory loggerFactory)
{
    // 添加NLog
    loggerFactory.AddNLog();

    // ...
}

在上面的代码中，我们在Configure方法中添加了NLog。

在代码中使用ILogger接口记录日志：

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public IActionResult Index()
    {
        _logger.LogInformation("Hello, world!");
        return View();
    }
}

在上面的代码中，我们在HomeController中注入了ILogger接口，并在Index方法中使用ILogger接口记录了一条日志。