百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

Avalonia日志组件实现与优化指南

zhezhongyun 2025-08-02 22:46 53 浏览

背景

Avalonia 目前没有富文本框可实现日志输出显示,但提供了SelectableTextBlock控件可以替换,这是站长实现的一个日志组件效果:

可展示日志时间、日志级别、日志详细内容等,后台除输出到界面外,也可持久化输出到文本文件,对于更多的日志信息展示可自行扩展,下面先讲解实现过程,再指出存在的问题,欢迎 PR。

使用

安装:

NuGet\Install-Package CodeWF.LogViewer.Avalonia -Version 1.0.10.2

视图使用:

xmlns:log="https://codewf.com"

<log:LogView />

日志输出:

Logger.Debug("调试日志");
Logger.Info("信息日志");
Logger.Warn("警告日志");
Logger.Error("错误日志");
Logger.Fatal("致命日志");

实现

只说关键部分代码,具体代码可浏览CodeWF.LogViewer仓库。

程序通过Logger类输出日志,该类将日志信息缓存到ConcurrentQueue<LogInfo> Logs集合,Logger类定义如下:

public staticclassLogger
{
publicstatic LogType Level = LogType.Info;
publicstaticstring LogDir = AppDomain.CurrentDomain.BaseDirectory;
internalstaticreadonly ConcurrentQueue<LogInfo> Logs = new();

public static void RecordToFile()
{
Task.Run(async () =>
{
while (true)
{
while (TryDequeue(outvar log))
{
var content =
$"{log.RecordTime}: {log.Level.Description()} {log.Description}{Environment.NewLine}";
AddLogToFile(content);
}

await Task.Delay(TimeSpan.FromMilliseconds(100));
}
});
}

public static bool TryDequeue(out LogInfo info)
{
return Logs.TryDequeue(out info);
}

public static void Log(int type, string content)
{
var logType = (LogType)type;
if (Level > logType) return;
Logs.Enqueue(new LogInfo(logType, content));
}

public static void Debug(string content)
{
if (Level <= LogType.Debug)
{
Logs.Enqueue(new LogInfo(LogType.Debug, content));
}
}

public static void Info(string content)
{
if (Level <= LogType.Info)
{
Logs.Enqueue(new LogInfo(LogType.Info, content));
}
}

public static void Warn(string content)
{
if (Level <= LogType.Warn)
{
Logs.Enqueue(new LogInfo(LogType.Warn, content));
}
}

public static void Error(string content, Exception? ex = )
{
if (Level > LogType.Error) return;

var msg = ex == ? content : $"{content}\r\n{ex.ToString()}";

Logs.Enqueue(new LogInfo(LogType.Error, msg));
}

public static void Fatal(string content, Exception? ex = )
{
if (Level > LogType.Fatal) return;

var msg = ex == ? content : $"{content}\r\n{ex.ToString()}";

Logs.Enqueue(new LogInfo(LogType.Fatal, msg));
}

public static void AddLogToFile(string msg)
{
try
{
var logFolder = System.IO.Path.Combine(LogDir, "Log");
if (!Directory.Exists(logFolder))
{
Directory.CreateDirectory(logFolder);
}

var logFileName = System.IO.Path.Combine(logFolder, $"Log_{DateTime.Now:yyyy_MM_dd}.log");
File.AppendAllText(logFileName, msg);
}
catch
{
// ignored
}
}
}

只输出日志到文本文件

如果只是输出日志到文本文件,而不需要输出到界面,需要主动调用Logger.RecordToFile()方法定时检查日志输出。

同时输出日志到文本文件和视图

前提:这里不需要调用Logger.RecordToFile()方法

我们先看视图LogView.axaml,该部分使用ScrollViewer包裹SelectableTextBlock,以实现日志滚动查看及日志文本的可选择复制:

<ScrollViewer
x:Name="LogScrollViewer"
HorizontalScrollBarVisibility="Auto"
PointerPressed="LogScrollViewer_OnPointerPressed"
VerticalScrollBarVisibility="Auto">

<SelectableTextBlock
x:Name="LogTextView"
TextAlignment="Start"
TextWrapping="Wrap">

