重载 print 函数提高性能

最近项目准备要上线了, 到了性能优化的阶段, 看了一些文章之后, 基本上都会提到 print 对于性能的影响很大, 常规的做法是新增一个方法, 想打印的时候全部调用这个方法, 编译时加一个布尔判断, 把方法里的 print 全部去掉, 变成一个空的方法, 例如下面这样 (摘录自 Swift 性能探索和优化分析 – 喵神):

// DEBUG 的 Complier Flag 的添加方法具体看喵神的的那篇文章
func dPrint(@autoclosure item: () -> Any) {
    #if DEBUG
    print(item())
    #endif
}

dPrint(resultFromHeavyWork())
// Release 版本中 resultFromHeavyWork() 不会被执行

但是感觉这种方式会影响代码习惯, 而且多人协作还有认知负担跟沟通成本, 谷歌一下之后, 某篇文章也写了一样的方法, 但是我在评论里找到了一个更加简单巧妙的方法 —- 重载

print 是在 Swift 的标准库里定义的, 定义如下:

public func print(items: Any..., separator: String = default, terminator: String = default)

接下来讲一下我们的具体做法以及原理, 当我们写 Swift 代码的时候, 我们在项目里定义的”全局”方法, 其实并非是真正的全局, 而是仅限于当前的 Module 内部, 得益于 Swift 这样的设计, 我们只要在当前的 Module 内部重载 print 方法就可以让 print 变成一个空的方法了(仅限于非 DEBUG 的模式下), 具体的代码如下:

// 注意这里是 !DEBUG
#if !DEBUG
public func print(items: Any..., separator: String = "", terminator: String = "") { }
#endif

想检测重载是否成功的话, 只要去掉布尔判断的 ! 就可以直接在电脑上看到测试效果了

不改变任何代码习惯, 不需要沟通成本, Release 模式下自动重载空的 print 方法, 三行代码加上一点点设置就能完成了

不过注释得写清楚, 这个重载的方法里不能加任何奇怪的东西, 要不然同事还是有可能会改掉这个方法的

但缺点也跟常规的方法一样, 只能在当前 Module 内作用, 对于引入的第三方库不起作用, 而且只对于 Swift 代码有效, 但其实也无伤大雅

唯一的希望是, Swift 编译器可以增加一个编译模式的 flag, 而不需要我们自己去添加, 所有第三方库也可以用这种方法去优化性能, 但这种做法又仅限于 iOS 平台, 而且我们有可能会需要去添加自定义编译的模式, 这种方法会带来不必要的麻烦, 具体的做法还需要 Swift 团队去思考斟酌

注: 文章代码使用的全部是 Swift 2.2 的版本

参考资料:

remove-println-for-release-version-ios-swift

swift-log-devil-or-why-println-is-dangerous(灵感来自评论区 Thongchai Kolyutsakul)

Swift 性能探索和优化分析 – 喵神