c# - 条件属性如何工作？

Question

我有一些用 [Conditional("XXX")] 标记的辅助方法。目的是在仅存在 XXX 条件编译符号时使方法有条件地编译。我们将它用于调试和跟踪功能，它运行良好。

在我研究条件编译如何工作的过程中，我发现有几个来源指出带有 Conditional 属性标记的方法将被放置在 IL 中，但不会执行对这些方法的调用。

代码如何编译成 IL 但不执行？我如何验证行为是否确实如描述的那样？我在 IL 方面做得不多，所以我在这方面的技能并不薄弱。

Answer 1

这是由编译器控制的。所有方法都带有 [Conditional]仍将包含在 MSIL 中，但会包含一个 .custom instance详细说明 [Conditional] 的行.在方法调用者的编译时，编译器会进行词法分析，然后进行语义分析和重载解析，并找到 .custom instance IL 在你放置的方法中 [Conditional]在。因此它不会编译调用。

因此:编译器编译目标方法，但不编译任何对该方法的调用。注意:该方法仍然存在，您仍然可以通过反射调用它。参见 the spec

Calls to a conditional method are either included or omitted depending on whether this symbol is defined at the point of the call. If the symbol is defined, the call is included; otherwise, the call (including evaluation of the receiver and parameters of the call) is omitted.

如何验证？启动开发人员命令提示符，键入 ildasm <enter>并打开相关的 dll/exe。查看来电和被叫[Conditional]方法。你会看到被调用的方法有额外的 IL 和 .custom instance , 并且在您期望的地方省略了来电线路。使用以下代码在控制台应用程序上尝试。

为什么？在某些情况下，它使条件调用比使用 #if 更简单。 .参见 Eric Lippert: What's the difference between conditional compilation and the conditional attribute?

class Program
{
    static void Main(string[] args)
    {
        AlwaysEmit();
        DebugEmit();
        VerboseEmit();
    }

    public static void AlwaysEmit()
    {
        Console.WriteLine("Beam me up");
    }

    [Conditional("DEBUG")]
    public static void DebugEmit()
    {
        Console.WriteLine("Kirk out");
    }

    [Conditional("VERBOSE")]
    public static void VerboseEmit()
    {
        Console.WriteLine("Say that again?");
    }
}

并且在相应的 MSIL 中，VerboseEmit包含在内，但未从 Main 调用:

.method private hidebysig static void  Main(string[] args) cil managed
{
  .entrypoint
  // Code size       14 (0xe)
  .maxstack  8
  IL_0000:  nop
  IL_0001:  call       void RateScope.SdrApi.UploaderConsoleApp.Program::AlwaysEmit()
  IL_0006:  nop
  IL_0007:  call       void RateScope.SdrApi.UploaderConsoleApp.Program::DebugEmit()
  IL_000c:  nop
  IL_000d:  ret
} // end of method Program::Main

...

.method public hidebysig static void  VerboseEmit() cil managed
{
  .custom instance void [mscorlib]System.Diagnostics.ConditionalAttribute::.ctor(string)
     = ( 01 00 07 56 45 52 42 4F 53 45 00 00 ) // ...VERBOSE..
  // Code size       13 (0xd)
  .maxstack  8
  IL_0000:  nop
  IL_0001:  ldstr      "Say that again\?"
  IL_0006:  call       void [mscorlib]System.Console::WriteLine(string)
  IL_000b:  nop
  IL_000c:  ret
} // end of method Program::VerboseEmit

奖励积分。查看控制台输出和 MSIL(相应地修改 Emit 方法):

static void Main(string[] args)
{
    int callCount = 0;
    AlwaysEmit(++callCount);
    VerboseEmit(++callCount);
    DebugEmit(++callCount);
    Console.WriteLine("Call count = " + callCount);
    Console.ReadLine();
}