桌面程序日志级别实战指南：Microsoft.Extensions.Logging 核心用法
in C# with 0 comment

C#

在桌面程序开发（WPF/WinForms）中，日志是问题排查、用户行为追溯的核心工具。Microsoft.Extensions.Logging 作为 .NET 官方日志抽象库，提供了一套标准化的日志能力，但很多开发者在实际使用时会困惑：5种日志级别该如何选择？是否需要全部用上？本文结合桌面程序场景，拆解日志级别的核心用法，给出主流实战方案，帮你写出简洁高效的日志。

一、核心前提：日志级别的选择原则

桌面程序不同于服务端，无明确的开发/生产环境隔离，日志直接存储在用户本地磁盘，因此选择日志级别的核心原则是：按“问题严重性”和“使用场景”划分，兼顾调试效率与日志可读性，控制日志体积。

核心目标是：开发时能快速排查问题，生产时只保留有价值的日志，避免冗余日志占用用户磁盘空间。

二、日志级别全解析（附桌面程序实战）

Microsoft.Extensions.Logging 提供5种核心日志级别（从低到高：Trace < Debug < Information < Warning < Error），另有Critical级别（致命错误）在桌面程序中使用率极低，后文仅作补充说明。先给出通用日志配置，再逐级别拆解用法。

基础配置：桌面程序日志初始化（通用）

首先通过NuGet安装依赖包，适用于WPF和WinForms程序：


# 核心日志抽象（必装）
Install-Package Microsoft.Extensions.Logging
# 控制台输出（开发调试用）
Install-Package Microsoft.Extensions.Logging.Console
# 文件输出（生产环境核心，按日期拆分日志）
Install-Package Serilog.Extensions.Logging.File

在程序入口（App.xaml.cs/Program.cs）初始化全局日志工厂，方便全项目调用：


using Microsoft.Extensions.Logging;
using System.Windows;
using System;
using System.Reflection;

namespace WpfLoggingDemo
{
    public partial class App : Application
    {
        // 全局静态日志工厂
        public static ILoggerFactory LoggerFactory { get; private set; }

        protected override void OnStartup(StartupEventArgs e)
        {
            base.OnStartup(e);

            // 初始化日志配置
            LoggerFactory = LoggerFactory.Create(builder =>
            {
                builder
                    // 开发环境设为Debug及以上，生产环境改为Information及以上
                    .SetMinimumLevel(LogLevel.Debug)
                    // 开发时控制台实时查看日志
                    .AddConsole()
                    // 日志文件按日期拆分，存储到程序目录logs文件夹
                    .AddFile(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "logs", "app-{Date}.txt"));
            });

            // 记录程序启动信息（Information级别）
            var logger = LoggerFactory.CreateLogger<App>();
            logger.LogInformation("WPF程序启动，版本：{Version}", Assembly.GetExecutingAssembly().GetName().Version);

            new MainWindow().Show();
        }

        protected override void OnExit(ExitEventArgs e)
        {
            base.OnExit(e);
            var logger = LoggerFactory.CreateLogger<App>();
            logger.LogInformation("WPF程序退出，退出码：{ExitCode}", e.ApplicationExitCode);
        }
    }
}

在窗口/业务类中使用日志（以MainWindow为例）：


using Microsoft.Extensions.Logging;
using System.Windows;

namespace WpfLoggingDemo
{
    public partial class MainWindow : Window
    {
        // 泛型ILogger，关联当前类（便于按类筛选日志）
        private readonly ILogger<MainWindow> _logger;

        public MainWindow()
        {
            InitializeComponent();
            // 从全局工厂创建Logger实例
            _logger = App.LoggerFactory.CreateLogger<MainWindow>();
        }

        // 业务逻辑方法...
    }
}

1. Trace（追踪）：开发专属极致细节日志

定位：最细粒度的调试日志，仅用于开发阶段，记录程序执行的每一个细节步骤。

