iOS关于日志模式及日志级别

需求

在开发中我们经常要通过Log(日志)来调试问题, 而上线后不需要打印Log,而且平常开发每做一个模块如果可以将log按照级别打印出来,对分析问题帮助很大.

实现原理

通过导入一个头文件以实现开启或关闭Log模式,实现选择Log级别.通过导入#include <syslog.h>以实现打印不同级别的Log.

为什么使用syslog ? 因为它不仅可以在Xcode控制台打印信息,还可能在Mac终端中打印出日志信息,这样的好处是比如我们有一个app store的app出了问题,我们可以在app中调节log level到debug模式,然后使用数据线连接设备, 这样再复现问题可以将相关的Log即时打印出来.对分析问题帮助很大.

简要分析

1. Log模式

为什么设置log模式,很简单,因为上线后的app不必打印log, 而且如果开发中想取消所有相关打印也可以直接通过该宏定义决定.

本例中如果在代码中定义了kXDXDebugMode则启用打印log模式,否则关闭.

2. Log级别

本例中通过五个函数来打印不同级别log,如下

#define kModuleName "Hello"
...
    int i = 1; int j = 2;
    log4cplus_fatal(kModuleName, "world1 , %d,%d",i,j);
    log4cplus_error(kModuleName, "world2");
    log4cplus_warn(kModuleName, "world3");
    log4cplus_info(kModuleName, "world4");
    log4cplus_debug(kModuleName, "world5");

比如我们在开发中可能独立承担一个模块,而此模块单单做完如果出现问题就需要调试,但是如果我们的Log足够清晰是可以迅速帮助我们找到问题所在,这里将Log分为5个级别

以下是个人对于打印Log的一些建议,并不是说一定要按照如下.

XDX_IOS_FLAG_FATAL : 严重级别

此类错误出现时,表明程序因为某某问题已经彻底无法运行下去,我们在使用此log时可以附加说明当前碰到的重大问题及产生原因,以便调试.

XDX_IOS_FLAG_ERROR : 出错级别

此类打印可用于出现一般错误,比如某个方法调用返回失败, 因为一般而言代码预期是正确的, 所以此类Log不会打印的太频繁, 打开此级别后我们可以清晰看到程序哪些地方出现问题.

XDX_IOS_FLAG_WARN : 警告级别

此类错误一般较低于error级别,即在一些可能出错的地方, 但实际并没有出错, 比如当视频帧数量小于0表示出错情况,我们为了预防,可以在视频帧数量小于5时使用此类添加一条预防的Log.

XDX_IOS_FLAG_INFO : 重要信息级别

此类级别一般用于打印模块中一些重要的点, 比如我们可以在某个类初始化完成时打印此类中初始化好的一些重要信息,或者在使用某个功能前做一个打印,这样对于追踪代码十分有效.

XDX_IOS_FLAG_DEBUG : 调试级别

此类级别表明我们当前正在临时打印一些log为了去调试程序, 或者说我们为了观察某个现象但是需要频繁打印, 比如相机回调中打印时间戳,因为相机每秒钟出来几十帧数据,所以打印十分频繁,我们可以使用此级别在开发中作为调试信息,一般不建议在正常使用中开启此级别.

综上所述,即log级别越高,log数量应该是越少,这样我们可以在开发中根据如上所述的情况合理选择使用哪个级别的log. Log级别是有包含关系的, 即低的log级别可以包含比自身高的log级别.

3. 模块名

这里封装的格式如下,即一条log分为两部分,前面是模块名,后面是具体log内容,使用这种格式可以帮助我们通过过滤某个模块中的Log, 十分直观清晰

