第二章 基础知识（4） - 日志记录

已于 2024-07-10 00:10:20 修改
阅读量775 收藏 24
点赞数 16
分类专栏： Blazor 文章标签： Blazor c# 开发语言 组件 WebUI
于 2024-07-09 22:08:47 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jjailsa/article/details/140281576
版权

在默认日志级别，Blazor项目中默认提供如下日志记录提供程序：

在服务器上（Blazor Server），日志记录仅发生在 LogLevel.Information 或更高级别的 Development 环境中的服务器端 .NET 控制台。
在客户端上（Blazor WebAssembly），日志记录仅发生在 LogLevel.Information 或更高级别的客户端浏览器开发人员工具控制台。

Razor组件日志记录

要在组件中使用日志记录，可以通过注入ILogger<T>或者ILoggerFactory来实现。

ILogger<T>示例

@page "/"
@inject ILogger<Home> Logger

<PageTitle>Home</PageTitle>
<h1>Hello, world!</h1>

Welcome to your new app.
@code{
    protected override void  OnInitialized(){
        //这是服务端的组件
        Logger.LogWarning("OKK");
    }
}

ILoggerFactory示例

@page "/counter"
@rendermode InteractiveAuto
@inject ILoggerFactory LoggerFactory

<PageTitle>Counter</PageTitle>
<h1>Counter</h1>
<p role="status">Current count: @currentCount</p>
<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount = 0;

    private void IncrementCount()
    {
        currentCount++;
        //这里用的客户端的组件
        LoggerFactory.CreateLogger<Counter>().LogWarning("OKK");
    }
}

在这里插入图片描述

客户端日志

对于客户端，并非支持所有ASP.NET Core的日志记录功能。例如，客户端组件无法访问客户端的文件系统或网络，因此无法将日志写入客户端的物理或网络存储。

一、设置日志等级

对于服务端项目的日志配置，默认情况下，可以在项目的appsettings.json和appsettings.Development.json文件中进行配置。
在这里插入图片描述而在客户端项目中，要进行日志最低等级的配置，需要在Program.cs中，使用WebAssemblyHostBuilder.Logging属性进行日志的设置。

日志级别

  • Trace：0，包含最详细消息的日志，不建议在生产环境下使用此等级。
  • Debug：1，在开发期间用于交互式调查的日志。这些日志应该主要包含对调试有用的信息，没有长期价值。
  • Information：2，跟踪应用的常规流，可能具有长期值。
  • Warning：3，突出显示应用程序流中异常或意外事件，但不会导致应用程序执行停止的日志。
  • Error：4，突出显示由于故障而停止当前执行流的日志。这些应该表明当前活动中的故障，而不是应用程序范围的故障。
  • Critical：5，描述不可恢复的应用程序或系统崩溃，或需要立即注意的灾难性故障的日志。
  • None：6，不进行任何日志记录。

示例-将日志最低等级设置为Warning-Program.cs

......
//设置日志级别
builder.Logging.SetMinimumLevel(LogLevel.Warning);
......

二、客户端Program.cs中输出日志

要在客户端的Program.cs中输出日志，可以使用WebAssemblyHost的服务容器中获取日志工厂ILoggerFactory从而生成日志对象。

  • 需要注意的是，只有在加载首次加载客户端组件时，才会运行Program中的代码。

Program.cs

var builder = WebAssemblyHostBuilder.CreateDefault(args);

var host = builder.Build();
var logger = host.Services.GetRequiredService<ILoggerFactory>()
    .CreateLogger<Program>();
logger.LogInformation("Logged after the app is built in the Program file.");

await builder.Build().RunAsync();

在这里插入图片描述

三、日志类别

客户端同样支持日志类别，在创建 ILogger 对象时，需要指定日志类别，可以以下几种类别指定方式：

  • ILogger<T>：在注入ILogger接口时，通过泛型T来指定，这种方式需要使用已存在的类型，然后会自动使用T类型的完整空间命名来作为日志类别。
  • CreateLogger<T>()：ILoggerFactory的方法，创建ILogger<T>日志对象。
  • CreateLogger(className)：ILoggerFactory的方法，创建ILogger日志对象，这里的className可以随便指定，不需要使用存在的类型名称。

