使用C#的Conditional特性與Unity編輯器宏指令做條件編譯

概要

在傳統的C#項目中，用Conditional特性做條件編譯時，需要在Visual Studio中項目的屬性裡添加上條件編譯符号，用法參考這篇文章。

而在Unity項目中，條件編譯符号需要在Unity Editor編輯器中添加。

為什麼要用條件編譯

Unity中最常見的使用條件編譯的情況就是分平台編譯不同的代碼片段。由于Unity是跨平台的，不同平台有不同的特性，我們經常能見到 #if...#endif 來做條件編譯的代碼塊。

另一種常見用法是，例如在編輯器下運作時輸出日志，而在打包真機調試時為了節省性能需要關閉日志（在Update()函數中每幀輸出日志很耗性能）。此時可以把輸出日志的函數使用Conditional特性來标記上，隻有在Unity編輯器中開啟了指定的宏指令，這個輸出日志的函數才能被編譯，即可很友善地開關日志。

例子

namespace UnityEngine
{
    public static class DebugExtension
    {
        [Conditional("EnableLog")]
        public static void Logger(this object obj, string message)
        {
            Debug.Log(message);
        }
   }
}      

上面的代碼中，通過C#的擴充方法，給所有的System.Object類添加了一個Logger()方法，該方法被标記為[Conditional("EnableLog")]。需要在Unity編輯器中添加上EnableLog宏指令，該方法才能被編譯。

Unity編輯器添加宏指令在File - Build Settings - Player Settings - Other Settings中，如下圖。

輸入了EnableLog後，上面的Logger()方法才能被編譯。如果去掉EnableLog，所有調用了Logger()函數的代碼也不會被編譯！

this.Logger("日志擴充類中的方法。該方法需要在Unity編輯器中添加宏指令EnableLog才能被編譯！");