适用场景：排查复杂逻辑（如循环内变量变化、高频操作流程），记录临时调试信息，仅在开发时开启。

核心注意：生产环境必须关闭，否则会产生海量日志，快速占满用户磁盘。

代码示例（文件导入场景）：


private void BtnImport_Click(object sender, RoutedEventArgs e)
{
    var filePath = txtFilePath.Text;
    _logger.LogTrace("开始读取文件：{FilePath}", filePath);
    
    try
    {
        var lines = File.ReadAllLines(filePath);
        for (int i = 0; i < lines.Length; i++)
        {
            // 记录每一行内容，仅用于调试排查导入逻辑
            _logger.LogTrace("第 {LineNumber} 行内容：{Content}", i+1, lines[i]);
        }
        _logger.LogTrace("文件读取完成，共 {LineCount} 行", lines.Length);
    }
    catch (Exception ex)
    {
        _logger.LogError(ex, "文件读取失败");
    }
}

2. Debug（调试）：开发/测试关键步骤日志

定位：比Trace粗粒度，记录核心调试节点，不关注高频细节，是开发阶段的主力调试日志。

适用场景：记录方法入参/出参、业务逻辑分支（如导出格式选择）、接口请求响应等关键调试信息。

核心注意：生产环境通常关闭，仅需在远程调试时临时开启。

代码示例（数据导出场景）：


private void BtnExport_Click(object sender, RoutedEventArgs e)
{
    var exportType = cbExportType.SelectedItem?.ToString() ?? "Excel";
    var exportCount = int.TryParse(txtExportCount.Text, out int count) ? count : 0;
    
    // 记录导出核心参数，无需记录每条数据
    _logger.LogDebug("用户触发数据导出：格式={ExportType}，条数={ExportCount}", exportType, exportCount);
    
    var exportResult = ExportData(exportType, exportCount);
    _logger.LogDebug("导出完成，结果：{Result}", exportResult ? "成功" : "失败");
}

3. Information（信息）：生产必留业务日志

定位：记录正常业务行为，无错误、无需额外关注，核心用于追溯用户操作轨迹和程序生命周期。

适用场景：用户核心操作（登录/保存/导出）、程序关键生命周期（启动/退出/配置加载），生产环境必须保留。

代码示例（文档保存场景）：


private void BtnSaveDocument_Click(object sender, RoutedEventArgs e)
{
    var docName = txtDocName.Text;
    var savePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Documents", docName + ".docx");
    
    try
    {
        SaveDocument(savePath);
        // 记录用户正常操作，用于行为追溯
        _logger.LogInformation("用户 [{UserName}] 成功保存文档：{DocName}，路径：{SavePath}", 
                              Environment.UserName, docName, savePath);
    }
    catch (Exception ex)
    {
        _logger.LogError(ex, "用户 [{UserName}] 保存文档失败", Environment.UserName);
    }
}

4. Warning（警告）：潜在问题提醒日志

定位：程序可正常运行，但出现不规范、有风险的情况，需后续排查潜在问题。

适用场景：用户输入不规范（自动修正）、资源不足（临时处理）、可选依赖缺失（降级处理），生产环境需保留。

代码示例（表单提交场景）：


private void BtnSubmitForm_Click(object sender, RoutedEventArgs e)
{
    var phone = txtPhone.Text;
    // 手机号格式校验
    if (!System.Text.RegularExpressions.Regex.IsMatch(phone, @"^1[3-9]\d{9}$"))
    {
        // 自动修正格式（去除非数字字符）
        var correctedPhone = System.Text.RegularExpressions.Regex.Replace(phone, @"\D", "");
        _logger.LogWarning("用户输入手机号格式错误：{OriginalPhone}，已自动修正为：{CorrectedPhone}", 
                          phone, correctedPhone);
        phone = correctedPhone;
    }
    
    // 继续提交逻辑...
}

5. Error（错误）：业务失败核心日志

