日志抽象与 Debug/Trace
使用 System.Diagnostics 中的 Debug/Trace,添加侦听器,并创建类似 ILogger 的小型抽象,将应用代码与日志接收端解耦。
日志抽象与 Debug/Trace 是 CoddyKit 上的免费 C# Academy 课时。 这是第 1 节课,共 3 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 C# Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 C# Academy 课程共包含 3 节课。
为什么需要日志记录
目标:
- 使用调试和跟踪发送消息
- 添加侦听器以查看输出
- 引入小型日志记录抽象
- 选择级别并使用简单的格式
调试与跟踪基础
调试用于开发;跟踪适用于任何构建。添加 ConsoleTraceListener,即可在控制台应用中查看消息。
using System;
using System.Diagnostics;
// Demo: show Debug/Trace after adding a ConsoleTraceListener
public class Program
{
public static void Main(string[] args)
{
// By default, console apps may not show Debug/Trace. Add a listener.
Trace.Listeners.Clear();
Trace.Listeners.Add(new ConsoleTraceListener());
Debug.WriteLine("Debug: only in debug builds (often)");
Trace.WriteLine("Trace: in all builds (commonly)");
Trace.TraceInformation("Info message");
Trace.TraceWarning("Warning message");
Trace.TraceError("Error message");
}
}
TraceSource 示例
TraceSource用于命名日志记录器,并按 SourceLevels 进行筛选;这对于对消息分组很有用。
using System;
using System.Diagnostics;
// Demo: TraceSource can group logs by name and level.
public class Program
{
public static void Main(string[] args)
{
var src = new TraceSource("Calc", SourceLevels.Information);
src.Listeners.Clear();
src.Listeners.Add(new ConsoleTraceListener());
src.TraceEvent(TraceEventType.Information, 1001, "Starting");
src.TraceEvent(TraceEventType.Warning, 1002, "Low precision");
src.TraceEvent(TraceEventType.Error, 1003, "Divide by zero prevented");
src.Flush();
src.Close();
}
}
小型 ILogger 示例
接口可以将调用方与接收端解耦;以后可以添加文件接收端或远程接收端,而无需更改调用位置。
using System;
// Minimal ILogger-like abstraction for beginners.
public interface ILogger
{
void Info(string msg);
void Warn(string msg);
void Error(string msg);
}
public class ConsoleLogger : ILogger
{
private readonly string _name;
public ConsoleLogger(string name) { _name = name; }
public void Info(string msg) { Console.WriteLine("[INFO] " + _name + " - " + msg); }
public void Warn(string msg) { Console.WriteLine("[WARN] " + _name + " - " + msg); }
public void Error(string msg) { Console.WriteLine("[ERROR] " + _name + " - " + msg); }
}
public class Program
{
public static void Main(string[] args)
{
ILogger log = new ConsoleLogger("Checkout");
log.Info("Start");
log.Warn("Slow network");
log.Error("Payment failed");
}
}
上下文与时间戳
添加少量上下文(key=value)和 UTC 时间戳,以便阅读日志时更容易进行关联。
using System;
// Add a timestamp and tiny key=value context.
public interface ILogger
{
void Info(string msg, string contextKey, string contextValue);
}
public class ConsoleLogger : ILogger
{
private readonly string _name;
public ConsoleLogger(string name) { _name = name; }
public void Info(string msg, string key, string value)
{
string stamp = DateTime.UtcNow.ToString("u"); // 2009-06-15 13:45:30Z
Console.WriteLine(stamp + " [INFO] " + _name + " " + key + "=" + value + " :: " + msg);
}
}
public class Program
{
public static void Main(string[] args)
{
ILogger log = new ConsoleLogger("Search");
log.Info("Query executed", "q", "apple");
log.Info("Cache miss", "userId", "42");
}
}
提示与规范
提示:
- 选择少量级别(Info/Warn/Error)
- 至少为调试/跟踪添加一个侦听器
- 保持消息简短;添加少量上下文键值对
- 不要记录机密信息
为什么需要日志记录抽象
回顾
回顾:使用带侦听器的调试/跟踪来查看输出,并通过小型日志记录器接口封装调用,这样无需修改业务代码即可更换接收端。
常见问题解答
「日志抽象与 Debug/Trace」课时是免费的吗?
是的 — 「日志抽象与 Debug/Trace」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 C# Academy 课程的其余内容,请升级到 CoddyKit PRO。 C# Academy 课程共包含 3 节课。
「日志抽象与 Debug/Trace」这节课中我会学到什么?
使用 System.Diagnostics 中的 Debug/Trace,添加侦听器,并创建类似 ILogger 的小型抽象,将应用代码与日志接收端解耦。 你通过在浏览器中直接运行的动手代码来练习 C# Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 C# Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 C# Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 3 节。
「日志抽象与 Debug/Trace」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 C# Academy 课中编写并运行代码吗?
能。每节 C# Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 日志抽象与 Debug/Trace
- 基础性能分析与跟踪(概念)
- 保护与验证模式