#define log4cplus_fatal(category, logFmt, ...) \
if(XDX_IOS_LOG_LEVEL & XDX_IOS_FLAG_FATAL) \
syslog(LOG_CRIT, "%s:" logFmt, category,##__VA_ARGS__); \

举例如下:

#define kModuleName "Hello"

...


- (void)test {
    int i = 0;
    log4cplus_debug(kModuleName, "Hello World - %d",i);
}

4. 注意

因为我们使用的syslog,所以OC中的格式符%@是不可用的.但是任何OC中的字符串都可通过UTF8String转为C语言字符串,所以并不影响我们的使用.

5. 使用方式

每次编译前设置log级别

如果不需要在项目中通过UI动态更改log级别,则可以直接使用如下方式将头文件拖入项目,然后在需要使用log的地方将其导入.这种方式简单方便,仅仅通过每次运行前更改宏定义即可转变log级别.

在运行后通过UI更改

那么需要将头文件的XDX_IOS_LOG_LEVEL全局静态变量换为外部变量,然后取消下面这段代码,最后在控制UI的类中定义并通过交互更改此值即可.

#ifdef XDXLogLevelFatal
static const int XDX_IOS_LOG_LEVEL = XDX_IOS_FLAG_FATAL;
#elif defined(XDXLogLevelError)
static const int XDX_IOS_LOG_LEVEL = (XDX_IOS_FLAG_FATAL | XDX_IOS_FLAG_ERROR);
#elif defined(XDXLogLevelWarn)
static const int XDX_IOS_LOG_LEVEL = (XDX_IOS_FLAG_FATAL | XDX_IOS_FLAG_ERROR | XDX_IOS_FLAG_WARN);
#elif defined(XDXLogLevelInfo)
static const int XDX_IOS_LOG_LEVEL = (XDX_IOS_FLAG_FATAL | XDX_IOS_FLAG_ERROR | XDX_IOS_FLAG_WARN | XDX_IOS_FLAG_INFO);
#elif defined(XDXLogLevelDebug)
static const int XDX_IOS_LOG_LEVEL = (XDX_IOS_FLAG_FATAL | XDX_IOS_FLAG_ERROR | XDX_IOS_FLAG_WARN | XDX_IOS_FLAG_INFO | XDX_IOS_FLAG_DEBUG);
#endif

具体实现


#include <syslog.h>
#ifndef XDX_IOS
#define XDX_IOS
#endif

#pragma - Please select your log mode and log level

// Note: Only debug mode will print log. You could also set mode for log level.
#define kXDXDebugMode
// XDXLogLevelFatal , XDXLogLevelError , XDXLogLevelWarn , XDXLogLevelInfo , XDXLogLevelDebug
#define XDXLogLevelDebug

#pragma ----------------------------------

#ifdef kXDXDebugMode

static const int XDX_IOS_FLAG_FATAL = 0x10;
static const int XDX_IOS_FLAG_ERROR = 0x08;
static const int XDX_IOS_FLAG_WARN  = 0x04;
static const int XDX_IOS_FLAG_INFO  = 0x02;
static const int XDX_IOS_FLAG_DEBUG = 0x01;

#ifdef XDXLogLevelFatal
static const int XDX_IOS_LOG_LEVEL = XDX_IOS_FLAG_FATAL;
#elif defined(XDXLogLevelError)
static const int XDX_IOS_LOG_LEVEL = (XDX_IOS_FLAG_FATAL | XDX_IOS_FLAG_ERROR);
#elif defined(XDXLogLevelWarn)
static const int XDX_IOS_LOG_LEVEL = (XDX_IOS_FLAG_FATAL | XDX_IOS_FLAG_ERROR | XDX_IOS_FLAG_WARN);
#elif defined(XDXLogLevelInfo)
static const int XDX_IOS_LOG_LEVEL = (XDX_IOS_FLAG_FATAL | XDX_IOS_FLAG_ERROR | XDX_IOS_FLAG_WARN | XDX_IOS_FLAG_INFO);
#elif defined(XDXLogLevelDebug)
static const int XDX_IOS_LOG_LEVEL = (XDX_IOS_FLAG_FATAL | XDX_IOS_FLAG_ERROR | XDX_IOS_FLAG_WARN | XDX_IOS_FLAG_INFO | XDX_IOS_FLAG_DEBUG);
#endif



#define log4cplus_fatal(category, logFmt, ...) \
if(XDX_IOS_LOG_LEVEL & XDX_IOS_FLAG_FATAL) \
syslog(LOG_CRIT, "%s:" logFmt, category,##__VA_ARGS__); \

#define log4cplus_error(category, logFmt, ...) \
if(XDX_IOS_LOG_LEVEL & XDX_IOS_FLAG_ERROR) \
syslog(LOG_ERR, "%s:" logFmt, category,##__VA_ARGS__); \

#define log4cplus_warn(category, logFmt, ...) \
if(XDX_IOS_LOG_LEVEL & XDX_IOS_FLAG_WARN) \
syslog(LOG_WARNING, "%s:" logFmt, category,##__VA_ARGS__); \

#define log4cplus_info(category, logFmt, ...) \
if(XDX_IOS_LOG_LEVEL & XDX_IOS_FLAG_INFO) \
syslog(LOG_WARNING, "%s:" logFmt, category,##__VA_ARGS__); \

#define log4cplus_debug(category, logFmt, ...) \
if(XDX_IOS_LOG_LEVEL & XDX_IOS_FLAG_DEBUG) \
syslog(LOG_WARNING, "%s:" logFmt, category,##__VA_ARGS__); \


#else

#define log4cplus_fatal(category, logFmt, ...); \

#define log4cplus_error(category, logFmt, ...); \

#define log4cplus_warn(category, logFmt, ...); \

#define log4cplus_info(category, logFmt, ...); \

#define log4cplus_debug(category, logFmt, ...); \

#endif