準備把 swift 文檔再掃一遍，發現了defer這個關鍵字，恕本人愚鈍，以前還從來沒有用過這個呢~ 簡單地列一下這個東西有哪些可以用得上的情景吧~~

defer 是干什么用的

很簡單，用一句話概括，就是 defer block 里的代碼會在函數 return 之前執行，無論函數是從哪個分支 return 的，還是有 throw，還是自然而然走到最后一行。

這個關鍵字就跟 Java 里的 try-catch-finally 的finally一樣，不管 try catch 走哪個分支，它都會在函數 return 之前執行。而且它比 Java 的finally還更強大的一點是，它可以獨立于 try catch 存在，所以它也可以成為整理函數流程的一個小幫手。在函數 return 之前無論如何都要做的處理，可以放進這個 block 里，讓代碼看起來更干凈一些~

下面是 swift 文檔上的例子：

var fridgeIsOpen = false
let fridgeContent = ["milk", "eggs", "leftovers"]
 
func fridgeContains(_ food: String) -> Bool {
    fridgeIsOpen = true
    defer {
        fridgeIsOpen = false
    }
    
    let result = fridgeContent.contains(food)
    return result
}
fridgeContains("banana")
print(fridgeIsOpen)

這個例子里執行的順序是，先fridgeIsOpen = true，然后是函數體正常的流程，最后在 return 之前執行 fridgeIsOpen = false。

幾個簡單的使用場景

try catch 結構

最典型的場景，我想也是 defer 這個關鍵字誕生的主要原因吧：

func foo() {
  defer {
    print("finally")
  }
  do {
    throw NSError()
    print("impossible")
  } catch {
    print("handle error")
  }
}

不管 do block 是否 throw error，有沒有 catch 到，還是 throw 出去了，都會保證在整個函數 return 前執行 defer。在這個例子里，就是先 print 出 "handle error" 再 print 出 "finally"。

do block 里也可以寫 defer：

do {
  defer {
    print("finally")
  }
  throw NSError()
  print("impossible")
} catch {
  print("handle error")
}

那么它執行的順序就會是在 catch block 之前，也就是先 print 出 "finally" 再 print 出 "handle error"。

清理工作、回收資源

跟 swift 文檔舉的例子類似，defer一個很適合的使用場景就是用來做清理工作。文件操作就是一個很好的例子：

關閉文件

func foo() {
  let fileDescriptor = open(url.path, O_EVTONLY)
  defer {
    close(fileDescriptor)
  }
  // use fileDescriptor...
}

這樣就不怕哪個分支忘了寫，或者中間 throw 個 error，導致 fileDescriptor 沒法正常關閉。還有一些類似的場景：

dealloc 手動分配的空間

func foo() {
  let valuePointer = UnsafeMutablePointer<T>.allocate(capacity: 1)
  defer {
    valuePointer.deallocate(capacity: 1)
  }
  // use pointer...
}

加/解鎖：下面是 swift 里類似 Objective-C 的 synchronized block 的一種寫法，可以使用任何一個 NSObject 作 lock

func foo() {
  objc_sync_enter(lock)
  defer { 
    objc_sync_exit(lock)
  }
  // do something...
}

像這種成對調用的方法，可以用 defer 把它們放在一起，一目了然。

調 completion block

這是一個讓我感覺“如果當時知道 defer ”就好了的場景，就是有時候一個函數分支比較多，可能某個小分支 return 之前就忘了調 completion block，結果藏下一個不易發現的 bug。用 defer 就可以不用擔心這個問題了：

func foo(completion: () -> Void) {
  defer {
    self.isLoading = false
    completion()
  }
  guard error == nil else { return } 
  // handle success
}

有時候 completion 要根據情況傳不同的參數，這時 defer 就不好使了。不過如果 completion block 被存下來了，我們還是可以用它來確保執行后能釋放：

func foo() {
  defer {
    self.completion = nil
  }
  if (succeed) {
    self.completion(.success(result))
  } else {
    self.completion(.error(error))
  }
}

調 super 方法

有時候 override 一個方法，主要目的是在 super 方法之前做一些準備工作，比如 UICollectionViewLayout 的 prepare(forCollectionViewUpdates:)，那么我們就可以把調用 super 的部分放在 defer 里：

func override foo() {
  defer {
    super.foo()
  }
  // some preparation before super.foo()...
}

一些細節

任意 scope 都可以有 defer

雖然大部分的使用場景是在函數里，不過理論上任何一個 { } 之間都是可以寫 defer 的。比如一個普通的循環：

var sumOfOdd = 0
for i in 0...10 {
  defer {
    print("Look! It's \(i)")
  }
  if i % 2 == 0 {
    continue
  }
  sumOfOdd += i
}

continue 或者 break 都不會妨礙 defer 的執行。甚至一個平白無故的 closure 里也可以寫 defer：

{
  defer { print("bye!") }
  print("hello!")
}

就是這樣沒什么意義就是了……

必須執行到 defer 才會觸發

假設有這樣一個問題：一個 scope 里的 defer 能保證一定會執行嗎？
答案是否……比如下面這個例子：

func foo() throws {
  do {
    throw NSError()
    print("impossible")
  }
  defer {
    print("finally")
  }
}
try?foo()

不會執行 defer，不會 print 任何東西。這個故事告訴我們，至少要執行到 defer 這一行，它才保證后面會觸發。同樣道理，提前 return 也是一樣不行的：

func foo() {
  guard false else { return }
  defer {
    print("finally")
  }
}

多個 defer

一個 scope 可以有多個 defer，順序是像棧一樣倒著執行的：每遇到一個 defer 就像壓進一個棧里，到 scope 結束的時候，后進棧的先執行。如下面的代碼，會按 1、2、3、4、5、6 的順序 print 出來。

func foo() {
  print("1")
  defer {
    print("6")
  }
  print("2")
  defer {
    print("5")
  }
  print("3")
  defer {
    print("4")
  }
}

但是我強烈建議不要這么寫。我是建議一個 scope 里不要有多個 defer，感覺除了讓讀代碼的人感覺混亂之外沒有什么好處。

參考資料

What is the Swift equivalent to Objective-C's “@synchronized”?