示例

@page "/counter"
@rendermode InteractiveAuto
@inject ILogger<Counter> Logger
@inject ILoggerFactory LoggerFactory

<PageTitle>Counter</PageTitle>

<h1>Counter</h1>

<p role="status">Current count: @currentCount</p>

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount = 0;

    private void IncrementCount()
    {
        currentCount++;
        LoggerFactory.CreateLogger("MyLogger").LogWarning("OKK");
        Logger.LogWarning("OKK");
    }
}

在这里插入图片描述

四、日志事件ID

Blazor客户端侧同样支持日志事件ID，每个日志都可以指定一个事件ID，一般会将所有日志事件ID作为常量封装到一个类中来使用。

LogEvent.cs

public class LogEvent
{
    public const int Event1 = 1000;
    public const int Event2 = 1001;
}

Counter.razor

@page "/counter"
@rendermode InteractiveAuto
@inject ILogger<Counter> Logger

......

@code {
    private int currentCount = 0;

    private void IncrementCount()
    {
        currentCount++;
        Logger.LogInformation(LogEvent.Event1, "Someone has clicked me!");
        Logger.LogWarning(LogEvent.Event2, "Someone has clicked me!");
    }
}

在这里插入图片描述

五、日志异常参数

Blazor客户端侧支持日志异常参数的使用。

Counter.razor

@page "/counter"
@rendermode InteractiveAuto
@inject ILogger<Counter> Logger

......

@code {
    private int currentCount = 0;

    private void IncrementCount()
    {
        try
        {
            currentCount++;
            throw new OperationCanceledException("Skip 3");
        }
        catch (Exception ex)
        {
            Logger.LogInformation(ex, "Exception (currentCount: {Count})!", currentCount);
        }
    }
}

在这里插入图片描述

六、日志筛选函数

指定日志类别与日志级别
在客户端如果希望只输出指定的日志类别和日志级别，可以通过在Program.cs中使用builder.Logging.AddFilter方法来添加过滤器。

Program.cs

......

//表示只记录日志类别为MyLoggerClass且日志级别为LogLevel.Information的日志
builder.Logging.AddFilter((provider, category, logLevel)=> category!.Equals("MyLoggerClass") && logLevel == LogLevel.Information);

......

Counter.razor

@page "/counter"
@rendermode InteractiveAuto
@inject ILoggerFactory LoggerFactory

......

@code {
    private int currentCount = 0;

    private void IncrementCount()
    {
        currentCount++;
        ILogger _logger = LoggerFactory.CreateLogger("MyLoggerClass");
        _logger.LogInformation("Information");
        _logger.LogWarning("Warning");
    }
}

在这里插入图片描述

七、身份验证日志记录

要开启身份验证的日志记录，可以有如下两种方法：

通过配置文件设置

"Logging": {
  "LogLevel": {
    "Microsoft.AspNetCore.Components.WebAssembly.Authentication": "Debug"
  }
}

通过在Program.cs中添加过滤器

builder.Logging.AddFilter("Microsoft.AspNetCore.Components.WebAssembly.Authentication", LogLevel.Debug);

八、自定义记录器提供程序

有时可能会遇到需要自己定义日志提供程序的需求，要实现自定义的日志提供程序，具体需要进行如下步骤：

创建日志级别字典

using Microsoft.Extensions.Logging;

public class CustomLoggerConfiguration
{
    public int EventId { get; set; }

    public Dictionary<LogLevel, LogFormat> LogLevels { get; set; } = 
        new()
        {
            [LogLevel.Information] = LogFormat.Short,
            [LogLevel.Warning] = LogFormat.Short,
            [LogLevel.Error] = LogFormat.Long
        };

