Swift 調用 Objective-C 的可變參數函數

這個問題是一個朋友問我怎麼寫，一開始我是拒絕的。我想這種東西網上隨便 google 下不就有了嗎。他說，查了，但沒大看明白。因而我就查了下，沒想到這個寫法確實有點詭異，我第一反應也沒看明白。因此隨便水一篇文章，強行完成本週的博客任務，順便給朋友一個交代。

本文分爲兩部分，第一部分是 Swift 怎麼調用 Objective-C 的可變參數函數，第二部分是 Objective-C 怎麼調用 Swift 的可變參數函數。

Swift 調用 Objective-C 的可變參數函數

先寫一個例子

隨便寫一個 Objective-C 的可變參數函數：接受 n 個 String 類型的參數，把它們一個一個地打印出來，而後返回參數一共有多少個。這個方法毫無心義，只是爲了強行有個返回值作例子編出來的而已……

- (NSInteger)foo:(NSString *)value,...
{
  va_list list;
  va_start(list, value);
  NSInteger count = 0;
  while (YES)
  {
    NSString *string = va_arg(list, NSString*);
    if (!string) {
      break;
    }
    NSLog(@"%@",string);
    count++;
  }
  va_end(list);
  return count;
}
複製代碼

這個方法直接在 swift 裏調是調不了的。爲了想要在 swift 裏調用，須要把它稍微改造下。

怎麼改造一下

1. 把方法簽名裏的 ,... 改爲一個參數 args:(va_list)list
2. va_list list; 和 va_start(list, value); 這兩句須要去掉，由於咱們的 va_list 是傳進來的。va_end 應該也能夠去掉了，不去掉也不會報錯，也許也能夠保留着做爲一個 good practice 吧。

改完以後的 Objective-C 方法：

- (NSInteger)foo:(va_list)list
{
  NSInteger count = 0;
  while (YES)
  {
    NSString *string = va_arg(list, NSString*);
    if (!string) {
      break;
    }
    NSLog(@"%@",string);
    count++;
  }
  return count;
}
複製代碼

在 Swift 裏怎麼調用

既然 va_list 是做爲一個參數傳進去的，關鍵是要用特殊方法構造一個 va_list。就跟在 Objective-C 裏能夠用 malloc 來強行構造 va_list 同樣，Swift 裏也有辦法，有一個函數能夠用：

public func withVaList<R>(_ args: [CVarArg], _ body: (CVaListPointer) -> R) -> R
複製代碼

這個函數的形式看起來不大常見，其實也很簡單，它就是接受一個數組做爲第一個參數，第二個參數是個閉包，閉包的參數就是生成好的va_list，而返回值你隨便返回什麼均可以，閉包的返回值就是整個函數的返回值。

換句話說，就是你先傳給它一個數組，讓它根據這個數組構造 va_list；而後它把構造好的 va_list 用閉包的參數傳回來給你，那麼在閉包裏這個 va_list 就隨你怎麼用了；若是閉包裏你有什麼結果想傳出去的，能夠做爲閉包的返回值返回，它就會做爲這個函數的返回值傳出去，接受了這個返回值，後面就隨你怎麼用了。

let testClass = TestClass()
let count = withVaList(["hello", "hamster", "good", "morning"]) { args -> Int in
   return testClass.foo(args)
}
print(count)
複製代碼

輸出：

hello
hamster
good
morning
4
複製代碼

文檔裏說了，這個生成的 va_list 只許你在閉包裏用，你不準把它傳出去在外面用，否則不保證 valid。讓咱們皮一下試試……

let testClass = TestClass()
let args = withVaList(["hello", "hamster", "good", "morning"]) { args -> CVaListPointer in
  return args
}
print(testClass.foo(args))
複製代碼

結果是 crash，EXC_BAD_ACCESS，估計是到了閉包外面那塊空間已經被釋放掉了。這也從側面證實了不須要再寫 va_end 了吧……

還有另外一個相似的函數 getVaList，把 va_list 做爲返回值返回出來的，寫法更簡潔，把上面的寫法改改就是這樣：

let count = testClass.foo(getVaList(["hello", "hamster", "good", "morning"]))
print(count)
複製代碼

可是文檔明確說了兩點：

1. 能用 withVaList 就不要用 getVaList。具體緣由沒說。
2. 那爲啥還要提供給你這個方法呢？是由於有些狀況語言規則不讓用 withVaList，好比在 class initializer 裏。這時候就只好用 getVaList 了。

包裝成 Swift 的可變參數方法

上面這語法，若是要用得不少，每次都這麼寫怪煩的。咱們能夠給它包裝成一個 Swift 的可變參數方法……

extension TestClass {
  func foo(_ strings: String...) -> Int {
    return withVaList(strings) { args -> Int in
      return foo(args)
    }
  }
}
複製代碼

而後調用的時候就一勞永逸了：

let testClass = TestClass()
let count = testClass.foo("hello", "hamster", "good", "morning")
print(count)
複製代碼

感慨下 Swift 的語法簡潔太多了，不是嗎？

Objective-C 調用 Swift 的可變參數函數

既然 Swift 的語法這麼簡潔，咱們乾脆把可變參數方法都在 Swift 裏實現，而後讓 Objective-C 來調唄？

然而 Swift 無情地拒絕了：

真的要調怎麼辦？只好另寫一個接受數組爲參數的方法，在 Objective-C 裏調這個方法，或者再寫一個 Objective-C 的可變參數方法把它 wrap 一層了……