iOS 【美化NSLog】 关于NSLog的格式化输出

对于任何一家公司的任何一个项目来说,调试信息都是必不可少的,也就是说NSLog必定会频繁使用,但是NSLog所输出的调试信息并不是任何情况都需要的。
一般来说,开发环境是需要我们使用NSLog来打印一些信息,方便我们处理数据、bug查找等,但是对于线上环境,也就是用户使用的release环境的APP是不需要的,如果强行输出会造成性能上的问题,这并不是我们需要的。所以,几乎所有的项目都会自定义NSLog宏。

绝大多数的NSLog宏都是仅输出我们调用时最终需要使用的信息,代码示例如下

#ifdef BETA
#define DebugNSLog(format, ...) NSLog(format, ## __VA_ARGS__)
#else
#define DebugNSLog(...) /* */
#endif

说明
#ifdef BETA指的是开发环境下,DebugNSLog == NSLog。#else指的是release环境下 DebugNSLog 是没有实现的,也就是说BETA环境下,DebugNSLog等同于NSLog,而其他都视为无作用。
关于环境宏:BETA 是自己起的,正常情况下,XCode 默认两种环境宏变量

  • Debug
  • Release
    如果你的项目是自定义的宏变量,可以再下图地方查看


    image.png

    这是我这里的配置,左边是配置的环境,配置方法如下图所示


    image.png

右侧对应的是 宏变量名称和值,比如说 Beta 这个环境下,他的环境宏为 BETA ,值为 1,也就是说,Beta 下, if (BETA = YES) 成立 ,因为 项目使用了 cocoapods ,而cocoapods 有自己的 环境宏,他默认值都是 1,也就是说,无论在那个环境下, cocoapods 都可用

按理来说,这样的定义就已经够我们使用了,但是,当我们各个地方都调用了DebugNSLog来进行输出的话,势必要配合断点来查看我们当前想要看到的输出信息,否则APP启动输出了1千条信息,你怎么能知道是你要看到的信息呢(其实我举得这个例子不是特别好),这种情况下我们可以调整宏定义,示例代码如下

#ifdef BETA
#define DebugNSLog(formater,...) NSLog((@"函数:%s\n" "代码位置行数: %d\n" formater),__FUNCTION__,__LINE__,##__VA_ARGS__)
#else
#define DebugNSLog(...) /* */
#endif

说明

  • __FUNCTION__是类的方法名称,
  • __LINE__是输出方法所在这个类的具体代码行数,
  • ##__VA_ARGS__同普通打印宏一样

##__VA_ARGS__
是一个可变参数的宏,这个可变参数的宏是新的C99规范中新增的,目前似乎只有gcc支持(VC6.0的编译器不支持)。宏前面加上##的作用在于,当可变参数的个数为0时,这里的##的作用是把前面多余的","去掉,否则会编译出错。

使用最终效果

//代码 viewDidLoad方法里调用
DebugNSLog(@"==调试==");

//控制台输出结果
2019-01-25 15:19:54.509437+0800 shequbanjing[12451:728498] 函数:-[SQPlazaViewController viewDidLoad]
代码位置行数: 97
==调试==

补充
目前自己在用的写法是:

#define DebugNSLog(formater,...) NSLog((@"\n====================\n >>> class: %s\n\n >>> method: %s\n\n" " >>> code line: %d 行\n\n >>> message: "  formater @"\n==================="),__FILE__,__FUNCTION__,__LINE__,##__VA_ARGS__)

最终输出样式

2019-02-26 15:43:05.104862+0800 sqbj-common-kit[99393:9668747] 
====================
 >>> class: /Users/BlackStar/Downloads/sqbj-common-kit/sqbj-common-kit/ViewController.m

 >>> method: -[ViewController viewDidLoad]

 >>> code line: 26 行

 >>> message: test Log
===================
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • http://www.open-open.com/lib/view/open1390651437117.html ...
    Xtuphe阅读 1,295评论 0 10
  • 宏定义在C系开发中可以说占有举足轻重的作用。底层框架自不必说,为了编译优化和方便,以及跨平台能力,宏被大量使用,可...
    你好自己阅读 1,061评论 0 5
  • 关于宏 宏定义在C系开发中可以说占有举足轻重的作用。底层框架自不必说,为了编译优化和方便,以及跨平台能力,宏被大量...
    Cheriez阅读 788评论 0 4
  • 写在前面 在开发过程中很多时候需要阅读第三方源码,但是里面有大量的宏。没有换行,没有着色,与平时写的代码完全不同,...
    走进科学阅读 750评论 0 2
  • 转载自OneV's Den 的宏定义的黑魔法 - 宏菜鸟起飞手册 讲的太详细了,就像老师一样,不是在讲方法,而是在...
    厨子阅读 551评论 0 0