ASP.NET Core MVC 从入门到精通之日志管理

随着技术的发展,ASP.NET Core MVC也推出了好长时间,经过不断的版本更新迭代,已经越来越完善,本系列文章主要讲解ASP.NET Core MVC开发B/S系统过程中所涉及到的相关内容,适用于初学者,在校毕业生,或其他想从事ASP.NET Core MVC 系统开发的人员。

经过前几篇文章的讲解,初步了解ASP.NET Core MVC项目创建,启动运行,以及命名约定,创建控制器,视图,模型,接收参数,传递数据ViewData,ViewBag,路由,页面布局,wwwroot和客户端库,Razor语法,EnityFrameworkCore与数据库,HttpContext,Request,Response,Session,序列化,文件上传,自动映射,Html辅助标签,模型校验,鉴权、授权基础,Identity入门等内容,今天继续讲解ASP.NET Core MVC 中日志管理等相关内容,仅供学习分享使用。

ASP.NET Core MVC 从入门到精通之日志管理_第1张图片

在实际系统开发中,日志管理是非常重要的一个模块,完整的日志可以方便问题跟踪定位,快速的发现并解决问题。今天以一个简单的小例子,简述日志组件NLog的基础用法。

安装NLog组件库

首先通过Nuget包管理器,安装NLog对应的日志组件【NLog和NLog.Web.AspNetCore】,如下所示:

ASP.NET Core MVC 从入门到精通之日志管理_第2张图片

添加配置文件

在应用程序中添加NLog配置文件nlog.config,配置示例如下所示:




    
    
        
    

    
    
        
        

        
        

        
        
    

    
    
        
        

        
        

        
        
        

        
    

关于日志组件配置说明,可参考官方文件:https://github.com/NLog/NLog/wiki/Configuration-file

注入日志服务

在启动程序Program.cs中,添加日志组件服务,如下所示:

// NLog: Setup NLog for Dependency injection
builder.Logging.ClearProviders();
builder.Host.UseNLog();

日志过滤器

在创建项目时,默认在appsettings.json创建日志配置。如下所示:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

输出日志

在控制器中输出日志,需要用到ILogger接口,可通过注入的方式实现,如下所示:

using DemoCoreMVC.Models;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using System.Diagnostics;

namespace DemoCoreMVC.Controllers
{
    public class HomeController : Controller
    {
        private readonly ILogger _logger;

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

        public IActionResult Index()
        {
            _logger.LogInformation("Hello, 这是首页!");
            return View();
        }


    }
}

日志查看

查看日志,通过打开日志配置文件nlog.config中配置的路径,生成了两个对应的日志,如下所示:

ASP.NET Core MVC 从入门到精通之日志管理_第3张图片

nlog-AspNetCore-all-2023-06-18.log中的日志比较全,包含很多程序内部日志。

nlog-AspNetCore-own-2023-06-18.log中的日志比较简约,如下所示:

ASP.NET Core MVC 从入门到精通之日志管理_第4张图片

日志级别

在ASP.NET Core中,日志级别共几种,分别如下所示:

下表列出了 LogLevel 值、方便的 Log{LogLevel} 扩展方法以及建议的用法:

ASP.NET Core MVC 从入门到精通之日志管理_第5张图片

 在上表中,LogLevel 按严重性由低到高的顺序列出。

在实际生产程序中,一般日志并不输出Trace级别的日志,Debug也是在调试开发时才用。默认情况下,生成的nlog-AspNetCore-all-2023-06-18.log会比较大,则可以通过参数配置来修改。

设置值minlevel="Info",则不会输出Tracle和Debug级别的程序,如下所示:



    
    

    
    

    
    
    

    

通过设置后,生成的日志文件将会精简很多,如下所示:

ASP.NET Core MVC 从入门到精通之日志管理_第6张图片

日志输出目标

日志不仅可以输出到控制台,也可以输出到文件,或者其他媒介。

日志输出目标可通过targets进行配置。日志可以配置多个输出目标,通过target进行配置。

如下所示:

  • name  输出目标名称

  • type  输出目标类型,如: "File", "Database", "Mail","Console". 用 xsi:type.表示

  • layout 输出格式

如输出到控制台,如通过如下配置:

设置后,即可输出到控制台,如下所示:

ASP.NET Core MVC 从入门到精通之日志管理_第7张图片

 以上就是ASP.NET Core MVC从入门到精通之日志管理的全部内容。

你可能感兴趣的:(ASP.NET,Core,MVC从入门到精通系列文章,.Net技术,mvc,asp.net,microsoft,asp.net,core)