ASP.NET Core 日志 API

ASP.NET Core 使用与 .NET Core 日志记录相同的日志记录机制。因此，强烈建议在阅读本文之前，先阅读 .NET Core 教程中的日志 API 章节。

在这里，我们将使用 ASP.NET Core 2.x MVC 应用程序。

如前一章所述，Microsoft.Extension.Logging 命名空间中的日志 API 与一个或多个内置或第三方日志提供程序一起工作。因此，在 ASP.NET Core MVC 应用程序，我们还必须安装 NuGet 软件包 Microsoft.Extension.Logging 和我们选择的一个或多个日志记录提供程序。

创建 ASP.NET Core MVC 应用程序。创建 ASP.NET Core MVC web 应用程序，它自动包含 Microsoft.Extension.Logging 的 NuGet 包和 Microsoft.AspNetCore.App NuGet 包下的以下日志提供程序。因此，我们不必手动安装它。

Microsoft.Extensions.Logging.Console
Microsoft.Extensions.Logging.Debug
Microsoft.Extensions.Logging.EventSource
Microsoft.Extensions.Logging.TraceSource

添加日志记录提供程序

我们需要在 LoggerFactory 中添加提供程序。在 ASP.NET Core MVC 应用程序中，对 Program.cs 中 WebHost.CreateDefaultBuilder(args) 方法的调用在内部添加了 Console、Debug 和 EventSource 日志记录提供程序。

public class Program
{
    public static void Main(string[] args)
    {
        CreateWebHostBuilder(args).Build().Run();
    }
    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
               .UseStartup<Startup>();
}

查看 GitHub 上 WebHost.CreateDefaultBuilder() 方法的源代码，您会发现以下代码：

.ConfigureLogging((hostingContext, logging) =>
    {
        logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
        logging.AddConsole();
        logging.AddDebug();
        logging.AddEventSourceLogger();
    }).

因此，如果您想使用这些提供程序，则无需手动添加它们。如果要使用其他提供程序或任何默认提供程序，则需要删除所有现有提供程序并添加您选择的提供程序。要配置日志记录提供程序，请调用 IWebHostBuilder 的 ConfigureLogging() 扩展方法，如下所示。

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
    .ConfigureLogging(logBuilder =>
    {
        logBuilder.ClearProviders();
        logBuilder.AddConsole();
        logBuilder.AddTraceSource("Information, ActivityTracing");
    })
    .UseStartup<Startup>();

在上面的实例中，ConfigureLogging() 方法执行操作以委托 action<ILogBuilder> 来配置日志记录提供程序。要添加您选择的日志记录提供程序，请使用 ClearProvider() 删除所有默认提供程序，然后调用提供程序的扩展方法来添加它，例如 AddTraceSource() 将添加跟踪侦听器提供程序，AddConsole() 方法将添加 Console 日志记录提供。

您还可以在 Startup 类的 configure() 方法中使用 ILoggerFactory 配置日志记录提供程序。让我们看一个如何在文本文件中存储日志的实例。

将日志存储在文本文件中

要将日志存储在文件中，请安装 NuGet 包 Serilog.Extensions.Logging.file。Serillog 包含 ILoggerFactory 的扩展方法，但不包含 ILogBuilder（在 1.1.0 版中）。因此，转到 Startup.cs 文件并在 Configure() 方法中添加 ILoggerFactory 参数。然后，调用 AddFile() 扩展方法添加 Serillog 文件提供程序，如下所示。ASP.NET Core 依赖注入将自动传递此参数的 LoggerFactory 实例。

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory) 
{
    loggerFactory.AddFile("Logs/mylog-{Date}.txt");
}

这会将所有日志存储在 mylog-<date>.txt 文件中，位于应用程序的 logs 文件夹下。

在控制器中创建日志

我们可以使用 ASP.NET Core DI（依赖注入）在应用程序中的任何位置使用 ILogger 或 ILoggerFactory。参考以下 HomeController 实例：

