Swift 中打 Log 的正确姿势

以这种『xxx 的正确姿势』为标题的文章多少有点虚张声势,但是貌似效果还不错,所以我也试试看🤔

有时为了方便我们会想知道每条 Log 对应的 caller,像是下面这样:

[INFO] 2016-05-19 01:26:51.667 /path/to/your/file.swift:34:testExample() "content"

上面的 log 中包含了调用 log 的方法所在的文件及行号。

在 Swift 中要实现这个功能非常简单,使用几个內建的标识符(built-in identifiers)就行了,关于內建标识符更详细的说明可以在 Swift 官博的这篇中找到。

为了定位 caller,我们需要使用 #file#line#function,于是我们可以自定义一个函数:

func log(item: Any, _ file: String = #file, _ line: Int = #line, _ function: String = #function) {
    print(file + ":\(line):" + function, item)
}

然后这样去使用:

log("content")

你会在控制台看到类似的输出:

/path/to/your/file.swift:42:testExample() "content"

一般情况下可能就到此为止了,但是我们还是可以更有态度一点。我们还需要解决两个问题:

  1. 在 Release 版本中,自动忽略所有 Debug 的 log 调用,因为 log 也是有性能消耗的,既然是 Debug log,那么它们不必存在于 Release 版本的代码中。
  2. 如果可以一次 log 多个 items 就好了。
  3. log 的输出应该不只限于 Stdout。

解决问题 1

详细的内容可以参考这个问答 #ifdef replacement in swift language

主要的方式有两种,先来看看方式 1。

方式1

在 Swift 中,虽然没有了在 Object-C 预处理(preprocessor),但是依然可以使用相似的东西,在 Swift 中叫做 build configurations,当然功能上和预处理不是同一个级别的。

于是在 Swift 中,你可以这样使用:

#if build configuration
    statements
#else
    statements
#endif

而这里的 build configuration 则需要手动的在 Xcode 中进行设置,比如在 Objc 项目中会有预定义的宏 DEBUG,而在 Swift 中,你如果希望这样使用:

#if DEBUG
    statements
#else
    statements
#endif

你就必须在 Xcode 中的 Build Settings 里找到 Swift Compiler - Custom Flags 这个 Section,然后在其中添加一条 -D DEBUG

<small>如果你实在希望有个图的话,可以直接打开这个回答 answer-36502874</small>

如你所见,这个方式和我们原本在 Objc 中的方式很相似,但是设置 Custom Flags 的步骤也是稍显繁琐了。

方式 2

相较于方式 1 而且,方式 2 就显得灵活,我们不再需要去设置 Custom Flags 了。

<small>你也可以直接看原文的回答 answer-34532569</small>

从 Swift 2.1 开始,内置了一些函数:

  • _isDebugAssertConfiguration 当编译时使用了 -Onone 选项时,调用此函数会返回 true
  • _isReleaseAssertConfiguration 当编译时使用了 -O 选项时,调用此函数会返回 true
  • _isFastAssertConfiguration 当编译时使用了 -Ounchecked 选项时,调用此函数返回 true

并且回答者很细心的给出了此方式和方式1之间的区别:

  1. 首先当然是不必手动的设定 Custom Flags 了,这是好处
  2. 不好不坏的就是,使用此方式主要依据的是编译时的代码优化选项,而不是具体的 Xcode build Scheme,也就是说,如果你是 Release 版本,但是你更改了编译的优化选项,那么也会影响到方式2的结果
  3. 尚未有文档对这些函数进行描述,因此可能在下一个版本中就不存在了。但是可以确定的是使用了这些函数并不会导致你的 App 被拒,因为代码优化过程中会将这些函数转变成常量。
  4. 使用这些函数通常会有警告,这会对处女座的人造成困扰🙄

对于上面的区别 2,一般情况下我们不会改变默认的优化选项,即使改变了也不是问题,因为基本上还是会按照我们的预期的,因为『只有不开启优化 -Onone 时才有 Debug log』正好符合常见的需求。

对于区别 3,我感觉先别管下一个版本存在不存在吧哈,当下可以用的爽就用啊 😸

