Kotlin-Swift互操作指南
概述
Kotlin/Native提供了与Objective-C的双向互操作性。Kotlin不直接与Swift互操作,而是通过Objective-C桥接间接互操作。这样做有两个原因:
- 它允许所有iOS项目(无论是用Objective-C还是Swift编写)使用共享的Kotlin代码
- 当做出这个决定时,Swift仍在走向成熟和主流采用的道路上
Kotlin/Native编译器生成Objective-C头文件,Swift代码可以导入这些头文件。这对Swift开发有以下影响:
- 一些功能可以完全按预期工作
- 一些功能需要小小的变通方法
- 一些功能使用社区解决方案效果更好
- 一些功能目前无法最优工作
- 一些功能无法工作
Swift导出,即将Kotlin API直接导出为Swift声明而不是Objective-C头文件,是Kotlin团队目前正在开发的功能,这将解决Swift开发者在使用共享Kotlin代码时遇到的一些困难。 |
如何使用
互操作指南
这个不同Kotlin语言特性的互操作指南分为以下几个广泛类别:
- 概述
- 函数和属性
- 更多关于函数的内容
- 类型
- 类和接口
- 协程
- 扩展
- 泛型
每个语言特性都有自己的文章,包括对该特性的解释、Kotlin示例代码、如何从Swift调用这些代码(如果可能的话),以及如果Swift代码不够惯用时的额外改进建议。
你可以在互操作指南中搜索你感兴趣的特定语言特性,或者按顺序阅读所有文章以全面了解Kotlin/Swift互操作性。
Kotlin/Swift互操作示例应用
iOS应用程序的组织方式与互操作指南相同,分为相同的广泛类别。点击特定语言特性将:
- 显示该特性的互操作性摘要。
- 运行与该特性相关的代码示例,并在控制台中打印结果。
你可以编辑代码,重新运行应用程序,并查看输出的变化。
概述
类和函数 | 你可以从Swift实例化Kotlin类并调用Kotlin函数:SimpleClass().simpleFunction()。 |
顶层函数 | 你可以通过包装类访问顶层函数:TopLevelFunctionKt.topLevelFunction()。 |
类型 | 简单类型和自定义类型可以作为参数传递,并从函数调用中返回。 |
集合 | Kotlin和Swift有非常相似的集合类型,可以相互映射。 |
异常 | 如果你调用一个抛出异常但未使用`@Throws`声明的Kotlin函数,那会导致应用程序崩溃。已声明的异常会转换为NSError,必须进行处理。 |
公共API | 公共类、函数和属性在Swift中可见。将类、函数和属性标记为internal将使它们从共享代码的公共API中排除,在Swift中不可见。 |
互操作注解 - @ObjCName | 为Kotlin构造(如类、函数等)提供更好的Objective-C/Swift名称,而无需实际重命名Kotlin构造。实验性功能。 |
互操作注解 - @HiddenFromObj | 从Objective-C/Swift中隐藏Kotlin声明。实验性功能。 |
互操作注解 - @ShouldRefineInSwift | 帮助用Swift编写的包装器替换Kotlin声明。实验性功能。 |
KDoc注释 | 你可以在开发时看到某些KDoc注释。在Xcode中,使用Option+双击左键查看文档。请注意,许多KDoc功能在Xcode中不起作用,例如构造函数上的属性(@property)不可见。在Fleet中,使用"显示文档"操作。 |
## 函数和属性
成员函数 | 你可以从Swift调用公共成员函数。内部或私有声明不可见。 |
构造函数 | 你可以调用构造函数从Swift创建Kotlin类。 |
只读成员属性 | 成员val属性可从Swift访问,在Swift中是只读属性。 |
可变成员属性 | 成员var属性可从Swift访问,在Swift中是可变属性。 |
顶层val属性(只读) | 你可以通过包装类访问顶层属性:TopLevelPropertyKt.topLevelProperty。 |
顶层var属性(可变) | 你可以通过包装类访问顶层属性:TopLevelMutablePropertyKt.topLevelProperty。 |
期望lambda参数的函数 | 你可以从Swift无问题地使用期望一个或多个lambda作为参数的函数。 |
返回函数类型的函数 | 你可以调用返回lambda的Kotlin函数。结果有Swift函数类型,如() -> String,所以你可以轻松调用它。 |
更多关于函数
类型
## 类和接口
抽象类 | Xcode 没有提示重写抽象方法的功能,相反,我们在运行时尝试使用该方法时会发生崩溃。 |
注解类 | 不支持注解,也不会包含在 .h 文件中。 |
数据类 | 一些自动生成的函数被转换为 Swift:copy 变为 doCopy,equals 变为 isEquals,toString 变为 description。其他功能,如解构,不被支持。 |
枚举类 | Swift 端不会生成等效的枚举,且在 switch 表达式中必须指定默认情况。相反,会生成一个带有静态元素的对象。使用 SKIE 可获得改进的互操作性。 |
内部类 | 创建语法略有不同。 |
开放类 | 可以继承开放类,使用其受保护的属性,重写开放方法,但不能重写 final 方法。 |
密封类 | 生成一个带有继承者的类。在 switch 语句中传递时需要一个默认情况。使用 SKIE 可获得改进的互操作性。 |
内联类 | 不支持此功能。 |
对象 | 你可以通过共享辅助对象访问 Kotlin 对象:MyKotlinObject.shared.myProperty。 |
伴生对象 | 你可以从 Swift 中通过 `companion` 辅助对象显式访问 Kotlin 伴生对象的成员:ClassWithCompanionObject.companion.CONST_VAL_EXAMPLE。 |
函数式接口 | 在 Swift 中不能创建匿名类。 |
接口 | 接口变成了 @protocol。Xcode 在生成存根时将 val 属性转换为 var。 |
密封接口 | 生成彼此无关的单独协议。 |
协程
挂起函数 | 转换为回调,实验性地转换为 async / await。可以使用 SKIE 和 KMP-NativeCoroutines 等库来改善互操作性并提供取消支持。 |
流 | 转换为回调,实验性地转换为 async / await。泛型类型参数会丢失。可以使用 SKIE 和 KMP-NativeCoroutines 等库来改善互操作性并提供取消支持。 |
扩展
泛型
功能支持回顾
一些功能完全按预期工作
- 类和函数
- 成员属性(只读或可变)
- 高阶函数(lambda作为参数或返回值)
- 包含自定义类型的集合
- Unit和Nothing
- 抽象类
- 开放类
- 接口
- 普通类的扩展函数
- 普通类的扩展属性
一些特性通过小技巧可以实现
- 顶层函数
- 顶层属性(只读或可变)
- 异常
- 函数重载
- 带默认参数的函数
- 期望带接收者的lambda的函数
- 带接收者的函数
- 基本类型
- 可选的基本类型
- 包含基本类型的集合
- 可变/不可变集合
- 枚举类
- 内部类
- 密封类
- 对象
- 伴生对象
- 密封接口
- 平台类的扩展函数
- 平台类的扩展属性
- 普通类伴生对象的扩展属性
一些特性使用社区解决方案效果更好
一些特性目前运行不太理想(谨慎使用)
- 数据类
- 泛型类
- 泛型函数
- 逆变泛型
- 协变泛型
- 星号投影
一些特性无法正常工作(不要使用)
- 带值类参数的函数
- 带可变参数的函数
- 内联函数
- 注解
- 内联类
- 函数式接口
- 平台类伴生对象的扩展属性
- 有界泛型
- 具体化函数
- 泛型接口