namespace AspDotNetCoreMvcApp.Controllers
{
    public class HomeController : Controller
    {
        private readonly ILogger _logger;
        public HomeController(ILogger<HomeController> logger){
            _logger = logger;
        }
        public IActionResult Index()
        {
            _logger.LogInformation("Log message in the Index() method");
            return View();
        }
        public IActionResult About()
        {
            _logger.LogInformation("Log message in the About() method");
            return View();
        }
    }
}

在上面的实例中，ILogger<HomeController> 参数包含在构造函数中。ASP.NET Core DI 将传递 ILogger 实例，该实例可用于登录 Index() 和 About() 操作方法。

将 HomeController 作为 ILogger<HomeController> 的泛型类型传递，将用作类别。例如，指定 ILogger<HomeController> 将在日志中显示完全限定的名称 AspDotNetCoreMvcApp.Controllers.HomeController，如下所示。

info: AspDoteNetCoreMvcApp.Controllers.HomeController[0]
       Log message in the Index() method

让我们了解上面的日志消息。在这里，我们使用 LogInformation() 方法记录信息，因此它以 "info:" 开头，后跟创建日志的类的完全限定名称：AspDoteNetCoreMvcApp.Controllers.HomeControllers[0]。[0]是事件 id。您可以指定此事件 id 来标识记录，例如id、页码或唯一标识日志的其他重要信息。我们没有指定任何事件 id，因此它将为 0。下一行是实际的日志消息："log message in The Index() method"。

这可以通过在构造函数中传递 ILoggerFactory 来实现。

public class HomeController : Controller
{
    private readonly ILogger _logger;
    public HomeController(ILoggerFactory logFactory)
    {
        _logger = logFactory.CreateLogger<HomeController>();
    }
    public IActionResult Index()
    {
        _logger.LogInformation("Log message in the Index() method");
        return View();
    }
    public IActionResult About()
    {
        _logger.LogInformation("Log message in the About() method");
        return View();
    }
}

现在，通过导航到 /<approot文件夹>/bin/debug/netcoreapp2.1/，从命令提示符运行上述应用程序，运行 dotnet<app-name>.dll 命令，然后打开 http://localhost:5000 在浏览器中。它将在控制台上显示与上述相同的日志。

info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/
info: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[1]
      Route matched with {action = "Index", controller = "Home"}. Executing acti
on AspDoteNetCoreMvcApp.Controllers.HomeController.Index (AspDotNetCoreMvcApp)
info: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[1]
      Executing action method AspDoteNetCoreMvcApp.Controllers.HomeController.In
dex (AspDotNetCoreMvcApp) - Validation state: Valid
info: AspDoteNetCoreMvcApp.Controllers.HomeController[0]
      Log message in the Index() method
info: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[2]
      Executed action method AspDoteNetCoreMvcApp.Controllers.HomeController.Ind
ex (AspDotNetCoreMvcApp), returned result Microsoft.AspNetCore.Mvc.ViewResult in
 0.8505ms.
info: Microsoft.AspNetCore.Mvc.ViewFeatures.ViewResultExecutor[1]
      Executing ViewResult, running view Index.
info: Microsoft.AspNetCore.Mvc.ViewFeatures.ViewResultExecutor[4]
      Executed ViewResult - view Index executed in 231.2839ms.
info: Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker[2]
      Executed action AspDoteNetCoreMvcApp.Controllers.HomeController.Index (Asp
DotNetCoreMvcApp) in 288.6931ms
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 946.274ms 200 text/html; charset=utf-8
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/images/banner1.svg
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/images/banner2.svg
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 5.6471ms 404
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 6.5811ms 404
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/css/site.min.css
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 0.2811ms 404
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/js/site.min.js
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/images/banner3.svg
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 0.178ms 404
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 0.2342ms 404
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/css/site.min.css
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 0.1173ms 404
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/js/site.min.js
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 0.2539ms 404
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[1]
      Request starting HTTP/1.1 GET http://localhost:5000/favicon.ico
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 0.3253ms 404

至此，我们可以在 ASP.NET Core MVC 应用程序中使用日志。

ASP.NET Core 日志 API

添加日志记录提供程序

将日志存储在文本文件中

在控制器中创建日志

分类导航