NSLog使用详解与性能分析

NSLog 使用

在XCode做开发调试时往往需要打印一些调试信息做debug用

NSLog 性能问题

它的运行会占用时间和设备资源。当打印信息的地方多了之后在模拟器上跑可能不会有什么问题，因为模拟器用的是电脑的硬件，但是当应用跑在设备上时这些输出语句会在很大程度上影响应用的性能，而且输出的数据也可能会暴露出App里的保密数据，所以发布正式版时需要把这些输出全部屏蔽掉，针对这种问题可以写一些宏来控制这些调试信息的输出。

解决方案：

简单粗暴的解决方案：在APP release前，将所有的NSLog注释掉，简单有效，但副作用是：下次你要调试时，又得将NSLog一个个取消注释。

正确的解决方案：你以release模式编译的程序不会用NSLog输出，而你以debug模式编译的程序将执行NSLog的全部功能。在release版本禁止输出NSLog内容。

如何实现？

在 xxx.pch (预编译文件) 中添加以下代码：

//用宏指令做一个判断，如果DEBUG为真，则编译#ifdef到#endif宏定义，否则编译器就不编译；
#ifdef DEBUG
#define NSLog(...) NSLog(__VA_ARGS__)
#define debugMethod() NSLog(@"%s", __func__)
#else
#define NSLog(...)
#define debugMethod()
#endif

设置DEBUG

在 “Target > Build Settings > Preprocessor Macros > Debug” 里有一个”DEBUG=1”。

设置为Debug模式下，点击Product –> Scheme –> Edit Scheme

设置run –> info –> Build Configuration成Debug时，就可以打印nslog了。

设置Release，发布app版本的时候就不会打印了，提高了性能。

如何自定义输入

在 xxx.pch 中添加以下代码：

#ifdef DEBUG
#define NSLog(format, ...) fprintf(stderr, "class：%s \nline： %d \nmethod：%s \nmessage：%s \n%s \n",[[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String],__LINE__, __func__,[[NSString stringWithFormat:format, ##__VA_ARGS__] UTF8String], [@"----------------------------------------------" UTF8String]);
#else
#define NSLog(format, ...)
#endif

可以根据个人需要调整上面代码，主要就是这几个宏 ##__VA_ARGS , \FILE , \LINE 和\FUNCTION__。

1) __VA_ARGS__ 是一个可变参数的宏，很少人知道这个宏，这个可变参数的宏是新的C99规范中新增的，目前似乎只有gcc支持（VC6.0的编译器不支持）。宏前面加上##的作用在于，当可变参数的个数为0时，这里的##起到把前面多余的","去掉的作用,否则会编译出错, 你可以试试。
2) __FILE__ 宏在预编译时会替换成当前的源文件名
3) __LINE__宏在预编译时会替换成当前的行号
4) __FUNCTION__宏在预编译时会替换成当前的函数名称
5) __func__ 打印当前函数或方法，c字符串

将Log日志重定向输出到文件

对于真机，日志没法保存，不好分析问题。所以有必要将日志保存到应用的Docunment目录下，并设置成共享文件，这样才能取出分析。

首先是日志输出，分为c的printf和标准的NSLog输出，printf会向标准输出(sedout)打印，而NSLog则是向标准出错(stderr)，我们需要同时让他们都将日志打印到一个文件中。

1
2
3

//例子：
freopen("xx.log","a+",stdout);
freopen("xx.log","a+",stderr);

具体做法：

// 将NSlog打印信息保存到Document目录下的文件中
- (void)redirectNSlogToDocumentFolder
{    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
    NSString *documentDirectory = [paths objectAtIndex:0];
    NSString *logFilePath = [documentDirectory stringByAppendingPathComponent:@"log.txt"];

    // 先删除已经存在的文件
    NSFileManager *defaultManager = [NSFileManager defaultManager];
    [defaultManager removeItemAtPath:logFilePath error:nil];

    // 将log输入到文件
    freopen([logFilePath cStringUsingEncoding:NSASCIIStringEncoding], "a+", stdout);
    freopen([logFilePath cStringUsingEncoding:NSASCIIStringEncoding], "a+", stderr);
}

此函数要在- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions中调用。

当连接Mac调试的时候把这些注释掉，否则log只会输入到文件中，而不能从xcode的监视器中看到。

最后配置共享文件夹：

在应用程序的Info.plist文件中添加UIFileSharingEnabled键（Application supports iTunes file sharing 键），并将键值设置为YES。将您希望共享的文件放在应用程序的 Documents目录。一旦设备插入到用户计算机，iTunes 9.1就会在选中设备的Apps标签中找到自己的应用，查看共享内容，找到 log.txt 文件。

断言NSAssert()的使用

NSAssert()只是一个宏，用于开发阶段调试程序中的Bug，通过为NSAssert()传递条件表达式来断定是否属于Bug，满足条件返回真值，程序继续运行，如果返回假值，则抛出异常，并切可以自定义异常描述。NSAssert()是这样定义的：

1	#define NSAssert(condition, desc)

condition是条件表达式，值为YES或NO；desc为异常描述，通常为NSString。当conditon为YES时程序继续运行，为NO时，则抛出带有desc描述的异常信息。NSAssert()可以出现在程序的任何一个位置。具体事例如下：

生成一个LotteryEntry对象时，传入的NSDate不能为nil，加入NSAssert()判断。对象初始化源码如下：

- (id)initWithEntryDate:(NSDate *)theDate {    self = [super init];
    if (self) {        NSAssert(theDate != nil, @"Argument must be non-nil");
        entryDate = theDate;
        firstNumber = (int)random() % 100 + 1;
        secondNumber = (int)random() % 100 + 1;
    }
    return  self;
}

接下来则是生成对象时传入一个值为nil的NSDate，看断言是否运行。

LotteryEntry *nilEntry = [[LotteryEntry alloc] initWithEntryDate:nil];

断言效果如下：

2013-01-17 20:49:12.486 lottery[3951:303] *** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'Argument must be non-nil'

*** First throw call stack:
(
0   CoreFoundation                      0x00007fff90c590a6 __exceptionPreprocess + 198
1   libobjc.A.dylib                     0x00007fff8fd2a3f0 objc_exception_throw + 43
2   CoreFoundation                      0x00007fff90c58ee8 +[NSException raise:format:arguments:] + 104
3   Foundation                          0x00007fff88dae6a2 -[NSAssertionHandler handleFailureInMethod:object:file:lineNumber:description:] + 189
4   lottery                             0x0000000100001929 -[LotteryEntry initWithEntryDate:] + 249
5   lottery                             0x0000000100001794 main + 932
6   libdyld.dylib                       0x00007fff8d83f7e1 start + 0
)
libc++abi.dylib: terminate called throwing an exception

移除NSAssert比较简单，我们需要在target中选择build settings, 找到 preprocessor macros(预处理宏）项目，配置它的release为 NS_BLOCK_ASSERTIONS。

具体操作步骤为：双击release的空白处，此时会弹出对话框，点击对话框中的＋添加NS_BLOCK_ASSERTIONS。