定位：某部分业务逻辑执行失败，但程序整体可正常运行，需立即排查问题根源。

适用场景：文档保存失败、文件导入错误、接口调用异常等，捕获异常时必须附带Exception对象，保留堆栈信息。

代码示例（文件上传场景）：


private async void BtnUpload_Click(object sender, RoutedEventArgs e)
{
    var filePath = txtUploadPath.Text;
    if (!File.Exists(filePath))
    {
        _logger.LogError("文件不存在：{FilePath}", filePath);
        MessageBox.Show("文件不存在，请检查路径", "错误", MessageBoxButton.OK, MessageBoxImage.Error);
        return;
    }
    
    try
    {
        await UploadFileToServer(filePath);
        _logger.LogInformation("文件上传成功：{FilePath}", filePath);
    }
    catch (Exception ex)
    {
        // 记录异常及上下文，便于排查问题
        _logger.LogError(ex, "用户 [{UserName}] 上传文件失败：{FilePath}", 
                        Environment.UserName, filePath);
        MessageBox.Show("文件上传失败，请检查网络或文件格式", "错误", 
                        MessageBoxButton.OK, MessageBoxImage.Error);
    }
}

补充：Critical（致命）级别

定位：程序即将崩溃或无法继续运行的致命错误，桌面程序中极少出现。

示例：核心配置文件丢失、数据库连接失败且无法重试等，记录后需终止程序或触发紧急处理。


// 核心配置加载失败场景
private void LoadConfig()
{
    var configPath = "appsettings.json";
    if (!File.Exists(configPath))
    {
        _logger.LogCritical("核心配置文件 {ConfigPath} 丢失，程序无法运行！", configPath);
        Application.Current.Shutdown(-1);
    }
}

三、主流实战策略：不用全用，抓核心3个级别

实际开发中，无需使用全部5个级别，核心遵循“开发高效、生产精简”的原则，主流方案如下：

1. 生产环境（交付用户）：仅保留3个核心级别

目标：日志量可控、信息有价值，避免冗余和隐私泄露。

级别是否使用核心价值
Information✅ 必用追溯用户操作和程序生命周期
Warning✅ 常用发现潜在问题，提前排查
Error✅ 必用定位业务失败根源，快速修复
Debug/Trace❌ 不用日志冗余，无实际价值，占磁盘空间

生产环境配置调整（仅输出Information及以上级别）：


LoggerFactory = LoggerFactory.Create(builder =>
{
    builder
        .SetMinimumLevel(LogLevel.Information) // 生产环境核心配置
        .AddFile(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "logs", "app-{Date}.txt"));
});

2. 开发/调试阶段：临时补充Debug级别

目标：快速排查问题，调试完成后无需删除代码（生产环境会自动过滤）。

四、避坑指南：桌面程序日志使用注意事项

  1. 控制日志体积：桌面程序日志存于用户本地，避免开启Trace/Debug，可设置日志文件大小上限（如单文件50MB，保留7天历史）。
  2. Error级别必带Exception：堆栈信息是排查问题的核心，缺失会导致无法定位根源。
  3. 避免敏感信息：不记录密码、身份证、手机号等敏感数据，防止隐私泄露。
  4. 日志分类清晰：使用泛型ILogger，按类划分日志类别，便于筛选（如按MainWindow、ExportService分类）。

五、总结

桌面程序使用Microsoft.Extensions.Logging，核心是“抓重点、弃冗余”：

按此方案使用日志，既能在开发时快速定位问题，又能保证生产环境日志的简洁高效，是桌面程序日志的主流实战方案。

本文由 jxxxy 创作，采用 知识共享署名4.0 国际许可协议进行许可。
本站文章除注明转载/出处外，均为本站原创或翻译，转载前请务必署名。


Warning: Undefined array key "permalink" in /www/wwwroot/note.dc24.top/usr/themes/pinghsu/functions.php on line 333
→ ↓ ↑
回复