解决问题 2

不得不说,Swift 语言还是有一些细节没有考虑到,比如要解决问题2,使用 Swift 中的可变参数 (Variadic Parameters)功能就可以,但是这个功能的缺陷在于不支持 forwarding,或者是 unpackage,考虑下面的代码:

func func1(ints: Int...) -> Int {
    print(ints)
}
func func2(ints: Int...) -> Int {
    func1(ints...)
}

如果 Swift 支持上面的代码,那么如你所见,在 func2 中调用 func1 时将可变参数传递过去时就会非常的简洁直观,而现在由于 Swift 没有这个功能,你不得不这样 :

func func1(ints: Int...) -> Int {
    print(ints)
}
func func1(ints: [Int]) -> Int {
    print(ints)
}
func func2(ints: Int...) -> Int {
    func1(ints)
}

注意到了吗,你必须重新实现一个 func1,它的参数类型为 [Int],以此来接收 func2 内部调用 func1 时传递的参数 ints,真是绕了一圈。

解决问题 3

Swift 中包含了很多函数可以方便我们进行调试,其中一个便是 :

public func debugPrint<Target : OutputStreamType>(items: Any..., separator: String = default, terminator: String = default, inout toStream output: Target)

这个函数可以让我们可以自定义调试的内容应该被写入到哪里。我们只要简单的实现 OutputStreamType 接口就行了。

同时解决 1,2,3

好了问题来了,如果同时解决 1,2,3?使用我的这个项目 MCDLogger 就可以了。

在使用 MCDLogger 时,你需要指定本次 log 的级别,如果你使用的是 Debug 级别,那么这样就可以:

MCDLogger.log(.Debug, 1, 2)

第一个参数就是是 log 的级别,后面接着的可变参数是需要 log 的 Any 类型,就是任意类型啦。使用了上面的代码之后,将会在 Release 时自动的跳过级别为 Debug 的 log,这里内部使用的是上面介绍的 _isDebugAssertConfiguration 来实现的,因此你不需要设置 Custom Flags。

上面的代码会产生类型下面的输出:

[Debug] 2016-05-19 01:37:34.735 1 2

注意默认是不会包含 caller 的信息的,当然也可以开启:

MCDLogger.includeCaller = true
MCDLogger.log(.Debug, 1, 2)

那么输出将会类似:

[Debug] 2016-05-19 01:37:34.735 /path/to/your/file.swift:40:testExample() 1 2

并且你可以一次 log 多个内容。

默认的输出是 Stdout,当然你可以实现 OutputStreamType 接口之后,通过改变 MCDLogger.outStream 属性,这样你不必更改任何已有的 log 代码,而 log 的内容将会根据你的需要自动地写入不同的设备,比如磁盘文件。

最后,MCDLogger 还提供了几个快捷方法,因此你可以直接:

INFO(1, 2)
ALERT(1, 2, 3)
DEBUG(1, 2, 3, 4)
ERROR(1, 2)

这样就不需要显式设置 level 啦,并且如果这些快捷方法命名和你的已有代码发生了冲突,你也可以通过在 Custom Flags 中添加 -D NOCONVENIENT 来禁用这个方法,这样就不会有冲突了哈。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,294评论 4 61
  • 做餐饮不能闭门造车,需要走出去看看,前阵子在内测烤串的时候,我就心想着要吃吃珠海的其他的烤串,要学习先进经验,博采...
    陈素封阅读 1,279评论 5 12
  • 花开了,我就画花。 花谢了,我就画我自己。 你来了,当然画你。 你走了,我就画一画回忆。
    到底要多久阅读 338评论 0 0
  • 前言: 我们常说的甩大鞭是北方众多钓手特别喜爱的一种钓法。顾名思义,"甩大鞭"就是钓者手握一拫长竿,不停地走动,不...
    钓侠阅读 2,049评论 0 0
  • 高速的列车奔驰在华北平原之上,除了树木的遮挡,没有高山,没有大河,一望无垠的黄土地。数百里的土地,都是这样的平整,...
    叶小涛阅读 572评论 0 0