    public enum LogFormat
    {
        Short,
        Long
    }
}

实现ILogger接口，自定义日志提供程序

public sealed class CustomLogger : ILogger
{
    private readonly string name;
    private readonly Func<CustomLoggerConfiguration> getCurrentConfig;

    public CustomLogger(
        string name,
        Func<CustomLoggerConfiguration> getCurrentConfig) =>
        (this.name, this.getCurrentConfig) = (name, getCurrentConfig);

    public IDisposable BeginScope<TState>(TState state) => default!;

    public bool IsEnabled(LogLevel logLevel) =>
        getCurrentConfig().LogLevels.ContainsKey(logLevel);

    public void Log<TState>(
        LogLevel logLevel,
        EventId eventId,
        TState state,
        Exception? exception,
        Func<TState, Exception?, string> formatter)
    {
        if (!IsEnabled(logLevel))
        {
            return;
        }

        CustomLoggerConfiguration config = getCurrentConfig();

        if (config.EventId == 0 || config.EventId == eventId.Id)
        {
            switch (config.LogLevels[logLevel])
            {
                case LogFormat.Short:
                    Console.WriteLine($"{name}: {formatter(state, exception)}");
                    break;
                case LogFormat.Long:
                    Console.WriteLine($"[{eventId.Id, 2}: {logLevel, -12}] {name} - {formatter(state, exception)}");
                    break;
                default:
                    // No-op
                    break;
            }
        }
    }
}

实现自定义日志提供程序的配置类

using System.Collections.Concurrent;
using Microsoft.Extensions.Options;

[ProviderAlias("CustomLog")]
public sealed class CustomLoggerProvider : ILoggerProvider
{
    private readonly IDisposable onChangeToken;
    private CustomLoggerConfiguration config;
    private readonly ConcurrentDictionary<string, CustomLogger> loggers =
        new(StringComparer.OrdinalIgnoreCase);

    public CustomLoggerProvider(
        IOptionsMonitor<CustomLoggerConfiguration> config)
    {
        this.config = config.CurrentValue;
        onChangeToken = config.OnChange(updatedConfig => this.config = updatedConfig);
    }

    public ILogger CreateLogger(string categoryName) =>
        loggers.GetOrAdd(categoryName, name => new CustomLogger(name, GetCurrentConfig));

    private CustomLoggerConfiguration GetCurrentConfig() => config;

    public void Dispose()
    {
        loggers.Clear();
        onChangeToken.Dispose();
    }
}

给ILoggingBuilder添加扩展方法

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Configuration;

public static class CustomLoggerExtensions
{
    public static ILoggingBuilder AddCustomLogger(
        this ILoggingBuilder builder)
    {
        builder.AddConfiguration();

        builder.Services.TryAddEnumerable(
            ServiceDescriptor.Singleton<ILoggerProvider, CustomLoggerProvider>());

        LoggerProviderOptions.RegisterProviderOptions
            <CustomLoggerConfiguration, CustomLoggerProvider>(builder.Services);

        return builder;
    }
}

在Program.cs中，添加日志提供程序。

builder.Logging.ClearProviders().AddCustomLogger();

使用第三方日志提供程序

这里以NLog的使用为例，由于浏览器存在访问权限等原因，这里只在服务端（Blazor Server）上使用。

一、安装NLog包

要在 ASP.NET Core 6 中使用 NLog，首先要安装 NLog 的扩展包，然后再进行一些基本的配置，就可以实现 NLog 与.NET Core 6 的集成了。
首先到Nuget中，下载对应的依赖库：

  • 选择NLog.Extensions.Logging程序包，这个是微软参与开发的插件，也是微软官方网站上推荐的，兼容性也最好。

在这里插入图片描述

二、添加配置文件

