自定义NSLog——彰显个性化

项目调试过程中，有两大神器。一是断点，二是Log。

背景介绍

而工程中出现的大量Log输出，在发布版本时是需要注释掉的。一方面是因为可能会暴露APP里的保密数据，另一方面也是最主要的原因就是它会占用时间和设备资源。在Simulator上可能感觉不是很明显，但是在真机上，如果是即时战略性的游戏，大量的Log输入会让游戏变得很“卡”很“卡”。

那解决的办法就是，利用宏定义，在Debug模式下打开，在Release模式下注释掉。如下：

#ifdef DEBUG
#define NSLog(...) NSLog(__VA_ARGS__)
#else
#define NSLog(...) {}
#endif

以上便是最简单的解决方案，这时候你就可以放心的使用NSLog了。
下面解释一下一些参数的意义：

参数意义

 __VA_ARGS__ 是一个可变参数的宏，很少人知道这个宏，这个可变参数的宏是新的C99规范中新增的，目前似乎只有gcc支持（VC6.0的编译 器不支持）。
 注意：宏前面加上##的作用在于，当可变参数的个数为0时，这里的##起到把前面多余的","去掉的作用,否则会编译出错, 你可以试试

__FILE__ 宏在预编译时会替换成当前的源文件名

__LINE__ 宏在预编译时会替换成当前的行号

__FUNCTION__宏在预编译时会替换成当前的函数名称

彰显个性化

在多人团队开发一个项目的时候，每个人负责自己的模块。那么，可以在控制台打印的时候，直接看出是谁打印的这条命令吗。
答案是肯定的。

你想在控制台出现下列的样式吗？

哈哈，这样子是不是有趣许多，当然了，它的好处由如下陈述：

1. 控制台的输出不再单调无味

2. 打印的信息比之普通的NSLog丰富了许多

3. 你可以一眼看出这条命令是哪位同学打出的

4. 如果控制台的打印实在太多，你只想关心你自己的打印输出，完全可以先屏蔽掉他人的输出。当然了，等你提交代码的时候，记得恢复就好，否则别的同事找你玩命，别说是我教你的 ~.~！

下面来看看是怎么实现的吧。我直接贴出来，能领悟多少就看你悟性了。其实不难，希望这个思路能帮到你。

一共用到三个文件

Header.h
PrintTool.h
PrintTool.m

Header.h文件：

#import "PrintTool.h"

#ifndef Header_h
#define Header_h

#pragma mark - 测试环境下才显示 Log

#ifdef DEBUG
#define NSLog(...) NSLog(__VA_ARGS__)
#else
#define NSLog(...) {}
#endif


#pragma mark - deallco信息

#define mtkLog_Dealloc NSLog(@"������号外！号外！%@ dealloc ������\n", NSStringFromClass([self class]));


#pragma mark - 基础打印信息

#pragma mark 打印 LOG 使用，能打印 LOG 所在的文件夹、函数名等细节
#define FUNCNAME [NSString stringWithCString:__FUNCTION__ encoding:NSUTF8StringEncoding]

#pragma mark 调用公共方法打印 LOG
#define Log_Print(userInfo, ...) [PrintTool printLogWithUserInfo:userInfo   \
                                                         comInfo:FUNCNAME   \
                                                        showInfo:[NSString stringWithFormat:__VA_ARGS__]];


#pragma mark - 打印 dealloc 信息

#if DEBUG
#define Log_Dealloc_Info Log_Print(@"������号外！号外！ dealloc 释放了������", @"")
#define Log_Dealloc_Info_(...) Log_Print(@"������号外！号外！ dealloc 释放了������", __VA_ARGS__)
#else
#define Log_Dealloc_Info {};
#define Log_Dealloc_Info_(...) {};
#endif


#pragma mark - 打印个人标志信息

#if DEBUG   // 只在测试模式下显示的 Log

#define Log_UserInfo_XM @"������ XiaoMing ������"      // 小明

#define Log_UserInfo_XH @"☀️☀️☀️ XiaoHong ☀️☀️☀️"     // 小红


#endif


#pragma mark - 打印信息

#pragma mark 小明 Log

#ifdef Log_UserInfo_XM
#define LOG_XM Log_Print(Log_UserInfo_XM, @"");
#define LOG_XM_(...) Log_Print(Log_UserInfo_XM, __VA_ARGS__);
#else
#define LOG_XM {};
#define LOG_XM_(...) {};
#endif

#pragma mark 小红 Log

#ifdef Log_UserInfo_XH
#define LOG_XH Log_Print(Log_UserInfo_XH, @"");
#define LOG_XH_(...) Log_Print(Log_UserInfo_XH, __VA_ARGS__);
#else
#define LOG_XH {};
#define LOG_XH_(...) {};
#endif

#endif /* Header_h */

PrintTool.h文件

#import <Foundation/Foundation.h>

@interface PrintTool : NSObject

+ (void)printLogWithUserInfo:(NSString *)userInfo
                     comInfo:(NSString *)comInfo
                    showInfo:(id)showInfo;

@end

PrintTool.m文件

#import "PrintTool.h"

@implementation PrintTool

+ (void)printLogWithUserInfo:(NSString *)userInfo
                     comInfo:(NSString *)comInfo
                    showInfo:(id)showInfo {
    if (!showInfo) {
        NSLog(@"[%@] %@", userInfo, comInfo);
    } else {
        NSLog(@"[%@] %@  %@", userInfo, comInfo, showInfo);
    }
}

@end

以上便是所有的源码，细心的朋友肯定看到了delloc的单独处理。是的。同理，你也可以对网络请求等操作作特殊的处理，只要你认为合理。

因为排版的问题，上面代码中的表情没有显示出来，这里给大家截图。

如果后面了新同事，让他在这里添加自己的个性化打印DIY，然后记得在后面实现，是不是很酷。

小技巧

• 在定义宏的时候，有时候过长，我们想在中途转行的时候可以用 ” \ ” 符号

• 有时候我们定义了一个变量，只是为了打印。那么Debug模式下没事，可是由于Release模式下我们注释了Log打印，那么编译的时候系统会报 unused 警告。这时候我们可以用 __unused 来修饰。