Swift Optional嵌套介绍

一、Optional介绍

在 Swift 的世界里，一切皆对象，包括 Int Float 这些基本数据类型，所以我们可以这么写：print(1.description)。

而对象一般都是存储在指针中，Swift 也不例外，这就造成了一个问题，指针为空的情况需要处理。在 Objective-C 中，向一个 nil 的对象发消息是默认不产生任何效果的行为，但是在 Swift 中，这种行为被严格地禁止了。

Swift 是一个强类型语言，它希望在编译期做更多的安全检查，所以引入了类型推断。而类型推断上如果要做到足够的安全，避免空指针调用是一个最基本的要求。于是，Optional 这种类型出现了。Optional 在 Swift 语言中其实是一个枚举类型：

public enum Optional<Wrapped> : _Reflectable, NilLiteralConvertible {
    case None
    case Some(Wrapped)
}

二、Optional的嵌套

Optional 类型的变量，在使用时，大多需要用if let的方式来解包。如果你没有解包而直接使用，编辑器通过类型推断会提示你，所以看起来这套机制工作得很好。但是，如果 Optional 嵌套层次太多，就会造成一些麻烦，下面我们来看一个例子。

let a: Int? = 1
let b: Int?? = a
let c: Int??? = b

可以通过命令fr v -R，查看内部结构

(lldb) fr v -R a
(Swift.Optional<Swift.Int>) a = some {
  some = {
    _value = 1
  }
}
(lldb) fr v -R b
(Swift.Optional<Swift.Optional<Swift.Int>>) b = some {
  some = some {
    some = {
      _value = 1
    }
  }
}
(lldb) fr v -R c
(Swift.Optional<Swift.Optional<Swift.Optional<Swift.Int>>>) c = some {
  some = some {
    some = some {
      some = {
        _value = 1
      }
    }
  }
}

从这个示例代码中，我们能看出来多层嵌套的 Optional 的具体内存结构。这个内存结构其实是一个类似二叉树一样的形状，如下图所示：

那么问题来了，看起来这个 Optional.None 可以出现在每一层，那么在每一层的效果一样吗？我做了如下实验：

let a: Int? = nil
let b: Int?? = a
let c: Int??? = b
let d: Int??? = nil

如果你在 playground 上看，它们的值都是 nil，但是它们的内存布局却不一样，特别是变量 c 和 变量 d：

(lldb) fr v -R a
(Swift.Optional<Swift.Int>) a = none {
  some = {
    _value = 0
  }
}
(lldb) fr v -R b
(Swift.Optional<Swift.Optional<Swift.Int>>) b = some {
  some = none {
    some = {
      _value = 0
    }
  }
}
(lldb) fr v -R c
(Swift.Optional<Swift.Optional<Swift.Optional<Swift.Int>>>) c = some {
  some = some {
    some = none {
      some = {
        _value = 0
      }
    }
  }
}
(lldb) fr v -R d
(Swift.Optional<Swift.Optional<Swift.Optional<Swift.Int>>>) d = none {
  some = some {
    some = some {
      some = {
        _value = 0
      }
    }
  }
}

• 变量 c 因为是多层嵌套的 nil，所以它在最外层的二叉树上的值，是一个 Optional<Optional<Int>>。
• 变量 d 因为是直接赋值成 nil，所以它在最外层的二叉树上的值，是一个 Optional.None。

let a: Int? = nil
let b: Int?? = a
let c: Int??? = b
let d: Int??? = nil
if let _ = c {
    print("c is not none")
}
if let _ = d {
    print("d is not none")
}

麻烦的事情来了，以上原因会造成用 if let 来判断变量 c 是否为 nil 失效了。如下代码最终会输出 c is not none。

解释
在我看来，这个问题的根源是：一个 Optional 类型的变量可以接受一个非 Optional 的值。拿上面的代码举例，a 的类型是 Int?，b 的类型是 Int??，但是 a 的值却可以赋值给 b。所以，变量 b（类型为 Int??），它可以接受以下几种类型的赋值：

