为MIPS组件的Instruction结构体添加DebugDisplayAttribute并规避循环依赖

核心矛盾是要在Debug模式下让Instruction借助反汇编器实现调试友好显示，同时保证Release构建时各项目完全独立、无循环依赖。以下是几个实用的落地方案：

1. DebuggerTypeProxyAttribute+调试辅助项目（推荐） #

无需修改Instruction核心定义，将调试显示逻辑剥离到独立的辅助项目，仅在Debug构建时启用：

• 步骤1：新建仅用于Debug的辅助项目（比如Mips.Instruction.DebugProxy），该项目引用基础项目（Mips.Base）和反汇编器项目（Mips.Disassembler），不存在循环依赖（基础项目不主动引用这个辅助项目）。
• 步骤2：在辅助项目中编写调试代理类，实现反汇编逻辑：

  using Mips.Base;
  using Mips.Disassembler;
  
  namespace Mips.Instruction.DebugProxy
  {
      public class InstructionDebugProxy
      {
          private readonly Instruction _instruction;
  
          public InstructionDebugProxy(Instruction instruction)
          {
              _instruction = instruction;
          }
  
          // 调试器会优先显示该属性值，替代结构体默认显示
          public string Disassembly => Disassembler.Disassemble(_instruction);
          
          // 保留原结构体核心字段，方便查看原始数据
          public uint OpCode => _instruction.OpCode;
      }
  }
  

• 步骤3：在基础项目的Instruction结构体上，通过条件编译添加调试代理特性：

  using System.Diagnostics;
  
  namespace Mips.Base
  {
  #if DEBUG
      [DebuggerTypeProxy(typeof(Mips.Instruction.DebugProxy.InstructionDebugProxy))]
  #endif
      public struct Instruction
      {
          public uint OpCode { get; set; }
          // 其他字段...
      }
  }
  

• 步骤4：在基础项目的Debug构建配置中，添加对辅助项目的条件引用（仅Debug模式生效），Release构建时完全切断依赖。

这个方案的优势是：核心项目在Release时完全独立，Debug时通过调试器代理实现友好的反汇编显示，无循环依赖，也不需要依赖注入。

2. Roslyn源代码生成器（编译时解决方案） #

如果希望直接给Instruction添加DebugDisplayAttribute，可以用源代码生成器在Debug构建时动态生成特性：

• 步骤1：新建源代码生成器项目（比如Mips.Instruction.DebugDisplayGenerator），该项目引用基础项目和反汇编器项目，仅在Debug构建时启用生成逻辑。
• 步骤2：生成器在Debug模式下，扫描Instruction结构体（需为partial struct），输出带有DebugDisplay特性的部分结构体定义：

  // 生成器输出的代码示例（仅Debug时生成）
  using System.Diagnostics;
  using Mips.Base;
  
  namespace Mips.Base
  {
      [DebugDisplay("{GetDebugDisplay(),nq}")]
      public partial struct Instruction
      {
          private string GetDebugDisplay()
          {
              return Mips.Disassembler.Disassembler.Disassemble(this);
          }
      }
  }
  

• 步骤3：在基础项目的Debug构建配置中添加对生成器项目的引用，Release时禁用生成器。

这个方案的优势是：调试时Instruction自带DebugDisplayAttribute，调试器直接显示反汇编结果；Release构建时生成器不运行，不会引入任何依赖。

3. 反射+条件编译的轻量方案（快速实现） #

如果不想新增项目，可以在基础项目中通过反射调用反汇编器逻辑，仅在Debug模式下生效：

• 步骤1：在Instruction结构体中添加条件编译的DebugDisplay特性和调试方法：

  using System.Diagnostics;
  using System.Reflection;
  
  namespace Mips.Base
  {
  #if DEBUG
      [DebugDisplay("{GetDebugDisplay(),nq}")]
  #endif
      public struct Instruction
      {
          public uint OpCode { get; set; }
  
  #if DEBUG
          private string GetDebugDisplay()
          {
              try
              {
                  // 反射加载反汇编器程序集，调用反汇编方法
                  var disassemblerAssembly = Assembly.Load("Mips.Disassembler");
                  var disassemblerType = disassemblerAssembly.GetType("Mips.Disassembler.Disassembler");
                  var disassembleMethod = disassemblerType.GetMethod("Disassemble", new[] { typeof(Instruction) });
                  return disassembleMethod.Invoke(null, new object[] { this }) as string;
              }
              catch
              {
                  // 加载失败时显示原始OpCode
                  return $"OpCode: 0x{OpCode:X8}";
              }
          }
  #endif
      }
  }
  

• 步骤2：Debug构建时，确保反汇编器程序集在输出目录中（可通过条件复制文件实现），Release时无需包含该程序集。

这个方案的优势是无需新增项目，代码量小；缺点是反射有轻微性能开销（Debug模式下可忽略），需保证Debug时反汇编器程序集存在。

关于"从其他项目为结构体添加属性"的问题 #

直接从外部项目给已定义的结构体添加属性无法实现，但可以通过两种间接方式达成类似效果：

• 如果Instruction是部分结构体（partial struct），可在另一个项目中编写部分结构体定义并添加属性，但该项目不能引用反汇编器（否则会引入循环依赖），因此实用性不如前面的代理或生成器方案。
• 使用源代码生成器，在编译时动态生成带有属性的部分结构体定义，这是最可靠的方式，不会引入运行时依赖。

内容的提问来源于stack exchange，提问作者Avishai Dernis