NLog包安装完成之后，还需要配置才可使用，NLog使用的是NLog.config配置文件。
在项目中填加新项，选择Web配置文件，命名为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"
	internalLogLevel="Warn"
	internalLogFile="nlog.txt">
	<targets>
		<target xsi:type="File" name="allfile" fileName="nlog-all-${shortdate}.log" layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
		<target xsi:type="File" name="ownFile-web" fileName="nlog-own-${shortdate}.log" layout="${longdate}|${logger}|${uppercase:${level}}| ${message} ${exception}"/>
	</targets>
	<rules>
		<logger name="*" minlevel="Trace" writeTo="allfile" />
		<logger name="Microsoft.*" minlevel="Trace" final="true" />
		<logger name="*" minlevel="Trace" writeTo="ownFile-web" />
	</rules>
</nlog>

三、注册NLog

NLog的包和配置文件完成之后，可以在Program类中注册NLog日志提供程序。
NLog要使用ILoggerFactory来提供注入服务，这里我们在统一的Program类中注册NLog。
AddNLog([string path])：ILoggingBuilder的扩展方法，为Blzor框架添加NLog日志提供程序。

Program.cs

......

//清除掉所有的日志服务
builder.Logging.ClearProviders();
//添加NLog日志服务
builder.Logging.AddNLog();

......

这里试了一下，如果不清除掉所有的日志服务，直接添加NLog服务，可以保留其他日志提供程序的日志记录。

四、使用NLog

Home.razor

@page "/"
@inject ILoggerFactory LoggerFactory

<PageTitle>Home</PageTitle>

<h1>Hello, world!</h1>

Welcome to your new app.

