WPF 手撸插件 七 日志记录(二)

为风而战2024-08-28 20:24

1、本文使用Serilog进行记录日志，目前想只用log4net进行日志记录，但是Serilog有想学习一下，所有这里使用控制台项目来学习一下Serilog。我使用的还是.Net Framework 4.5.

2、NuGet 安装Serilog 2.12.0、Serilog.Sinks.Console 4.1.0，如下图。

3、代码示例。

3.1、将信息输入到控制台，代码如下。

cs 复制代码 
using Serilog;
using Serilog.Sinks.SystemConsole;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleAppSerilog
{
    class Program
    {
        static void Main(string[] args)
        {
            //1、输出信息到控制台
            ILogger logger = new LoggerConfiguration().WriteTo.Console().CreateLogger();
            logger.Information("信息日志");
            Console.ReadKey();
        }
    }
}

运行效果如下图。

3.2、将日志信息输出到文件，添加NuGet Serilog.Sinks.File 4.1.0，如下图。

示例代码如下。其中自动创建Log文件夹；rollingInterval:RollingInterval.Day，log文件名后自动添加当天日期

cs 复制代码 
using Serilog;
using Serilog.Sinks.SystemConsole;
using Serilog.Sinks.SystemConsole.Themes;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleAppSerilog
{
    class Program
    {
        static void Main(string[] args)
        {
            //1、输出信息到控制台
            ILogger logger = new LoggerConfiguration()
                .WriteTo.Console(theme:AnsiConsoleTheme.Code)
                .WriteTo.File(@"Log/log.txt",rollingInterval:RollingInterval.Day,rollOnFileSizeLimit:true)//自动创建Log文件夹；rollingInterval:RollingInterval.Day，log文件名后自动添加当天日期
                .CreateLogger();
            logger.Information("信息日志");
            Console.ReadKey();
        }
    }
}

效果如下图。

3.3、将日志以json数据形式打印到控制台和文件中，效果如下图。

创建一个LogInfo类，代码如下。

cs 复制代码 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleAppSerilog
{
    public class LogInfo
    {
        public int Index { get; set; }

        public string Description { get; set; }
    }
}

Main函数代码如下。

cs 复制代码 
using Serilog;
using Serilog.Sinks.SystemConsole;
using Serilog.Sinks.SystemConsole.Themes;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleAppSerilog
{
    class Program
    {
        static void Main(string[] args)
        {
            //1、输出信息到控制台
            ILogger logger = new LoggerConfiguration()
                .WriteTo.Console(theme:AnsiConsoleTheme.Code)
                .WriteTo.File(@"Log/log.txt",rollingInterval:RollingInterval.Day,rollOnFileSizeLimit:true)//自动创建Log文件夹；rollingInterval:RollingInterval.Day，log文件名后自动添加当天日期
                .CreateLogger();
            logger.Information("信息日志");
            
            var logInfo = new LogInfo
            {
                Index=1,
                Description="日志描述"
            };

            logger.Information("{@logInfo}", logInfo);
            Console.ReadKey();
        }
    }
}

3.4、几种常见的信息输出方式，效果如下图。

代码如下。

cs 复制代码 
using Serilog;
using Serilog.Sinks.SystemConsole;
using Serilog.Sinks.SystemConsole.Themes;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleAppSerilog
{
    class Program
    {
        static void Main(string[] args)
        {
            //1、输出信息到控制台
            ILogger logger = new LoggerConfiguration()
                .WriteTo.Console(theme:AnsiConsoleTheme.Code)
                .WriteTo.File(@"Log/log.txt",rollingInterval:RollingInterval.Day,rollOnFileSizeLimit:true)//自动创建Log文件夹；rollingInterval:RollingInterval.Day，log文件名后自动添加当天日期
                .CreateLogger();
            logger.Information("信息日志");
            
            var logInfo = new LogInfo
            {
                Index=1,
                Description="日志描述"
            };

            logger.Information("{logInfo}", logInfo);
            logger.Information("{@logInfo}", logInfo);
            logger.Information("{$logInfo}", logInfo);


            logger.Information("-----------------------");

            var dicLogInfo = new Dictionary<string, object>
            {
                {"Index",logInfo.Index },
                {"Description",logInfo.Description },
            };

            logger.Information("{dicLogInfo}", dicLogInfo);
            logger.Information("{@dicLogInfo}", dicLogInfo);
            logger.Information("{$dicLogInfo}", dicLogInfo);
            Console.ReadKey();
        }
    }
}

3.5、SerilogTimings 在应用程序中记录操作的执行时间。‌通过SerilogTimings，‌开发者可以在日志中包含关于操作执行时长的信息，‌这对于性能监控和调试非常有用。‌

示例如下，首先添加NuGet SerilogTimings 2.3.0，如下图。

示例代码如下。

