直接寫 NSLog 有個麻煩:除錯用的日誌會一起被編進正式版,不僅污染 Console,也有輕微的效能損耗,甚至可能洩露內部資訊。理想的狀態是——Debug 時正常輸出,Release 時自動抹除。
這件事靠巨集就能解決,做法如下。
利用 __OPTIMIZE__ 這個由編譯器在 Release 組態下自動定義的旗標來分流:
// Release 時不輸出任何日誌
#ifndef __OPTIMIZE__
#define NSLog(...) NSLog(__VA_ARGS__)
#else
#define NSLog(...) {}
#endif
如果你不想覆蓋系統的 NSLog,改成自訂名稱更安全:
#ifndef __OPTIMIZE__
#define DLog(...) NSLog(__VA_ARGS__)
#else
#define DLog(...) {}
#endif
// 需要強制輸出的日誌可以另外定義一個
#define ALog(...) NSLog(__VA_ARGS__)
兩種寫法的差別在於:第一種直接把 NSLog 重新定義掉,全專案自動生效,缺點是連第三方程式庫的日誌都會被吞掉;第二種保留系統 NSLog,由你自己決定哪些地方改用 DLog,控制權更高。
在專案的 appName-Prefix.pch 中引入這個標頭檔,讓它對所有檔案生效:
#import <UIKit/UIKit.h>
#ifndef __IPHONE_3_0
#warning "This project uses features only available in iPhone SDK 3.0 and later."
#endif
#ifdef __OBJC__
#import <UIKit/UIKit.h>
#import <Foundation/Foundation.h>
#import "DLog.h"
#endif
設定完成後,Debug 組態下 DLog、ALog 與系統 NSLog 都能正常輸出;切換到 Release 編譯時,DLog 會被展開成空,日誌自然消失。切換 Build Configuration 就能實際感受到差異。