×

Swift 调用 Objective-C 的可变参数函数

96
戴仓薯
2018.03.25 02:19 字数 1122

这个问题是一个朋友问我怎么写,一开始我是拒绝的。我想这种东西网上随便 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 一层了……

仓薯的 swift 小 tips
Web note ad 1