cs 复制代码 
using Serilog;
using Serilog.Sinks.SystemConsole;
using Serilog.Sinks.SystemConsole.Themes;
using SerilogTimings;
using SerilogTimings.Extensions;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleAppSerilog
{
    class Program
    {
        static void Main(string[] args)
        {
            //1、输出信息到控制台
            ILogger logger = new LoggerConfiguration()                
                .WriteTo.Console(theme: AnsiConsoleTheme.Code)
                .WriteTo.File(@"Log/log.txt",rollingInterval:RollingInterval.Day,rollOnFileSizeLimit:true)//自动创建Log文件夹；rollingInterval:RollingInterval.Day，log文件名后自动添加当天日期
                .CreateLogger();

            logger.Information("信息日志");
            
            var logInfo = new LogInfo
            {
                Index=1,
                Description="日志描述"
            };

            logger.Information("{logInfo}", logInfo);
            logger.Information("{@logInfo}", logInfo);
            logger.Information("{$logInfo}", logInfo);


            logger.Information("-----------------------");

            var dicLogInfo = new Dictionary<string, object>
            {
                {"Index",logInfo.Index },
                {"Description",logInfo.Description },
            };

            logger.Information("{dicLogInfo}", dicLogInfo);
            logger.Information("{@dicLogInfo}", dicLogInfo);
            logger.Information("{$dicLogInfo}", dicLogInfo);

            TimeOper(logger, logInfo);

            Console.ReadKey();
        }

        public static async void TimeOper(ILogger logger, LogInfo logInfo)
        {
            using (logger.TimeOperation("Submitting payment for {Index}", logInfo.Index))
            {
                // Timed block of code goes here
                await Task.Delay(50);
                logger.Information("执行日志{Description}", logInfo.Description);
            }

            var opr=logger.BeginOperation("BeginOperation {Index}", logInfo.Index);
            await Task.Delay(50);
            logger.Information("执行日志 BeginOperation {Description}", logInfo.Description);

            opr.Complete();

        }
    }

}

运行效果如下图。

3.6、使用Destructurama.Attributed 1.0.7 对日志内容进行一些隐藏，由于我这里使用的是.Net Framework4.5，所以用法上不要过度的计较。

NuGet引入 Destructurama.Attributed 1.0.7 如下图。

运行效果如下图。Description中的数据被***替代了。

示例代码如下。

cs 复制代码 
using Serilog;
using Serilog.Sinks.SystemConsole;
using Serilog.Sinks.SystemConsole.Themes;
using SerilogTimings;
using SerilogTimings.Extensions;
using Destructurama;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;


namespace ConsoleAppSerilog
{
    class Program
    {
        static void Main(string[] args)
        {
            //1、输出信息到控制台
            ILogger logger = new LoggerConfiguration()
                .Destructure.UsingAttributes()
                .WriteTo.Console(theme: AnsiConsoleTheme.Code)
                .WriteTo.File(@"Log/log.txt",rollingInterval:RollingInterval.Day,rollOnFileSizeLimit:true)//自动创建Log文件夹；rollingInterval:RollingInterval.Day，log文件名后自动添加当天日期
                .Destructure.ByTransforming<LogInfo>(obj=> new{
                    Index = obj.Index,
                    Description = "***"
                })
                
                .CreateLogger();

            logger.Information("信息日志");
            
            var logInfo = new LogInfo
            {
                Index=1,
                Description="日志描述"
            };

            logger.Information("{logInfo}", logInfo);
            logger.Information("{@logInfo}", logInfo);
            logger.Information("{$logInfo}", logInfo);


            logger.Information("-----------------------");

            var dicLogInfo = new Dictionary<string, object>
            {
                {"Index",logInfo.Index },
                {"Description",logInfo.Description },
            };

            logger.Information("{dicLogInfo}", dicLogInfo);
            logger.Information("{@dicLogInfo}", dicLogInfo);
            logger.Information("{$dicLogInfo}", dicLogInfo);

            TimeOper(logger, logInfo);

            Console.ReadKey();
        }

        public static async void TimeOper(ILogger logger, LogInfo logInfo)
        {
            using (logger.TimeOperation("Submitting payment for {Index}", logInfo.Index))
            {
                // Timed block of code goes here
                await Task.Delay(50);
                logger.Information("执行日志{Description}", logInfo.Description);
            }

            var opr=logger.BeginOperation("BeginOperation {Index}", logInfo.Index);
            await Task.Delay(50);
            logger.Information("执行日志 BeginOperation {Description}", logInfo.Description);

            opr.Complete();

        }
    }

}

3.7、使用异步，Serilog.Sinks.Async 1.5.0 。Serilog.Sinks.Async 是 Serilog 的一个扩展库，‌它提供了异步日志记录的功能。‌使用这个库，‌你可以将日志消息异步地写入到不同的日志存储中，‌比如文件、‌数据库或远程日志服务等。‌这样做的好处是可以提高应用程序的性能，‌因为日志记录操作不会阻塞主线程。‌

NuGet 安装Serilog.Sinks.Async 1.5.0，如下图。

示例代码如下。

