在 Release 版本禁用 NSLog 函数

NSLog()函数在 Release 版本的影响

What will happen to NSLog statements in production?

资源消耗

在Xcode中开发时,往往需要利用NSLog()函数来打印一些调试信息。打印这些调试信息会消耗一定的系统资源,因为模拟器使用的是电脑的硬件,所以在运行应用时不会有什么影响,但如果在真实的移动设备上也打印大量的调试信息,会在很大程度上影响应用的性能。所以发布应用的正式版时,应屏蔽调试信息。

文档 Technical Note TN2347: Basic debugging using logging for Swift and Objective-C apps. 中有如下的相关描述:

Note: NSLog can take time to execute and this will add additional overhead to the runtime of your application (especially if you add lots and lots of NSLog statements to your app). During testing, this normally isn't a problem. But, for your final shipping product, it is better to remove all of the logging so your customers can enjoy faster performance without the logging going on. Because of this, it is a common practice among developers to use the DEBUG preprocessor macro to conditionally compile your logging code so that it only appears in your debug builds (and does not ship to your final customers).

那么在真机中NSLog()函数具体是执行哪些操作从而耗费一部分资源呢,NSLog 函数的文档指出,该函数会将错误信息记录到 Apple System Log facility。

NSLog outputs messages to the Apple System Log facility or to the Console app (usually prefixed with the time and the process id).

通过文档 iOS Debugging Magic 中 Basics -> Seeing Debug Output 部分的描述得知,NSLog()函数会将日志打印到 stderr,如果在真机上运行日志信息会重定向到 system.log,system.log 保存在 /var/log/system.log 文件中。

If you launch a GUI application as it would be launched by a normal user, the system redirects any messages printed on stderr to the system log. You can view these messages using the techniques described earlier.

所以NSLog()函数是 Apple System Log(后面简称ASL)的封装,NSLog 会向 ASL 写 log,同时向 Terminal 写 log,而且同时会出现在 Console.app 中(Mac自带软件,用NSLog打出的log在其中全部可见);不仅如此,每一次NSLog 都会新建一个 ASL client 并向 ASL 守护进程发起连接,log 之后再关闭连接。所以说,当这个过程出现 N 次时,消耗大量资源导致程序变慢也就不奇怪了。

安全

NSLog()函数输出的信息还有可能暴露应用的一些保密数据,通过 Xcode 中的设备选项打开控制台可查看真机的日志输出,而且其输出的日志信息并不在应用的沙盒内,导致可以被其他应用获取到。

On the iPhone, data passed to the NSLog function is logged by Apple System Log (ASL) and the data remains on the log until the device is rebooted. Also, Error logs are not bounded by the application sandbox. Which means error logs generated by one application can be read by other applications. Therefore, if an application logs sensitive data, a malicious application can actively query for this data and send it to a remote server.
Error logs on the iPhone can be viewed directly using Console app. The Console app is available in the AppStore. Error logs can also be viewed using iPhone configuration utility or by syncing the device with iTunes and looking at CrashReporter folder

禁用NSLog()函数

针对以上问题,我们可以在预编译文件Prefix.pch中写一些宏来控制

#ifdef DEBUG
//__VA_ARGS__代表可变参数宏
#define DebugLog(format, ...) NSLog(format, ##__VA_ARGS__)
#else
#define DebugLog(format, ...)
#endif

这样,当只想在Debug版本中记录调试信息,可以使用DebugLog()函数。如果想在所有版本中都记录调试信息可以直接使用NSLog()函数。
PS:如果想全局替换NSLog()函数,可以在终端输入命令$ sed -i ".bak" 's/NSLog/DebugLog/' *.m,另外也可以直接在Xcode中全局替换。

如果不想使用NSLog输出的基本信息,也可以自定义输出的基本信息及其格式

// 获取系统当前毫秒级时间
#define logTime ({\
                    struct timeb currentTime;\
                    ftime(&currentTime);\
                    char secondLevelStr[9];\
                    strftime(secondLevelStr, 9, "%H:%M:%S", localtime(&currentTime.time));\
                    char millisecondLevelStr[13];\
                    sprintf(millisecondLevelStr, "%s.%03d", secondLevelStr, currentTime.millitm);\
                    millisecondLevelStr;\
                })

#ifdef DEBUG
#define DebugLog(format, ...) fprintf(stderr, "%s %s[%d] %s\n", logTime, [[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], __LINE__, [[NSString stringWithFormat:format, ##__VA_ARGS__] UTF8String])
#else
#define DebugLog(format, ...)
#endif
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,506评论 25 707
  • 因为要结局swift3.0中引用snapKit的问题,看到一篇介绍Xcode8,swift3变化的文章,觉得很详细...
    uniapp阅读 4,391评论 0 12
  • WebSocket-Swift Starscream的使用 WebSocket 是 HTML5 一种新的协议。它实...
    香橙柚子阅读 23,724评论 8 183
  • 结构性思维。这一节是写如何(找)它的结构。 在这个结构中,书中给出了一个关键词——强调复杂性。这样一比对你就知道了...
    aabebw阅读 593评论 0 0