可插拔式的iOS客户端log规范

对于iOS开发的同学们，iOS系统除了NSLog打印API之外，没有提供任何log规范。因此，在实际iOS客户端开发工作中，尤其当团队中开发人员较多、项目模块较丰富时。开发同学每次联机进行debug调试时，控制台便是各种log，甚至不得不通过查找的方式寻找关键信息。

甚至有些log直接打印在release环境中，如果没有规范化的log管理，难免一些敏感信息会被泄露。

针对上述可能存在的问题，Firefly_iOS一开始就定义了明确的log规范

• 1.所有的log只在debug环境下输出，release环境除了某些三方SDK无法控制外，原则上自己的代码不建议产生任何log输出。
• 2.log严格功能模块进行管理，日志的输出或关闭要做到模块粒度的控制。

一、详解可插拔式的log规范：

• 1、先看一组宏定义：

#define INFO_NEW_FMT(fmt) \
[NSString stringWithFormat:@"[INFO] %s(%d) %@", \
__FUNCTION__, \
__LINE__, \
fmt]

上述宏定义的其实核心就是输出一组log信息，包括三个参数信息： 函数名、代码行号以及真正打印的NSString格式的log。

• 2、类似的，我们定义另外一个ERROR级别的宏：

#define ERROR_NEW_FMT(fmt) \
[NSString stringWithFormat:@"[ERROR] %s(%d) %@", \
__FUNCTION__, \
__LINE__, \
fmt]

不难发现这两组宏的差别仅在于log的模板开头一个是"[INFO]"，一个是"[ERROR]"

• 3、基于上述的基本规则，项目组还可以根据实际的项目要求作一些个性化的定制。
  例如： 有的项目组可能要求内测阶段，debug环境下要打印所有的warning级别的信息。这时候，我们只需要根据的根据 #ifdef DEBUG作进一步判断定制即可。

二、实际使用示例

客户端要新开发一个TEST功能模块。

• 1、根据模块化log原则，我们首先基于上述的宏定义，定义TEST模块的相关log接口定义。

#define TEST_LOG
#ifdef TEST_LOG
#define TestLog_i(fmt,...) NSLog(INFO_NEW_FMT(fmt),##__VA_ARGS__,nil)
#define TestLog_e(fmt,...) NSLog(ERROR_NEW_FMT(fmt),##__VA_ARGS__,nil)
#else
#define TestLog_i(fmt,...)
#define TestLog_e(fmt,...)
#endif

特别注意宏开关#define TEST_LOG才是可插拔的核心，通过TEST_LOG的定义与否即可实现该模块的log是否被输出。

• 2、TEST模块需要输出log时，调用相应级别的log输出接口即可.

 - (void)testModule
{
    TestLog_i(@"getStringCache:%@", [localCache getStringCache]);
    TestLog_i(@"getArrayCache:%@", [[localCache getArrayCache] description]);
    TestLog_e(@"getArrayCache:%@", [[localCache getDictionaryCache] description]);
}

• 3、调用函数testModule时，最后打印出如下日志信息：

2015-01-27 14:25:32.926 MSZXFramework[2888:85719] [INFO] +[MSZXModuleTest testModule](88) getStringCache:(null)
2015-01-27 14:25:32.927 MSZXFramework[2888:85719] [INFO] +[MSZXModuleTest testModule](90) getArrayCache:(null)
2015-01-27 14:25:32.928 MSZXFramework[2888:85719] [ERROR] +[MSZXModuleTest testModule](92) getArrayCache:(null)

• 4、相应的功能模块完成，需要发布到release环境时，将相应log的宏开关关掉即可，如代码所示：

//#define TEST_LOG
#ifdef TEST_LOG
#define TestLog_i(fmt,...) NSLog(INFO_NEW_FMT(fmt),##__VA_ARGS__,nil)
#define TestLog_e(fmt,...) NSLog(ERROR_NEW_FMT(fmt),##__VA_ARGS__,nil)
#else
#define TestLog_i(fmt,...)
#define TestLog_e(fmt,...)
#endif

三、使用原则总结

• 1.每次新增一个功能模块FUNC，单独定义一个模块的log宏定义：FuncLog_i,FuncLog_e，并使用宏FUNC_LOG进行开关控制。
• 2.如果要追踪FUNC模块的log信息，只需将宏开关FUNC_LOG打开即可。
• 3、如果已经调试完毕，可以正式合并代码了，支付将宏开关FUNC_LOG关闭，那么该功能模块的日志信息就不会打印了。