cs 复制代码 
using Serilog;
using Serilog.Sinks.SystemConsole;
using Serilog.Sinks.SystemConsole.Themes;
using SerilogTimings;
using SerilogTimings.Extensions;
using Destructurama;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;


namespace ConsoleAppSerilog
{
    class Program
    {
        static void Main(string[] args)
        {
            //1、输出信息到控制台
            ILogger logger = new LoggerConfiguration()
                .Destructure.UsingAttributes()
                //Async 异步写入控制台
                .WriteTo.Async(a=>a.Console(theme: AnsiConsoleTheme.Code))
                //Async 异步写入文件
                .WriteTo.Async(a=>a.File(@"Log/log.txt",rollingInterval:RollingInterval.Day,rollOnFileSizeLimit:true))//自动创建Log文件夹；rollingInterval:RollingInterval.Day，log文件名后自动添加当天日期
                .Destructure.ByTransforming<LogInfo>(obj=> new{
                    Index = obj.Index,
                    Description = "***"
                })
                
                .CreateLogger();

            logger.Information("信息日志");
            
            var logInfo = new LogInfo
            {
                Index=1,
                Description="日志描述"
            };

            logger.Information("{logInfo}", logInfo);
            logger.Information("{@logInfo}", logInfo);
            logger.Information("{$logInfo}", logInfo);


            logger.Information("-----------------------");

            var dicLogInfo = new Dictionary<string, object>
            {
                {"Index",logInfo.Index },
                {"Description",logInfo.Description },
            };

            logger.Information("{dicLogInfo}", dicLogInfo);
            logger.Information("{@dicLogInfo}", dicLogInfo);
            logger.Information("{$dicLogInfo}", dicLogInfo);

            TimeOper(logger, logInfo);
            
            Log.CloseAndFlush();
            //Log.CloseAndFlush(); 在 Serilog 中是一个非常重要的调用，‌它用于确保所有缓存或排队的日志消息都被正确处理并写入到它们的目标存储中。‌
            //当你的应用程序准备关闭或退出时，‌调用这个方法是一个好习惯，‌因为它可以防止日志消息的丢失。‌

            Console.ReadKey();
        }

        public static async void TimeOper(ILogger logger, LogInfo logInfo)
        {
            using (logger.TimeOperation("Submitting payment for {Index}", logInfo.Index))
            {
                // Timed block of code goes here
                await Task.Delay(50);
                logger.Information("执行日志{Description}", logInfo.Description);
            }

            var opr=logger.BeginOperation("BeginOperation {Index}", logInfo.Index);
            await Task.Delay(50);
            logger.Information("执行日志 BeginOperation {Description}", logInfo.Description);

            opr.Complete();

        }
    }

}

3.8、Log.CloseAndFlush(); 在 Serilog 中是一个非常重要的调用，‌它用于确保所有缓存或排队的日志消息都被正确处理并写入到它们的目标存储中。‌当你的应用程序准备关闭或退出时，‌调用这个方法是一个好习惯，‌因为它可以防止日志消息的丢失。‌

4、示例代码可以在这里下载。https://download.csdn.net/download/xingchengaiwei/89687805

其中的ConsoleAppSerilog项目。

相关推荐
IT技术分享社区3 小时前
C#实战：使用腾讯云识别服务轻松提取火车票信息
开发语言·c#·云计算·腾讯云·共识算法
月落.4 小时前
WPF的＜ContentControl＞控件
wpf
就是有点傻4 小时前
WPF中的依赖属性
开发语言·wpf
wangnaisheng4 小时前
【WPF】把一个Window放在左上角/右上角顶格显示
wpf
WineMonk4 小时前
.NET WPF CommunityToolkit.Mvvm框架
.net·wpf·mvvm
月落.4 小时前
WPF中的INotifyPropertyChanged接口
wpf
界面开发小八哥4 小时前
界面控件DevExpress WPF中文教程：Data Grid——卡片视图设置
.net·wpf·界面控件·devexpress·ui开发
平凡シンプル4 小时前
WPF 打包
wpf
VickyJames4 小时前
基于XAML框架和跨平台项目架构设计的深入技术分析
wpf·开源分享·unoplatform·winui3·项目架构
冷眼Σ(-᷅_-᷄๑)8 小时前
WPF缩放动画和平移动画叠加后会发生什么?
wpf·动画
热门推荐
01【HarmonyOS】HUAWEI DevEco Studio 下载地址汇总02(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明03组基轨迹建模 GBTM的介绍与实现（Stata 或 R）04【AIGC】重塑未来的科技巨轮05全面解析：构建基于深度学习的安全帽检测系统（UI界面+YOLO代码+数据集）06【经验分享】Ubuntu22.04安装微信(linux官方版)07基于YOLOv10深度学习的CT扫描图像肾结石智能检测系统【python源码+Pyqt5界面+数据集+训练代码】深度学习实战、目标检测08Ubuntu 20.04使用Livox mid 360 测试 FAST_LIO09RAG 实践- Ollama+RagFlow 部署本地知识库10【TC3xx芯片】TC3xx芯片电源管理系统PMS详解