根据Debug和Release状态的变化来屏蔽日志输出

原文：http://www.cnblogs.com/springfield/archive/2011/05/04/2037089.html

 

今天在这里分享一个很实用的小技巧。 我们平时在开发应用的时候，经常会用到NSLog来调试我们的程序，而随着项目越来越大，这些用于调试的日志输出就会变得很难管理。 我们在发布正式版的时候一定要屏蔽掉所有后台输出，因为这些输出还是比较消耗系统资源的。  往往到了这个时候，我们不得不去一行一行的找到NSLog调用，然后注释掉。 这样做在项目小的时候还比较有效，但随着项目规模的增长，就会变得越来越难控制。  下面就给大家介绍一个简单的方法，让我们在生成Release版本时不需要进行任何更改即可屏蔽所有的Log输出。

1. 首先我们先要定义这样一段预处理命令，文件名随便起，例如 CLog.h

#ifdef DEBUG
#define CLog(format, ...) NSLog(format, ## __VA_ARGS__)
#else
#define CLog(format, ...)
#endif

　　这里我们判断DEBUG这个宏是否定义，如果有定义我们就将这个CLog宏替换成NSLog调用，而如果没有定义过DEBUG标志我们就直接跳过。这点应该不难理解。

2. 检查DEBUG标志是否正确定义，xcode一般会在debug运行配置项里面已经定义号了DEBUG标志，如果没定义我们就自己写上，以我的xcode 4 为例，如下图：

 

　　找到PreProcessor Macros 这个属性，对于Debug配置我们给他写上DEBUG，而在Release配置中把它留空。 这样我们刚才那段预处理命令就可以根据这个标志来判断我们编译的时调试版本还是发布版本，从而控制NSLog的输出。 (因为xcode 4 会把debug/release 两个配置项同时对比展现出来，而3.x版本的只能分别设置， 如果你用的时xcode 3.x 开发工具， 那么就分别对Debug/Release 都检查一下)。

3. 到了这里我们这个判断工作就都进行完了，不过这里还有一点比较麻烦，就是我们如果想实用CLog宏，就必须要导入 CLog.h 这个头文件。 不过xcode为我们提供了一种非常巧妙的解决办法。 我们自己看一下项目里的文件，是不是有一个叫做 xxx-prefix.pch 的文件，只要注意到pch这个扩展名就可以了。 这个文件是做什么用的呢？ 下面是一个pch文件的样本：

 

//
// Prefix header for all source files 
//

#import <Availability.h>

#ifndef __IPHONE_3_0
#warning "This project uses features only available in iPhone SDK 3.0 and later."
#endif

#ifdef __OBJC__
    #import <UIKit/UIKit.h>
    #import <Foundation/Foundation.h>
#endif

 

　　这里引入了一些头文件， 其实是xcode 的一种预编译机制，我们在编译一个项目的时候，会有很多常用的源文件，并且这些代码文件几乎不被修改，所以xcode对这些文件只在早期进行一次编译，以便我们以后的多次构建过程中反复实用。 例如这里的UIKit和Foundation ，这样的机制可以加快我们每次构建项目的速度。 当然这里我们不必太深究它，知道它的作用后，我们就可以利用它来为我们的开发提供便利。 我们只需要将刚刚建立的CLog.h 也在这里面引入一下，这样我们项目中的所有文件就都能够访问到我们刚刚定义的CLog宏了。 下面是完成后的pch文件：

 

#import <Availability.h>

#ifndef __IPHONE_3_0
#warning "This project uses features only available in iPhone SDK 3.0 and later."
#endif

#ifdef __OBJC__
    #import <UIKit/UIKit.h>
    #import <Foundation/Foundation.h>
    #import "CLog.h"
#endif

 

　　这样，我们的CLog就完成了，现在可以在任何一个源文件中实用CLog宏来输出日志，预处理命令会自动判断当前的编译配置，如果是Debug，就会输出日志，反之则什么都不会输出。