<SelectableTextBlock.ContextMenu>
<ContextMenu x:Name="LogContextMenu">
<MenuItem Click="Copy_OnClick" Header="复制" />
<MenuItem Click="Clear_OnClick" Header="清空" />
<MenuItem Click="Location_OnClick" Header="查看日志" />
</ContextMenu>
</SelectableTextBlock.ContextMenu>
</SelectableTextBlock>
</ScrollViewer>

LogView.axaml.cs内调用RecordLog()方法定时读取缓存日志,并再调用LogNotifyHandler方法写入界面,及调用Logger.AddLogToFile方法写入文本文件,代码不多,下面是核心部分:

partial classLogView : UserControl
{
// ...
private void RecordLog()
{
if (_isRecording) return;

_isRecording = true;

Task.Run(async () =>
{
while (true)
{
while (Logger.TryDequeue(outvar log)) LogNotifyHandler(log);

await Task.Delay(TimeSpan.FromMilliseconds(100));
}
});
}

private void LogNotifyHandler(LogInfo logInfo)
{
if (Logger.Level > logInfo.Level) return;

_synchronizationContext.Post(o =>
{
var inlines = _textView.Inlines;
try
{
if (inlines?.Count > MaxCount)
{
for (var i = 0; i < 3; i++)
{
var needRemoveElement = inlines.First();
if (needRemoveElement != )
{
inlines.Remove(needRemoveElement);
}
}
}

var start = _textView.Text.Length;

inlines?.Add(
new Run($"{logInfo.RecordTime}")
{
Foreground = new SolidColorBrush(Color.Parse("#8C8C8C")),
BaselineAlignment = BaselineAlignment.Center
});
inlines?.Add(GetLevelInline(logInfo.Level));
inlines?.Add(new Run(logInfo.Description)
{
Foreground = new SolidColorBrush(Color.Parse("#262626")),
BaselineAlignment = BaselineAlignment.Center
});
inlines?.Add(new Run(Environment.NewLine));

Logger.AddLogToFile(
$"{logInfo.RecordTime}: {logInfo.Level.Description()} {logInfo.Description}{Environment.NewLine}");

_textView.SelectionStart = start;
_textView.SelectionEnd = _textView.Text.Length;
_scrollViewer.ScrollToEnd();
}
catch
{
// ignored
}
}, );
}

private Span GetLevelInline(LogType level)
{
var content = level.Description();

// 创建宽度为零的透明文本,用于复制使用
// TODO:复制还是有问题,会错位
var zeroWidthText = new Run($"【{content}】")
{
Foreground = Brushes.Transparent, FontSize = 0.001
};

// 视觉显示的文本,不会被复制使用
var border = new Border
{
BorderBrush = GetLevelForeground(level),
Background = GetLevelBackground(level),
BorderThickness = new Thickness(1),
CornerRadius = new CornerRadius(2),
Padding = new Thickness(8, 0),
Margin = new Thickness(8, 2),
VerticalAlignment = VerticalAlignment.Center,
IsHitTestVisible = false,
Child = new TextBlock
{
Text = content,
Foreground = GetLevelForeground(level),
IsHitTestVisible = false
}
};
var levelSpan = new Span();
levelSpan.Inlines.Add(zeroWidthText);
levelSpan.Inlines.Add(border);
return levelSpan;
}
// ...
}

上面省略了根据日志类型获取展示前景色、背景色等等代码,这不重要。

存在的问题

看上面的GetLevelInline方法,该方法生成日志级别块,使用的Border套日志级别描述(调试、错误等),实现日志类型带边框效果,但复制存在问题:

选择的7:56 调试 模块块并按Ctrl + C复制,再粘贴到记事本,复制出来是调试】模块名称A-,很明显的错位问题。

复制的应该是文本内容,但Border是不允许复制的,所以代码中留了注释创建宽度为零的透明文本,用于复制使用

// 创建宽度为零的透明文本,用于复制使用
// TODO:复制还是有问题,会错位
var zeroWidthText = new Run($"【{content}】")
{
Foreground = Brushes.Transparent, FontSize = 0.001
};

具体的不细说了,大家有什么解决方案吗?等待有缘人 PR 了,感谢。

总结

本文主要是寻求 PR,该组件如果对您有用,欢迎使用,仓库地址:

  • CodeWF.LogViewer:https://github.com/dotnet9/CodeWF.LogViewer

下篇分享自定义 TabItem 边框实现:


相关推荐

Python入门学习记录之一:变量_python怎么用变量

