原文: Optionals and String Interpolation
作者: Ole Begemann
译者: kemchenj
你知道这个问题吗? 你想要在 UI 上显示一个 Optional 值,或者是在控制台打印出来,但你不喜欢默认的 Optional 字符串的显示方式: "Optional(...)" 或者是 "nil". 例如:
var someValue: Int? = 5
print("这个值是 \(someValue)")
// "这个值是 Optional(5)"
someValue = nil
print("这个值是 \(someValue)")
// "这个值是 nil"
在字符串里插入 Optional 值会有一些不可预料的结果
Swift 3.1 会在你往字符串里插入一个 Optional 值的时候发出一个警告,因为这个行为可能会产生意料之外的结果. 这里有 Julio Carrettoni,Harlan Haskins 和 Robert Widmann 在 Swift-Evolution 的讨论:
由于 Optional 值永远都不应该显示给终端用户,而它又经常作为一个控制台里的惊喜存在,我们觉得获取一个 Optional 值的 debug 信息是一种"明确"的艺术. 提案目前的主要内容是,在一个字符串片段里使用 Optional 值的时候需要发出一个警告.
在最新的 Swift 开发版本(2016-12-01)里已经实现了这个警告:
@H_404_28@
你有几个方法可以去掉这个警告:
添加一个显式转换,例如
someValue as Int?使用
String(describing: someValue)函数提供一个默认值去让表达式不为 Optional,例如
someValue ?? defaultValue(一种解包形式)
上面的方式我都不是特别喜欢,但这是编译器能提供的最好的方式了. 第三种做法的问题是解包操作符 ?? 需要符合相应的类型 - 如果 ?? 左边的类型是 T?的话,那右边的类型就必须是 T. 用上面的例子来描述的话,就意味着我只能够提供一个 Int 来作为默认值,而不能是一个字符串,在这种情况下就达不到我想要的效果.
一个自定义的字符串解包操作符
我通过自定义一个字符串解包操作符来解决这个问题. 因为它来源于 ??,所以我决定把它命名为 ???. ???操作符的左边是 Optional 值,而在右边就是这个 Optional 值的字符串默认值,返回一个字符串. 如果这个 Optional 值是 non-nil 的,那么它就会解包然后返回这个值的字符串描述,否则就会返回一个默认值,下面是具体的实现:
infix operator ???: NilCoalescingPrecedence
public func ???<T>(optional: T?,defaultValue: @autoclosure () -> String) -> String {
switch optional {
case let value?: return String(describing: value)
case nil: return defaultValue()
}
}
@autoclosure 结构保证了右边的值只会在需要的时候才会被计算出来,例如 Optional 值是 nil 的时候. 这就可以让你传递一个复杂的或者耗时的运算表达式进去,而只会在特定情况下才会影响到性能. 我不认为这种情况(表达式很复杂)会经常发生,但它是参考了 ?? 操作符在标准库里的实现.(尽管我决定去掉标准库实现里的 throws/rethrows)
或者,你可以通过 Optional.map 只用一行代码来实现这个操作符,就像这样:
public func ???<T>(optional: T?,defaultValue: @autoclosure () -> String) -> String {
return optional.map { String(describing: $0) } ?? defaultValue()
}
这跟第一个实现的效果一模一样,用哪一个只看你个人的口味和代码习惯. 我不认为哪一个比另一个更加清晰.
最后一件我想说的是,你必须从 String(describing:) (更偏向于值的描述) 或者是 String(reflecting:) (更偏向于 debug 信息) 中做出一个选择,去转化这个值. 前一个选择更适合 UI 展示,而后一个则更适合运行日志. 甚至你可以再自定义一个操作符 (例如: ????),去适应日常 debug 需求.
实际使用
我们使用 ??? 操作符来重构一下文章最开始的那个例子:
var someValue: Int? = 5
print("值是 \(someValue ??? "unknown")")
// "值是 5"
someValue = nil
print("值是 \(someValue ??? "unknown")")
// "值是 unknown"
这是一个很小的改变,但我很喜欢
[1]. 我最开始其实觉得重载 ?? 就好了. 我喜欢这种方式是因为我的视线更加符合解包符号的含义,但这也会在某些情况下失去了类型安全的优点,因为总是会被编译成 someOptional ?? "someValue" 的形式
译者注
我想特别说明一点是,在我们的项目里,重载 ?? 或者是自定义操作符 ??? 实际上是不会影响到我们引入的库的,我们定义的 ?? 和 ??? 都是默认 internal 的,也就是说作用域只在 Module 内,怎么用都是没问题的. 当然,如果是多人协作的情况就要权衡沟通成本和实际带来便捷了.
如果是我们自己想写框架的话,声明为 internal,然后就放心大胆的用吧,不会污染到外部作用域的
但我不太确定声明为 public 的话会发生什么事情,根据我在 medium 上看到的这篇文章,至少在 Swift 1.0 的时候,这么做是真的会污染全局的,Swift 团队后来也没提到过对于这样的做法有怎样的优化,所以我估计还是会污染全局的
如果有了解的人,或者已经做过测试的人,可以的话告诉一下我准确的结果
