Swift3.0之自定义debug阶段控制台打印

  本文讲解在使用最新的Swift3.0语言进行ios开发的debug打印功能，并与Objective-C语言作对比。

  进行ios开发伊始，自然少不了要首先对项目进行各方面的配置，比如导入框架、配置info.plist、自定义后台打印等等，接下来首先使用Objective-C语言自定义后台打印，之后使用Swift3.0。

  Objective-C语言：

  首先要在项目中创建pch文件，使用command+n快捷键弹出新建文件窗口并选择pch文件：

  之后配置项目将pch文件作为全局文件：

  上图第5步中是设置prefix header文件的相对路径，路径是从项目的根目录下的第一个目录开始直到pch文件

  接下来就是在pch文件中实现自定义log的方法（当然还有一些全局变量的定义和预编译，此处不作说明），代码如下：

 

#ifdef DEBUG
#define YTLog(...) NSLog(@"%s
 %@

", __func__, [NSString stringWithFormat:__VA_ARGS__])
//真机测试显示打印的格式
#define YTRLog(FORMAT, ...) fprintf(stderr,"%s:%d   %s

",[[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], __LINE__, [[NSString stringWithFormat:FORMAT, ##__VA_ARGS__] UTF8String]);

#else
#define YTRLog(FORMAT, ...)
#endif

  有兴趣的同学可以试着调用这个自定义的log打印结果

  下面介绍Swift自定义log的方法：

  与OC不同的是，Swift没有所谓的pch文件，即时新建了也产生不了什么作用，而且Swift3.0也没有预编译命令#define，只能通过最新的语法来实现自定义log。

  首先依然是项目的配置，但却不是配置pch文件的路径，而是定义调试阶段的flag变量，如图：

  上图中，在步骤5中写入编译阶段debug的标识符，这里写入了和OC一样的标识符，之后就可以利用这个DEBUG标识符进行debug阶段的判断，从而杜绝Release阶段的后台打印。

  然后，我们在项目中新建一个Swift的头文件，可以在该文件中进行一些全局变量和全局函数的声明和实现：

  在这里，我将该Swift头文件命名为“SwiftPch”，因为这个文件是和OC的pch文件起着类似的作用，然后在该头文件中，可以使用let、var、fun等关键字声明一些全局变量和函数等，这里，我只做与自定义log有关的函数定义与实现：

//自定义调试阶段log
    func delog(filePath: String = #file, rowCount: Int = #line) {
        #if DEBUG
            let fileName = (filePath as NSString).lastPathComponent.replacingOccurrences(of: ".Swift", with: "")
            print(fileName + "/" + "(rowCount)" + "
")
        #endif
    }

    func delog<T>(_ message: T, filePath: String = #file, rowCount: Int = #line) {
        #if DEBUG
        let fileName = (filePath as NSString).lastPathComponent.replacingOccurrences(of: ".Swift", with: "")    
            print(fileName + "/" + "(rowCount)" + " (message)" + "
")
        #endif
    }

  这里，我实现了两个自定义log的函数，一个是可以不带打印信息参数的，一个是需要带打印信息参数的。该函数的实现使用了Swift泛型的概念，因为我们知道需要打印的信息是任意类型的变量，而不仅仅是字符串。

  在系统的打印函数print中只是单纯携带了需要打印的信息。而不包含任何其他信息，这对于一个庞大的项目来说是远远不够的，相较于OC语言的打印函数NSLog中携带了时间信息，我们仍然需要一些对我们调试程序和定位bug十分有用的信息，比如文件名、调用的函数名以及打印的代码的所在行数等等，至于时间信息，其实对于我们来说是完全无用的，我们完全可以用另一个强大的Xcode自带调试工具Time profile来分析代码的运行时间。在Swift3.0中，文件名、函数名、代码函数这些信息分别使用代码#file、#function、#line来实现，返回的类型分别是Swift的内置类型String、String和Int。

  在本例中，我只使用了#file、#line这两个额外信息，因为对于#function来说，#line已经完全能够定位到代码的执行地点，#function未免过于冗长和多余，当然，这个只是个人偏好的问题，可以带上也不可以选择不带上。在上例的函数中，我使用了自己配置的debug阶段的标识符DEBUG，能够在函数执行后，在debug阶段打印想要的信息，在Release阶段则什么都不做。另外，此处我对#file这个String变量做了额外的处理，在Swift中，#file是会返回一个文件所在的绝对路径，这个路径过于冗长，我们只需要其最后一个路径即可，也就是先将其转换为OC类型NSString，再截取最后一个路径，之后，我删除了最后文件名中的所有“.Swift”后缀，最终在大多数情况下我就只得到该文件名的类名。通过以上函数，最终我得到的打印输出是这样的：

delog()
delog(1)
delog("1")

playground31/15

playground31/16 1

playground31/17 1

   上3行是调用打印函数，下3行是控制台输出，怎么样，是不是看起来清爽很多？