在软件开发过程中,调试和诊断应用程序的运行状态是至关重要的步骤。这篇文章将分享Trace对象的使用场景和使用方法,包括在跨平台下的兼容(Windows、Linux)和AOT编译下的使用(完整代码在文章底部链接,如果有帮助希望像雄鹰一下狠狠的点一下star)。
Trace 是 C# 提供的一个调试和诊断工具,它允许开发者在应用程序运行时输出信息,从而帮助识别和解决问题。Trace 对象的主要功能包括:
Trace
(及 Debug
): 是 .NET 框架原生提供的 调试与跟踪基础设施(位于 System.Diagnostics
命名空间),诞生于 .NET 早期,设计初衷是 实时诊断程序执行流程,主要用于开发和测试阶段的代码调试、流程跟踪(如方法调用顺序、参数传递等)。 它更贴近 "程序内部运行轨迹的记录",强调对代码执行过程的 实时观察。ILogger
、log4net、Serilog 等),核心目标是 持久化记录程序关键事件(如错误、警告、业务操作等),用于生产环境的问题排查、业务分析、监控告警等。 它更侧重 "事件的持久化存储与后期分析"。Trace
:TraceListener
可输出到控制台、文件、调试器等,但默认配置下更适合开发 / 测试环境(可通过编译符号控制是否生效,如 TRACE
符号)。Trace
的特性:
TraceSwitch
)控制输出粒度,可动态开启 / 关闭不同级别的跟踪。// 跟踪方法调用
Trace.WriteLine("进入 UserService.GetUser 方法");
// 跟踪关键参数
Trace.WriteLineIf(userId < 0, "警告:用户ID为负数", "参数检查");
日志的特性:
ILogger
):
// 记录业务事件
logger.LogInformation("用户 {UserId} 登录成功", userId);
// 记录异常
logger.LogError(ex, "订单 {OrderId} 处理失败", orderId);
Trace
适合 开发阶段的代码级跟踪,关注 "程序如何运行";这里继续分享,代码的实现和为什么要使用Trace的原因:
代码实现:
public static class Tracer
{
//...
static GeneralTracer()
{
Trace.Listeners.Clear();
//将调试记录转发到Dbgview.exe工具中查看,由于目前没发现官方有Linux版本的Dbgview.exe所以只实现了windows的。
//如果在Linux操作系统下可通过文本记录的方式查看。
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
Trace.Listeners.Add(new WindowsOutputDebugListener());
}
//调试记录转发到控制台中查看,例如:IDE的控制台
Trace.Listeners.Add(new TextWriterTraceListener(Console.Out) { Name = "ConsoleListener" });
//调试记录转发到本地文本文件中记录,由于原生的TextWriteTraceListener写入文件容易出现进程占用,所以手写了一个带队列的写入文件实现。
InitializeFileListener();
if (Debugger.IsAttached)
Trace.Listeners.Add(new DefaultTraceListener());
Trace.AutoFlush = true;
_isTracingEnabled = true;
}
private static void InitializeFileListener()
{
var today = DateTime.Now.ToString("yyyy-MM-dd");
if (today == _currentLogDate && _fileListener != null)
return;
var logDir = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Logs");
Directory.CreateDirectory(logDir);
var logFileName = Path.Combine(logDir, $"generalupdate-trace {today}.log");
_fileListener = new TextTraceListener(logFileName);
Trace.Listeners.Add(_fileListener);
_currentLogDate = today;
}
//...
public static void Info(string message) => WriteTraceMessage(TraceLevel.Info, message);
public static void Error(string message) => WriteTraceMessage(TraceLevel.Error, message);
private static void WriteTraceMessage(TraceLevel level, string message)
{
if(!IsTracingEnabled())
return;
InitializeFileListener();
var timestamp = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff");
var levelName = GetLevelName(level);
var fullMessage = string.Empty;
try
{
//这里尝试使用#if !NATIVEAOT或者RuntimeInfomation的做法在代码内判断当前是否AOT编译,这两种方式通常无效,这里为了简单在AOT下通过try的 //方式兼容简化输出。
//在AOT下该方法不可使用,因为StackFrame 的工作机制依赖于程序运行时的动态调试信息和调用栈结构,而 AOT 编译的核心是通过静态优化生成高效、 //精简的机器码,必然会剥离动态信息并改变原始调用栈结构。这种本质冲突导致 StackFrame 在 AOT 环境下通常无法正常使用。
var stackFrame = new StackFrame(2, true);
var method = stackFrame.GetMethod();
var className = method.DeclaringType?.Name ?? "UnknownType";
var methodName = method.Name;
var lineNumber = stackFrame.GetFileLineNumber();
var lineInfo = lineNumber > 0 ? $"Line {lineNumber}" : "Line N/A (Line numbers may not be displayed in Release mode)";
fullMessage = $"[{timestamp}] [{levelName}] {className}.{methodName} ({lineInfo}): {message}";
}
catch
{
//为了兼容AOT,在此简化了输出
fullMessage = $"[{timestamp}] [{levelName}] : {message}";
}
Trace.WriteLine(fullMessage);
}
//...
}
运行效果:
这里非常简单的手动引发了一个异常效果如下(左上角Dbgview.exe、左下角IDE、右侧文本记录)。