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


复制代码