@code{
    protected override void OnInitialized(){
        ILogger _logger = LoggerFactory.CreateLogger<Home>();
        _logger.LogInformation("Information");
        _logger.LogWarning("Warning");
    }
}
SchuylerEX
关注
  • 16
    点赞
  • 踩
  • 24
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
第2章 章节二 JMeter4.x基础知识讲解和压测实战
01-08
在本章节中，我们将深入探讨JMeter 4.x的基础知识，并通过实际的压测案例来进一步理解其核心功能。JMeter是一款开源、跨平台的负载和性能测试工具，广泛应用于Web应用的压力测试，也可用于其他协议和服务的测试。...
大数据基础-走进大数据-第一章-数据时代--从我开始.ppt
12-24
【大数据基础概述】 大数据，顾名思义，指的是数据量极其庞大、增长迅速、类型繁多，以至于传统数据处理方式无法在合理...了解和掌握大数据的基础知识，对于个人和企业来说，都是适应信息时代发展、提升竞争力的关键。
计算机二级公共基础知识
04-03
#### 第二章 程序设计基础 **2.1 程序设计风格** - **清晰性**: 代码易于理解和维护。 - **简洁性**: 避免冗余，提高代码可读性。 - **一致性**: 保持编码风格的一致性。 **2.2 结构化程序设计** - **定义**: 一...
第二章：开发环境的设置
03-13
### 第二章：开发环境的设置 #### 一、引言 Odoo 是一款功能强大的开源企业资源计划（ERP）和客户关系管理（CRM）软件，适用于各种规模的企业。为了帮助开发者更好地理解如何搭建和配置Odoo开发环境，本章节详细...
第1章 Oracle数据库基础.pdf
08-30
通过本章的学习，我们了解了Oracle数据库的基础知识，包括数据管理的历史演变、数据模型的概念、Oracle数据库的体系结构和常用对象，以及如何管理和配置Oracle数据库。这些基础知识对于理解更高级的Oracle数据库管理...
C#初级——List 容器
wacanda的博客
07-31 503
在C#中，容器通常指的是用于存储和组织数据的集合类。本文介绍的容器是内部使用数组来存储元素，当添加元素超出当前数组容量时，会自动调整大小（扩容）。
c#设置触控屏触控自动映射到扩展屏
sczmzx的博客
08-01 874
SetDisplayMapping可以实时告知系统当前触控设备映射到哪个屏幕，即使不设置注册表也能够生效（如果你只想设置临时生效，电脑重启后回到默认状态，那么就可以不进行2.3的步骤）当通过2.3在注册表中将关系挂上后，如果不做其它操作，你会发现你的设置是没有生效的，这时可以采用以下几种办法使配置生效。文末提供了源码下载链接。通过调用SetDisplayMapping方法，可以直接完成通知，并且实时生效，完美解决了我的问题。dwm进程结束后，系统会自动重启dwm，当重启完成后，你会发现新的映射已经生效了。
埃拉托斯特尼筛法，厄拉多塞筛算法，C#实现
GoodCooking的博客
08-06 133
埃拉托斯特尼筛法，厄拉多塞筛算法，C#实现
C# & Unity 面向对象补全计划 七大原则 之 接口隔离原则 (ISP) 难度：☆ 总结：大接口分成小的，然后该干啥干啥
2301_77947509的博客
08-05 231
该干啥干啥原则
在C#中给控件的背景实现渐变效果
虎哥的博客
08-01 434
确保将Panel的DoubleBuffered属性设置为true，以避免绘制时的闪烁。这样就可以在你的C#应用程序中创建具有渐变背景色的Panel了。
AI回答：C#项目编译后生成部分文件的主要职责
最新发布
m0_67412019的博客
08-06 173
ConsoleApp1.csproj 文件是项目的主要配置文件，它定义了项目的结构、依赖项、编译选项和其他设置。这个文件告诉编译器如何编译和构建你的应用程序，包括哪些文件包含在项目中、如何引用外部库和 NuGet 包等等。bin\runtimes 文件夹存放了项目的运行时相关文件，这些文件包括了各种目标平台的运行时库。生成的 .exe 文件可以在别的装有目标框架相应的 .NET 运行时环境的电脑上运行。Debug 模式适合开发阶段，提供了完整的调试支持，但运行速度较慢，生成的文件较大。
关于ABB机器人四元数转欧拉角计算方式 C++ C# Python
m0_66701835的博客
08-03 373
注意，上述公式中的atan2函数表示从y轴到x轴的反正切值，asin函数表示反正弦值。本文采用C++设计，实现四元数转欧拉角。
sql 常见query
轻口味的专栏
08-03 373
【代码】sql 常见query。
【Unity/XLua】xlua自带教程示例分析（五）—— 优化GC
Siro_sama的博客
08-06 565
在Xlua中，使用[GCOptimize]可以避免C#和Lua间传递值类型（普通值类型，只包含值类型的strcut或嵌套struct，枚举类型，以及它们组成的数组）时发生gc alloc。首先最重要的一点是，类要加上LuaCallCSharp的标签，因为后面会在里面向Lua传入自己的this指针，因此lua是可以调用类的。monoBehaviour是在C#中set的变量，即this，所以这里是在使用C#函数处理lua对象。前五个委托接收Lua的id函数，不同的值类型数据都测了一遍（从C#传lua再传回来）
C#TreeView控件应用
qq_27474555的博客
08-05 220
【代码】C#TreeView控件应用。
C#知识|文件与目录操作：对象的创建、保存、读取
做有价值的事，积累有价值的笔记！
07-30 689
哈喽，你好啊，我是雷工！面向对象编程的特点就是一切皆对象，操作的也是对象，本节学习文件与目录操作中，对象的保存；以下为学习笔记。
C# ADC数据波形显示
qq_41721746的博客
07-31 302
【代码】C# ADC数据波形显示。
C# 构建观测者模式（或者为订阅者模型）
山云的专栏
08-01 635
C# Formworks 定义的事件定义在中的委托，包括事件发送者，和发送的事件数据对象两个参数。定义了一个名为的公共静态类例如，我们在Form1，订阅了这个事件// 拿到事件的参数数据// 后续进行处理。
记录｜如何统一管理多个同一个对象？
技术小白=-=的博客
08-01 384
自己的感想一开始，自己没弄懂C# winform中的testBox是什么，导致创建多个testBox的时候要用很笨的方法来进行管理。就是下面这种：用数组一个一个掉用里面的单独属性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

SchuylerEX

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值