Swift 呼叫 Objective-C 的可變引數函式

戴倉薯發表於2018-03-24
SwiftObject函式

這個問題是一個朋友問我怎麼寫，一開始我是拒絕的。我想這種東西網上隨便 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 無情地拒絕了：

Screen Shot 2018-03-24 at 4.49.38 PM.png

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

相關文章