写这个,主要是对自己学习python知识的一个总结,也是加深自己的印象。变量(英文:variable),也叫标识符。在python中,变量的命名规则有以下三点:>变量名只能包含字母、数字和下划线...

python变量命名规则——来自小白的总结

python是一个动态编译类编程语言,所以程序在运行前不需要如C语言的先行编译动作,因此也只有在程序运行过程中才能发现程序的问题。基于此,python的变量就有一定的命名规范。python作为当前热门...

Python入门学习教程:第 2 章 变量与数据类型

2.1什么是变量?在编程中,变量就像一个存放数据的容器,它可以存储各种信息,并且这些信息可以被读取和修改。想象一下,变量就如同我们生活中的盒子,你可以把东西放进去,也可以随时拿出来看看,甚至可以换成...

绘制学术论文中的“三线表”具体指导

在科研过程中,大家用到最多的可能就是“三线表”。“三线表”,一般主要由三条横线构成,当然在变量名栏里也可以拆分单元格,出现更多的线。更重要的是,“三线表”也是一种数据记录规范,以“三线表”形式记录的数...

Python基础语法知识--变量和数据类型

学习Python中的变量和数据类型至关重要,因为它们构成了Python编程的基石。以下是帮助您了解Python中的变量和数据类型的分步指南:1.变量:变量在Python中用于存储数据值。它们充...

一文搞懂 Python 中的所有标点符号

反引号`无任何作用。传说Python3中它被移除是因为和单引号字符'太相似。波浪号~(按位取反符号)~被称为取反或补码运算符。它放在我们想要取反的对象前面。如果放在一个整数n...

Python变量类型和运算符_python中变量的含义

别再被小名词坑哭了:Python新手常犯的那些隐蔽错误,我用同事的真实bug拆给你看我记得有一次和同事张姐一起追查一个看似随机崩溃的脚本,最后发现罪魁祸首竟然是她把变量命名成了list。说实话...

从零开始:深入剖析 Spring Boot3 中配置文件的加载顺序

在当今的互联网软件开发领域,SpringBoot无疑是最为热门和广泛应用的框架之一。它以其强大的功能、便捷的开发体验,极大地提升了开发效率,成为众多开发者构建Web应用程序的首选。而在Spr...

Python中下划线 ‘_’ 的用法,你知道几种

Python中下划线()是一个有特殊含义和用途的符号,它可以用来表示以下几种情况:1在解释器中,下划线(_)表示上一个表达式的值,可以用来进行快速计算或测试。例如:>>>2+...

解锁Shell编程:变量_shell $变量

引言:开启Shell编程大门Shell作为用户与Linux内核之间的桥梁,为我们提供了强大的命令行交互方式。它不仅能执行简单的文件操作、进程管理,还能通过编写脚本实现复杂的自动化任务。无论是...

一文学会Python的变量命名规则!_python的变量命名有哪些要求

目录1.变量的命名原则3.内置函数尽量不要做变量4.删除变量和垃圾回收机制5.结语1.变量的命名原则①由英文字母、_(下划线)、或中文开头②变量名称只能由英文字母、数字、下画线或中文字所组成。③英文字...

更可靠的Rust-语法篇-区分语句/表达式,略览if/loop/while/for

src/main.rs://函数定义fnadd(a:i32,b:i32)->i32{a+b//末尾表达式}fnmain(){leta:i3...

C++第五课:变量的命名规则_c++中变量的命名规则

变量的命名不是想怎么起就怎么起的,而是有一套固定的规则的。具体规则:1.名字要合法:变量名必须是由字母、数字或下划线组成。例如:a,a1,a_1。2.开头不能是数字。例如:可以a1,但不能起1a。3....

Rust编程-核心篇-不安全编程_rust安全性

Unsafe的必要性Rust的所有权系统和类型系统为我们提供了强大的安全保障,但在某些情况下,我们需要突破这些限制来:与C代码交互实现底层系统编程优化性能关键代码实现某些编译器无法验证的安全操作Rus...

探秘 Python 内存管理:背后的神奇机制

在编程的世界里,内存管理就如同幕后的精密操控者,确保程序的高效运行。Python作为一种广泛使用的编程语言,其内存管理机制既巧妙又复杂,为开发者们提供了便利的同时,也展现了强大的底层控制能力。一、P...