C# record循环引用导致调试悬停变量触发栈溢出终止调试会话
问题场景
- 基于C# record类型编写的单元测试可正常完成全流程执行
- 调试状态下,在测试方法的断言行设置断点,将鼠标悬停在record类型变量上时,调试会话直接终止,弹出样式异常的错误提示
- 已编写无业务冗余的最小复现用例,可稳定触发该问题
最小复现代码
#nullable enable using Microsoft.VisualStudio.TestTools.UnitTesting; namespace CSharpRecordTest { record Twin(string Name) { public Twin? OtherTwin { get; set; } } [TestClass] public class UnitTest1 { [TestMethod] public void TestMethod1() { var twinA = new Twin("A"); var twinB = new Twin("B"); twinA.OtherTwin = twinB; twinB.OtherTwin = twinA; Assert.AreEqual(twinA, twinA.OtherTwin.OtherTwin); } } }
问题成因
该问题是C# record的默认生成逻辑与调试器预览机制叠加后,触发无保护递归导致的栈溢出崩溃:
- C# record类型会自动重写
ToString()方法,按照类型名(属性1=值1, 属性2=值2...)的格式,递归遍历所有公共属性拼接生成字符串 - 用例中的
Twinrecord存在双向循环引用结构:twinA指向twinB、twinB反向指向twinA,形成无出口的引用环 - 调试器在变量悬停预览时,默认会调用对象的
ToString()方法生成展示内容;由于record自动生成的ToString()未对循环引用做中断保护,递归调用会持续耗尽栈内存,最终导致调试托管进程直接崩溃、会话终止
可行的规避方案
- 手动重写存在循环引用的record的
ToString()方法,切断默认的递归拼接逻辑,可仅输出对象标识、自身属性值,不对嵌套关联对象做递归展开 - 对存在循环引用的类型添加
[DebuggerDisplay]特性,自定义调试预览的展示规则,替代调试器默认调用ToString()的预览逻辑 - 从设计层面调整record的属性结构,将会形成循环引用的关联属性设为非公共属性,避免被record自动生成的
ToString()逻辑递归访问
内容的提问来源于stack exchange,提问作者Peter Huber
相关产品推荐
相关产品推荐

