[C#6] 2-nameof 運算子

標籤：

0. 目錄

C#6 新增特性目錄

1. 老版本的代碼

 1 using  System; 2 namespace csharp6 3 { 4     internal class Program 5     { 6         private static void Main(string[] args) 7         { 8             if (args==null) 9             {10                 throw new ArgumentNullException("args");11             }12         }13     }14 }

這段代碼並沒什麼問題，運行良好。隨著時間的推移，有一天，我覺得args這個參數名不合適，想改一個更直觀的名字filePaths,表示我要接受一個檔案路徑的數組。然後我們就直接把args這個名字給重構了，but,把 throw new ArgumentNullException("args"); 給忘了（resharper重構可能會同時重構這個名字），因為它僅僅是個字串，書寫的時候容易拼錯，重構的時候也無法對它進行一個是否需要重構的分析，導致一些麻煩事情。

那麼nameof運算子的目的就是來解決這個問題的。

1. nameof 運算子

nameof是C#6新增的一個關鍵字運算子，主要作用是方便擷取類型、成員和變數的簡單字串名稱（非完全限定名），意義在於避免我們在代碼中寫下固定的一些字串，這些固定的字串在後續維護代碼時是一個很繁瑣的事情。比如上面的代碼改寫後：

 1 using  System; 2 namespace csharp6 3 { 4     internal class Program 5     { 6         private static void Main(string[] args) 7         { 8             if (args==null) 9             {10                 throw new ArgumentNullException(nameof(args));11             }12         }13     }14 }

我們把固定的 "args" 替換成等價的 nameof(args) 。按照慣例，貼出來兩種方式的代碼的IL。

"args"方式的IL代碼：

 1 .method private hidebysig static void  Main(string[] args) cil managed 2 { 3   .entrypoint 4   // Code size       22 (0x16) 5   .maxstack  2 6   .locals init ([0] bool V_0) 7   IL_0000:  nop 8   IL_0001:  ldarg.0 9   IL_0002:  ldnull10   IL_0003:  ceq11   IL_0005:  stloc.012   IL_0006:  ldloc.013   IL_0007:  brfalse.s  IL_001514   IL_0009:  nop15   IL_000a:  ldstr      "args"16   IL_000f:  newobj     instance void [mscorlib]System.ArgumentNullException::.ctor(string)17   IL_0014:  throw18   IL_0015:  ret19 } // end of method Program::Main

nameof(args)方式的IL代碼：

 1 .method private hidebysig static void  Main(string[] args) cil managed 2 { 3   .entrypoint 4   // Code size       22 (0x16) 5   .maxstack  2 6   .locals init ([0] bool V_0) 7   IL_0000:  nop 8   IL_0001:  ldarg.0 9   IL_0002:  ldnull10   IL_0003:  ceq11   IL_0005:  stloc.012   IL_0006:  ldloc.013   IL_0007:  brfalse.s  IL_001514   IL_0009:  nop15   IL_000a:  ldstr      "args"16   IL_000f:  newobj     instance void [mscorlib]System.ArgumentNullException::.ctor(string)17   IL_0014:  throw18   IL_0015:  ret19 } // end of method Program::Main

一樣一樣的，我是沒看出來有任何的差異，，，so，這個運算子也是一個編譯器層面提供的文法糖，編譯後就沒有nameof的影子了。

2. nameof 注意事項

nameof可以用於擷取具名運算式的當前名字的簡單字串表示（非完全限定名）。注意當前名字這個限定，比如下面這個例子，你覺得會輸出什麼結果？

 1 using static System.Console; 2 using CC = System.ConsoleColor; 3  4 namespace csharp6 5 { 6     internal class Program 7     { 8         private static void Main() 9         {10             WriteLine(nameof(CC));//CC11             WriteLine(nameof(System.ConsoleColor));//ConsoleColor12         }13     }14 }

第一個語句輸出"CC"，因為它是當前的名字，雖然是指向System.ConsoleColor枚舉的別名，但是由於CC是當前的名字，那麼nameof運算子的結果就是"CC"。

第二個語句輸出了"ConsoleColor",因為它是System.ConsoleColor的簡單字串表示，而非取得它的完全限定名，如果想取得"System.ConsoleColor"，那麼請使用 typeof(System.ConsoleColor).FullName 。再比如微軟給的例子： nameof(person.Address.ZipCode) ，結果是"ZipCode"。

3. 參考

C#語言參考-運算子：nameof

[C#6] 2-nameof 運算子