在Swift中自定义Log

• 自定义LOG的最终目的：让打印信息在 DEBUG 的环境下打印，在 RELEASE 的环境下不打印

Swift中默认打印

• 当前Swift中的打印为 ：

print("...")

• 默认打印的缺点：

  1. print("...")只能打印里面的内容
  2. 无法定位具体文件
  3. 无法定位当前打印的方法
  4. 无法定位当前打印的行数
  5. 无法区分 DEBUG/RELEASE 环境，判断是否打印，耗费性能

自定义Log

• 设置显示打印当期文件

// 获取文件位置
// #file 是系统提供的获取当前文件的宏（Swift 3之后是#file ，之前为 __FILE__）。
let filePath = (#file as NSString).lastPathComponent

print(filePath)

--------打印结果为--------
ViewController.swift

• 定位当前方法

// 获取当前方法
// #file 是系统提供的获取当前方法的宏（Swift 3之后是#function ，之前为 __FUNCTION__）。
let methodName = #function
print("\(filePath):\(methodName) - 我是原来打印")

--------打印结果为--------
ViewController.swift:viewDidLoad() - 我是原来打印

• 定位当前行数

// 获取当前行数
// #line 是系统提供的获取当前行数的宏（Swift 3之后是#line ，之前为 __LINE__）。
let lineNum = #line
print("\(filePath):\(methodName)第\(lineNum)行 - 我是原来打印")

--------打印结果为--------
ViewController.swift:viewDidLoad()第33行 - 我是原来打印

• 设置 DEBUG 宏，用于区分何时打印

此处需要在 Xcode -> target -> build settings 中搜索 swift flags。并在 DEBUG 环境下添加 -D DEBUG。添加一个 DEBUG 环境下叫 DEBUG 的宏，如图：

设置DEBUG flag.png

代码中设置只在 DEBUG 环境下打印

// 获取当前行数
// #line 是系统提供的获取当前行数的宏（Swift 3之后是#line ，之前为 __LINE__）。
let lineNum = #line
        
#if DEBUG
print("\(filePath):\(methodName)第\(lineNum)行 - 我是原来打印")
#endif

测试的话可以编辑 shame 中的 run 的环境

• 抽取成单独公开的方法

以上四点已经完成基本定位功能和只在DEBUG环境下打印的功能了。下面我们就来抽取成一个公开的方法，可以在项目中使用

func XYlog<T>(message : T ,file : String = #file , funName : String = #function , lineNum : Int = #line){
    
    let filePath = (file as NSString).lastPathComponent
    
    #if DEBUG
    
    print("\(filePath):\(funName):\(lineNum)-\(message)")
    
    #endif

}

【注意：】

• 方法的参数列表中 <T> message : T 是自定义的一个类型，这是一个泛型可以接收不同类型和数量的参数，并在下面使用
• 此自定义LOG是希望全局使用，所以最好放到一个全局文件中设置成一个公开方法，推荐设置到AppDelegate.swift 中