对于 C# 日志记录，如何以最小的开销获取调用堆栈深度
本文关键字：开销 获取 调用 深度 堆栈 日志 记录 对于 | 更新日期: 2023-09-27 17:56:38
我已经为 Log4net 创建了一个包装器（我可能会放弃它以支持 NLog;我还没有决定），我缩进记录的消息结果以给出调用结构的想法。例如：
2011-04-03 00:20:30,271 [CT] DEBUG - Merlinia.ProcessManager.CentralThread.ProcessAdminCommand - ProcStart - User Info Repository
2011-04-03 00:20:30,271 [CT] DEBUG - Merlinia.ProcessManager.CentralThread.StartOneProcess - User Info Repository
2011-04-03 00:20:30,411 [CT] DEBUG - Merlinia.ProcessManager.CentralThread.SetProcessStatus - Process = User Info Repository, status = ProcStarting
2011-04-03 00:20:30,411 [CT] DEBUG - Merlinia.ProcessManager.CentralThread.SendProcessStatusInfo
2011-04-03 00:20:30,411 [CT] DEBUG - Merlinia.CommonClasses.MhlAdminLayer.SendToAllAdministrators - ProcessTable
2011-04-03 00:20:30,411 [CT] DEBUG - Merlinia.CommonClasses.MReflection.CopyToBinary
2011-04-03 00:20:30,411 [CT] DEBUG - Merlinia.CommonClasses.MReflection.CopyToBinary - False
2011-04-03 00:20:30,411 [CT] DEBUG - Merlinia.CommonClasses.MhlBasicLayer.SendToAllConnections - 228 - True - False
2011-04-03 00:20:30,411 [CT] DEBUG - Merlinia.CommonClasses.MmlNonThreaded.SendObject - 228
2011-04-03 00:20:30,411 [CT] DEBUG - Merlinia.CommonClasses.MllTcpSocket.SendMessage - 228 - True
2011-04-03 00:20:32,174 [10] DEBUG - Merlinia.CommonClasses.MReflection.CreateFromBinary
2011-04-03 00:20:32,174 [10] DEBUG - Merlinia.CommonClasses.MReflection.CopyFromBinary - Bytes = 71
2011-04-03 00:20:32,174 [CT] DEBUG - Merlinia.ProcessManager.CentralThread.MessagingCallback - User Info Repository - ProcessInfoAndRequests
2011-04-03 00:20:32,174 [CT] DEBUG - Merlinia.ProcessManager.CentralThread.ProcessProcessInfoAndRequests - User Info Repository
我使用 System.Diagnostics.StackTrace 和计数 StackFrames 来执行此操作。
现在的问题是：有没有更有效的方法呢？我只需要确定（相对）调用堆栈深度，即当前深度是否加上或减去上次调用我的日志记录包装器时的深度。（请注意，我实际上并没有使用 StackFrame 对象 - 否则我会得到方法名称。
我希望有一些简单的高性能方法来查询调用堆栈深度或堆栈使用情况。
只需使用 StackTrace.FrameCount 属性，并将其与之前记录的FrameCount进行比较。仅供参考，FrameCount可能是检索实际帧数的最快方法，因为它只将内部m_iNumOfFrames字段返回给您。
经过六年半的可靠服务，我突然发现我的许多程序在 2017 年底崩溃，因为应用了 Microsoft 的更新，其中包括对 .Net Framework 4.5 的更改。这就是编写依赖于mscorlib.dll中内部未记录数据结构的代码所得到的。
这个版本的代码再次工作，并且还被设计为在面对未来可能对 mscorlib 的更新时稍微健壮一些.dll - 希望它只是优雅地失败并且总是返回零。但是仍然不能保证将来对 mscorlib 进行更改.dll从而导致此代码将来崩溃。
/// <summary>
/// This test program demonstrates a faster way of getting call stack depth by avoiding getting a
/// StackTrace object. But you can't get the calling method names this way.
///
/// See http://stackoverflow.com/questions/5999177/for-c-logging-how-to-obtain-call-stack-depth-with-minimal-overhead
/// and http://ayende.com/blog/3879/reducing-the-cost-of-getting-a-stack-trace
///
/// Update, late 2017, .Net mscorlib.dll has been changed for .Net 4.5. In the code below the two
/// possibilities are called "old .Net" and "new .Net". The two versions can be tested by setting
/// the target for this project to either .Net Framework 2.0 or .Net Framework 4.5.
/// </summary>
class TestProgram
{
static void Main()
{
OneTimeSetup();
int i = GetCallStackDepth(); // i = 10 on my test machine for old .Net, 12 for new .Net
int j = AddOneToNesting();
Console.WriteLine(j == i + 1 ? "Test succeeded!" : "Test failed!!!!!!!!");
Console.ReadKey();
}
private delegate object DGetStackFrameHelper();
private static DGetStackFrameHelper _getStackFrameHelper = null;
private static FieldInfo _frameCount = null;
private static void OneTimeSetup()
{
try
{
Type stackFrameHelperType =
typeof(object).Assembly.GetType("System.Diagnostics.StackFrameHelper");
// ReSharper disable once PossibleNullReferenceException
MethodInfo getStackFramesInternal =
Type.GetType("System.Diagnostics.StackTrace, mscorlib").GetMethod(
"GetStackFramesInternal", BindingFlags.Static | BindingFlags.NonPublic);
if (getStackFramesInternal == null)
return; // Unknown mscorlib implementation
DynamicMethod dynamicMethod = new DynamicMethod(
"GetStackFrameHelper", typeof(object), new Type[0], typeof(StackTrace), true);
ILGenerator generator = dynamicMethod.GetILGenerator();
generator.DeclareLocal(stackFrameHelperType);
bool newDotNet = false;
ConstructorInfo constructorInfo =
stackFrameHelperType.GetConstructor(new Type[] {typeof(bool), typeof(Thread)});
if (constructorInfo != null)
generator.Emit(OpCodes.Ldc_I4_0);
else
{
constructorInfo = stackFrameHelperType.GetConstructor(new Type[] {typeof(Thread)});
if (constructorInfo == null)
return; // Unknown mscorlib implementation
newDotNet = true;
}
generator.Emit(OpCodes.Ldnull);
generator.Emit(OpCodes.Newobj, constructorInfo);
generator.Emit(OpCodes.Stloc_0);
generator.Emit(OpCodes.Ldloc_0);
generator.Emit(OpCodes.Ldc_I4_0);
if (newDotNet)
generator.Emit(OpCodes.Ldc_I4_0); // Extra parameter
generator.Emit(OpCodes.Ldnull);
generator.Emit(OpCodes.Call, getStackFramesInternal);
generator.Emit(OpCodes.Ldloc_0);
generator.Emit(OpCodes.Ret);
_getStackFrameHelper =
(DGetStackFrameHelper) dynamicMethod.CreateDelegate(typeof(DGetStackFrameHelper));
_frameCount = stackFrameHelperType.GetField("iFrameCount",
BindingFlags.NonPublic | BindingFlags.Instance);
}
catch
{} // _frameCount remains null, indicating unknown mscorlib implementation
}
private static int GetCallStackDepth()
{
if (_frameCount == null)
return 0; // Unknown mscorlib implementation
return (int)_frameCount.GetValue(_getStackFrameHelper());
}
private static int AddOneToNesting()
{
return GetCallStackDepth();
}
}
感谢Teoman Soygul，特别是Oren Eini，他的博客Teoman提供了一个链接。
以下是一些我认为是我将使用的解决方案的"概念验证"代码 - 尽管我必须承认我没有做任何时序测试。
class TestProgram
{
static void Main(string[] args)
{
OneTimeSetup();
int i = GetCallStackDepth(); // i = 10 on my test machine
i = AddOneToNesting(); // Now i = 11
}
private delegate object DGetStackFrameHelper();
private static DGetStackFrameHelper _getStackFrameHelper;
private static FieldInfo _frameCount;
private static void OneTimeSetup()
{
Type stackFrameHelperType =
typeof(object).Assembly.GetType("System.Diagnostics.StackFrameHelper");
MethodInfo getStackFramesInternal =
Type.GetType("System.Diagnostics.StackTrace, mscorlib").GetMethod(
"GetStackFramesInternal", BindingFlags.Static | BindingFlags.NonPublic);
DynamicMethod dynamicMethod = new DynamicMethod(
"GetStackFrameHelper", typeof(object), new Type[0], typeof(StackTrace), true);
ILGenerator generator = dynamicMethod.GetILGenerator();
generator.DeclareLocal(stackFrameHelperType);
generator.Emit(OpCodes.Ldc_I4_0);
generator.Emit(OpCodes.Ldnull);
generator.Emit(OpCodes.Newobj,
stackFrameHelperType.GetConstructor(new Type[] { typeof(bool), typeof(Thread) }));
generator.Emit(OpCodes.Stloc_0);
generator.Emit(OpCodes.Ldloc_0);
generator.Emit(OpCodes.Ldc_I4_0);
generator.Emit(OpCodes.Ldnull);
generator.Emit(OpCodes.Call, getStackFramesInternal);
generator.Emit(OpCodes.Ldloc_0);
generator.Emit(OpCodes.Ret);
_getStackFrameHelper =
(DGetStackFrameHelper)dynamicMethod.CreateDelegate(typeof(DGetStackFrameHelper));
_frameCount = stackFrameHelperType.GetField(
"iFrameCount", BindingFlags.NonPublic | BindingFlags.Instance);
}
private static int GetCallStackDepth()
{
return (int)_frameCount.GetValue(_getStackFrameHelper());
}
private static int AddOneToNesting()
{
return GetCallStackDepth();
}
}
编辑：在2017年底更新mscorlib.dll后，此版本不适用于.Net Framework 4.5 Microsoft。请参阅我为较新版本发布的另一个答案。（为了后代，我留下了这个答案 - 它仍然适用于 .Net Framework 2.0 和 3.5。
Environment.StackTrace.Split（Environment.NewLine）.长度
如果您递归到相同的方法并且只是想知道您在当前方法中的深度，我正在使用这种检查，尽管它可能对性能不是很好。我想new StackTrace()可以存放在某个地方以避免每次娱乐，但就我而言，这并不重要，所以我像这样使用它：
var callDepth = new StackTrace().GetFrames().Count(_ => _.GetMethod().Name == nameof(CallingMethod))
只需将CallingMethod替换为方法的名称即可