• 1.nil 类型
• 2.Int? 类型
• 3.Int?? 类型

按理说，Swift 是强类型，等号左右两边的类型不完全一样，为什么能够赋值成功呢？我查了一下 Optional 的源码，原来是对于上面第 1，2 种类型不一样的情况，Optional 定义了构造函数来构造出一个 Int?? 类型的值，这样构造之后，等号左右两边就一样了。
源码摘录：

public enum Optional<Wrapped> : _Reflectable, NilLiteralConvertible {
  case None
  case Some(Wrapped)
  @available(*, unavailable, renamed="Wrapped")
  public typealias T = Wrapped
  /// Construct a `nil` instance.
  @_transparent
  public init() { self = .None }
  /// Construct a non-`nil` instance that stores `some`.
  @_transparent
  public init(_ some: Wrapped) { self = .Some(some) }
}

先看一个例子

var dict :[String:String?] = [:]
// first try
dict = ["key": "value"]
dict["key"] = Optional<Optional<String>>.none
print(dict)
// second try
dict = ["key": "value"]
dict["key"] = Optional<String>.none
print(dict)
// third try
dict = ["key": "value"]
dict["key"] = nil
print(dict)
// forth try
dict = ["key": "value"]
let nilValue:String? = nil
dict["key"] = nilValue
print(dict)
// fifth try
dict = ["key": "value"]
let nilValue2:String?? = nil
dict["key"] = nilValue2
print(dict)

执行结果

[:]
["key": nil]
[:]
["key": nil]
[:]

结果分析：
我们可以看到，以下三种方式可以成功删除 key-value 键值对：

• dict["key"] = Optional<Optional<String>>.None
• dict["key"] = nil
• let nilValue2:String?? = nil; dict["key"] = nilValue2

我们发现，一个 [String: String?] 的 Dictionary，可以接受以下类型的赋值：

• nil
• String
• String?
• String??

如果要删除这个 Dictionary 中的元素，必须传入 nil 或 Optional<Optional<String>>.None ，而如果传入 Optional<String>.None，则不能正常删除元素。

造成上述现象的原因：

public subscript(key: Key) -> Value? {
  get {
    return _variantStorage.maybeGet(key)
  }
  set(newValue) {
    if let x = newValue {
      // FIXME(performance): this loads and discards the old value.
      _variantStorage.updateValue(x, forKey: key)
    }
    else {
      // FIXME(performance): this loads and discards the old value.
      removeValueForKey(key)
    }
  }
}

所以，当 Dictionary 的 value 类型为 String 时，如果你要设置它的值，它接受的是一个 String? 类型的参数。而因为我们刚刚例子中的 value 类型为 String?，所以正常情况下它需要的是一个 String?? 类型的参数。在上面的失败的例子中，我们传递的是一个 String? 类型的值，具体值为 Optional<String>.None，于是在执行时就会按以下的步骤来进行：
我们传递一个值为 Optional<String>.None，类型为 String? 的参数。
因为传的参数类型是 String?，而函数需要的是 String??，所以会执行 Optional 的构造函数，构造一个两层的 Optional。
这个两层 Optional 的值为 Optional.Some(<Optional<String>.None>)
进入到 Dictionary 的实现时，会用 if let 进行是否为 nil 的判断，因为两层的 Optional，所以 if let 判断它不是 nil。
所以代码执行到 _variantStorage.updateValue(x, forKey: key)，把 Optional.None 当成值，设置给了相应的 key。

总结

• Optional 可以多层嵌套。
• 因为 Optional 的构造函数支持，所以可以将一个类型为 T 的值，赋值给一个类型为 T? 的变量。
• 因为 Optional 的构造函数支持，所以可以将 nil 赋值给一个任意嵌套层数的 Optional 变量。
• 将 Optional 嵌套的内容是 nil 时，大家要小心 if let 操作失效问题。
• 多层 Optional 嵌套容易烧脑细胞，尽量避免在工程中使用或触发。

参考：
http://blog.devtang.com/2016/02/27/swift-gym-1-nested-optional/