那些C标准中对debug有帮助的宏

最近在重构消息模块,研究云信官方demo的时候发现他们用 CocoaLumberjack 这个三方框架来监控日志输出,我之前也有在自己的项目中引入 NSSLogger 来达到类似的目的。

ps: 我们项目中一直存在一坨宏,也不知道谁加上去的2333

#ifdef DEBUG
#define DLog( s, ... ) NSLog( @"<%p %@:(%d)> %@", self, [[NSString stringWithUTF8String:__FILE__] lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
#define ALog(fmt, ...) NSLog((@"%s [Line %d] " fmt), __PRETTY_FUNCTION__, __LINE__, ##__VA_ARGS__);
#else
#define DLog( s, ... )
#define ALog(...)
#endif

今天特地整理一下这些debug的时候常用的宏

  • 打印函数的宏
    __func____FUNCTION____PRETTY_FUNCTION__
    测试代码段如下:
NSLog(@"__func__:%s,",__func__);
NSLog(@"__FUNCTION__:%s,",__FUNCTION__);
NSLog(@"__PRETTY_FUNCTION__:%s,",__PRETTY_FUNCTION__);

在oc的方法中他们的表现是一样的,输出如下:

2017-02-16 15:30:31.474 testdemo[74077:387792] __func__:-[testViewController test],
2017-02-16 15:30:31.474 testdemo[74077:387792] __FUNCTION__:-[testViewController test],
2017-02-16 15:30:31.475 testdemo[74077:387792] __PRETTY_FUNCTION__:-[testViewController test],

在main函数中(也就是函数作为程序的一级成员时),输出如下:

2017-02-16 16:34:36.234 testdemo[82693:425275] __func__:main,
2017-02-16 16:34:36.234 testdemo[82693:425275] __FUNCTION__:main,
2017-02-16 16:34:36.235 testdemo[82693:425275] __PRETTY_FUNCTION__:int main(int, char **),

其中 __PRETTY_FUNCTION__ 会输出 当前所在函数名,包括返回类型和参数类型,而在有一些IDE环境中是不支持 __func__ 的。

  • 打印时间的宏
    __TIME____DATE__
    测试代码段如下:
NSLog(@"__TIME__:%s,",__TIME__);
NSLog(@"__DATE__:%s,",__DATE__);

__TIME__ 会输出当前源文件编译的日期,__DATE__ 会输出进行预处理的日期,输出如下:

2017-02-16 16:43:03.170 testdemo[82693:425275] __TIME__:15:30:13,
2017-02-16 16:43:03.171 testdemo[82693:425275] __DATE__:Feb 16 2017,
  • 打印代码信息相关的宏
    __LINE____FILE__
    其中 __LINE__ 会输出源文件中当前代码所在行号,__FILE__ 会输出当前源文件本地所在的绝对路径
    测试结果如下:
//测试代码片段
51 NSLog(@"__LINE__:%d,",__LINE__);
52 NSLog(@"__FILE__:%s,",__FILE__);
//控制台输出
2017-02-16 16:43:03.170 testdemo[82693:425275] __LINE__:51,
2017-02-16 16:43:03.170 testdemo[82693:425275] __FILE__:/Users/hanling/Desktop/testdemo/testdemo/testViewController.m,
  • 输出可变参数的宏
    __VA_ARGS__(C99提供的可变宏),在上文DLog中也有用到过。
    它是可变参数宏,对他进行宏定义可以传入不定个数的参数,在他前面加上 ## 则表示可变参数被忽略或为空时会直接将其带来的负面效果移除,就像 __VA_ARGS__ 完全没有存在一样。
    举个例子:
#define DLog( s, ... ) NSLog( @"<%p %@:(%d)> %@", self, [[NSString stringWithUTF8String:__FILE__] lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )

这个宏在 DLog( s, ... ) 中传入的可变参数个数为0时,##__VA_ARGS__ 前的逗号不会被输出

第二种可变参数的宏定义方法(GCC提供的可变宏)

#define cprint(format,args...) NSLog(format, ##args)

在 Xcode 中这两种方式都是支持的


另外:在OC中我们还可以这么玩(来自喵神的博客)

//输出当前方法
NSLog(@"Current selector: %@",NSStringFromSelector(_cmd));
//输出当前类
NSLog(@"Object class: %@",NSStringFromClass(self.class));
//输出当前源文件名
NSLog(@"Filename: %@",[[NSString stringWithUTF8String:__FILE__] lastPathComponent]);

tip 如果有需要你还可以利用OC的反射机制打印更多东西

坚持原创技术分享,您的支持将鼓励我继续创作!