iOS开发--调试必备 — NSLog

时间：2023-01-03 04:30:53

对于程序的开发者来说，拥有一手强大的DEBUG能力，那就好比在武侠世界中拥有一种强大的内功心法一样，走到哪里都是大写的牛B。在我们DEBUG的时候，大部分情况都是要查看我们的调试日志的，这些打印日志可以帮我们精确的定位问题的位置。在OC的编程中，我们一般使用NSLog函数来进行一些打印的工作，这大致相当于C语言的printf输出语句。

1.基本使用

NSLog定义在NSObjCRuntime.h中，如下所示：

void NSLog(NSString *format, …);

省略号表示可接收多个参数。

NSLog使用起来和printf是很相似的，都是格式化的输出，不同的是printf需要的格式化字符串是char *类型，而NSLog需要的字符串是NSString型。

NSLog中会使用到的格式化占位符：

  1. %@ 对象
  2. %d, %i 整数
  3. %u 无符整形
  4. %f 浮点/双字
  5. %x, %X 二进制整数
  6. %o 八进制整数
  7. %zu size_t
  8. %p 指针
  9. %e 浮点/双字 （科学计算）
  10. %g 浮点/双字
  11. %s C字符串
  12. %.*s Pascal字符串
  13. %c 字符
  14. %C unichar
  15. %lld 64位长整数（long long）
  16. %llu 无符64位长整数
  17. %Lf 64位双字

示例：

  1. // 直接打印字符串
  2. NSLog(@"this is a string");
  3. // 打印OC对象
  4. NSString *string = @"hello world";
  5. NSLog(@"%@", string);
  6. // 打印基本数据类型
  7. NSLog(@"int : %d, float : %f", 2, 3.14);

iOS开发--调试必备 — NSLog

2. description 方法

通过上面的例子我们不难发现在NSLog中使用%@占位符来打印对象的功能是非常强大的，它不仅可以打印字符串、字典、数组等OC中已经定义的对象类型，我们自定义的对象类型也可以使用%@来打印。NSLog配合%@使用时，编译器会自动调用被打印对象的description方法，如果打印的是类对象则调用类方法，实例对象则调用实例方法。继承于NSObject类的description方法默认会打印该对象的类名和它在内存中的地址。

新建一个People类，自定义description方法，调试打印。

People.h:

  1. #import <Foundation/Foundation.h>
  2. @interface People : NSObject
  3. @property (nonatomic, copy) NSString *name;
  4. @property (nonatomic, copy) NSString *sex;
  5. @property (nonatomic, assign) int age;
  6. @end

People.m:

  1. #import "People.h"
  2. @implementation People
  3. // 不要尝试在description方法中返回self，因为会出现死循环
  4. - (NSString *)description {
  5. /*
  6. // 错误示范
  7. return [NSString stringWithFormat:@"%@", self];
  8. */
  9. return [NSString stringWithFormat:@"name: %@, sex: %@, age: %d",
  10. self.name, self.sex, self.age];
  11. }
  12. + (NSString *)description {
  13. return @"People";
  14. }
  15. @end

测试代码：

  1. // 创建并初始化一个People实例p
  2. People *p = [[People alloc] init];
  3. p.name = @"jack";
  4. p.sex = @"man";
  5. p.age = 18;
  6. // 打印实例p，调用自己定义的description实例方法
  7. NSLog(@"%@", p);
  8. // 打印People类，调用自己定义的description类方法
  9. NSLog(@"%@", [p class]); // 类对象或者实例对象调用class方法会返回对象的类的所有信息，返回值为Class类型

iOS开发--调试必备 — NSLog

自己实现description方法可以打印我们想要看到的内容，更加便于调试，但是在description方法中不要返回或者打印self。

3.自定义打印日志输出内容

从上面的例子我们可以看到使用NSLog打印出来的日志前面带有很长一串的时间戳，可能有时候我们根本用不到，而且还会影响查看的效率。其实对于NSLog的输出格式我们也是可以自定义的，只需要我们写一个宏定义就可以了。

如果只想让NSLog打印我们输出的内容：

  1. #define NSLog(FORMAT, ...) fprintf(stderr,"%s\n",[[NSString stringWithFormat:FORMAT, ##__VA_ARGS__] UTF8String]);

iOS开发--调试必备 — NSLog

附加输出文件名和打印语句的行号：

  1. #define NSLog(FORMAT, ...) fprintf(stderr,"%s:%d\t %s\n",[[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], __LINE__, [[NSString stringWithFormat:FORMAT, ##__VA_ARGS__] UTF8String]);

iOS开发--调试必备 — NSLog

由于NSLog的使用效率比较低，所以在我们的项目中非调试状态下不应该出现大量的NSLog，所以有些时候我们会在项目的.pch文件中去定义一个宏，让调试打印函数只在调试的时候有用，发布的时候就不能使用。

在Xcode6之前，项目中Supporting files文件夹下有个 “工程名-Prefix.pch”文件,你可以在该文件下声明我们的宏，这样之后工程中的任何一个文件中都可以使用该宏(也就是说可以在.pch中放一些全局的东西)。Xcode6之后，可能是因为大家把大量的头文件和宏定义放到pch里边，导致编译时间过长，苹果就去掉了pch文件，但是我们仍可以手动添加。

实用版本：

  1. #ifdef DEBUG
  2. #define NSLog(FORMAT, ...) fprintf(stderr,"%s:%d\t %s\n",[[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], __LINE__, [[NSString stringWithFormat:FORMAT, ##__VA_ARGS__] UTF8String]);
  3. #else
  4. #define NSLog(...)
  5. #endif

相关文章