Kotlin-Swift互操作指南

概述

Kotlin/Native提供了与Objective-C的双向互操作性。Kotlin不直接与Swift互操作，而是通过Objective-C桥接间接互操作。这样做有两个原因：

<ul> <li>它允许所有iOS项目（无论是用Objective-C还是Swift编写）使用共享的Kotlin代码</li> <li>当做出这个决定时，Swift仍在走向成熟和主流采用的道路上</li> </ul> Kotlin/Native编译器生成Objective-C头文件，Swift代码可以导入这些头文件。这对Swift开发有以下影响： <ul> <li>一些功能可以完全按预期工作</li> <li>一些功能需要小小的变通方法</li> <li>一些功能使用社区解决方案效果更好</li> <li>一些功能目前无法最优工作</li> <li>一些功能无法工作</li> </ul> <table><tr><td>Swift导出，即将Kotlin API直接导出为Swift声明而不是Objective-C头文件，是Kotlin团队目前正在开发的功能，这将解决Swift开发者在使用共享Kotlin代码时遇到的一些困难。</td></tr></table>

如何使用

互操作指南

这个不同Kotlin语言特性的互操作指南分为以下几个广泛类别：

概述
函数和属性
更多关于函数的内容
类型
类和接口
协程
扩展
泛型

每个语言特性都有自己的文章，包括对该特性的解释、Kotlin示例代码、如何从Swift调用这些代码（如果可能的话），以及如果Swift代码不够惯用时的额外改进建议。

你可以在互操作指南中搜索你感兴趣的特定语言特性，或者按顺序阅读所有文章以全面了解Kotlin/Swift互操作性。

Kotlin/Swift互操作示例应用

iOS应用程序的组织方式与互操作指南相同，分为相同的广泛类别。点击特定语言特性将：

显示该特性的互操作性摘要。
运行与该特性相关的代码示例，并在控制台中打印结果。

你可以编辑代码，重新运行应用程序，并查看输出的变化。

概述

<table> <tr><td><a href="/docs/overview/Classes%20and%20functions.md">类和函数</a></td><td>你可以从Swift实例化Kotlin类并调用Kotlin函数：SimpleClass().simpleFunction()。</td></tr> <tr><td><a href="/docs/overview/Top-level%20functions.md">顶层函数</a></td><td>你可以通过包装类访问顶层函数：TopLevelFunctionKt.topLevelFunction()。</td></tr> <tr><td><a href="/docs/overview/Types.md">类型</a></td><td>简单类型和自定义类型可以作为参数传递，并从函数调用中返回。</td></tr> <tr><td><a href="/docs/overview/Collections.md">集合</a></td><td>Kotlin和Swift有非常相似的集合类型，可以相互映射。</td></tr> <tr><td><a href="/docs/overview/Exceptions.md">异常</a></td><td>如果你调用一个抛出异常但未使用`@Throws`声明的Kotlin函数，那会导致应用程序崩溃。已声明的异常会转换为NSError，必须进行处理。</td></tr> <tr><td><a href="/docs/overview/PublicAPI.md">公共API</a></td><td>公共类、函数和属性在Swift中可见。将类、函数和属性标记为internal将使它们从共享代码的公共API中排除，在Swift中不可见。</td></tr> <tr><td><a href="/docs/overview/ObjCName.md">互操作注解 - @ObjCName</a></td><td>为Kotlin构造（如类、函数等）提供更好的Objective-C/Swift名称，而无需实际重命名Kotlin构造。实验性功能。</td></tr> <tr><td><a href="/docs/overview/HiddenFromObjC.md">互操作注解 - @HiddenFromObj</a></td><td>从Objective-C/Swift中隐藏Kotlin声明。实验性功能。</td></tr> <tr><td><a href="/docs/overview/ShouldRefineInSwift.md">互操作注解 - @ShouldRefineInSwift</a></td><td>帮助用Swift编写的包装器替换Kotlin声明。实验性功能。</td></tr> <tr><td><a href="/docs/overview/KDocComments.md">KDoc注释</a></td><td>你可以在开发时看到某些KDoc注释。在Xcode中，使用Option+双击左键查看文档。请注意，许多KDoc功能在Xcode中不起作用，例如构造函数上的属性（@property）不可见。在Fleet中，使用"显示文档"操作。</td></tr> </table> ## 函数和属性 <table> <tr><td><a href="/docs/functionsandproperties/Member%20functions.md">成员函数</a></td><td>你可以从Swift调用公共成员函数。内部或私有声明不可见。</td></tr> <tr><td><a href="/docs/functionsandproperties/Constructors.md">构造函数</a></td><td>你可以调用构造函数从Swift创建Kotlin类。</td></tr> <tr><td><a href="/docs/functionsandproperties/Read-only%20member%20properties.md">只读成员属性</a></td><td>成员val属性可从Swift访问，在Swift中是只读属性。</td></tr> <tr><td><a href="/docs/functionsandproperties/Mutable%20member%20properties.md">可变成员属性</a></td><td>成员var属性可从Swift访问，在Swift中是可变属性。</td></tr> <tr><td><a href="/docs/functionsandproperties/Top-level%20val%20properties.md">顶层val属性（只读）</a></td><td>你可以通过包装类访问顶层属性：TopLevelPropertyKt.topLevelProperty。</td></tr> <tr><td><a href="/docs/functionsandproperties/Top-level%20mutable%20var%20properties.md">顶层var属性（可变）</a></td><td>你可以通过包装类访问顶层属性：TopLevelMutablePropertyKt.topLevelProperty。</td></tr> <tr><td><a href="/docs/functionsandproperties/Functions%20expecting%20lambda%20arguments.md">期望lambda参数的函数</a></td><td>你可以从Swift无问题地使用期望一个或多个lambda作为参数的函数。</td></tr> <tr><td><a href="/docs/functionsandproperties/Functions%20returning%20function%20type.md">返回函数类型的函数</a></td><td>你可以调用返回lambda的Kotlin函数。结果有Swift函数类型，如() -> String，所以你可以轻松调用它。</td></tr> </table>

类型

<table> <tr><td><a href="/docs/types/Basic%20types.md">基本类型</a></td><td>整数数据类型可能需要映射，Char也需要映射。</td></tr> <tr><td><a href="/docs/types/Optional%20basic%20types.md">可选基本类型</a></td><td>一些基本类型需要映射到特殊的可选类型。</td></tr> <tr><td><a href="/docs/types/Collections%20with%20custom%20types.md">带自定义类型的集合</a></td><td>元素为自定义类型的集合不需要额外映射。</td></tr> <tr><td><a href="/docs/types/Collections%20with%20basic%20types.md">带基本类型的集合</a></td><td>元素为基本类型（除String外）的集合需要包装器。</td></tr> <tr><td><a href="/docs/types/Mutable,%20immutable%20collections.md">可变、不可变集合</a></td><td>使用let和var关键字调整可变性。可变集合需要额外映射。</td></tr> <tr><td><a href="/docs/types/Unit%20and%20Nothing.md">Unit和Nothing</a></td><td>Unit和Nothing类型可以像在Kotlin中一样使用：Unit作为对象或void，Nothing不能被创建。</td></tr> </table> ## 类和接口 <table> <tr><td><a href="/docs/classesandinterfaces/Abstract%20classes.md">抽象类</a></td><td>Xcode 没有提示重写抽象方法的功能，相反，我们在运行时尝试使用该方法时会发生崩溃。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Annotation%20classes.md">注解类</a></td><td>不支持注解，也不会包含在 .h 文件中。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Data%20classes.md">数据类</a></td><td>一些自动生成的函数被转换为 Swift：copy 变为 doCopy，equals 变为 isEquals，toString 变为 description。其他功能，如解构，不被支持。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Enum%20classes.md">枚举类</a></td><td>Swift 端不会生成等效的枚举，且在 switch 表达式中必须指定默认情况。相反，会生成一个带有静态元素的对象。使用 SKIE 可获得改进的互操作性。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Inner%20classes.md">内部类</a></td><td>创建语法略有不同。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Open%20classes.md">开放类</a></td><td>可以继承开放类，使用其受保护的属性，重写开放方法，但不能重写 final 方法。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Sealed%20classes.md">密封类</a></td><td>生成一个带有继承者的类。在 switch 语句中传递时需要一个默认情况。使用 SKIE 可获得改进的互操作性。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Inline%20classes.md">内联类</a></td><td>不支持此功能。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Objects.md">对象</a></td><td>你可以通过共享辅助对象访问 Kotlin 对象：MyKotlinObject.shared.myProperty。</td> <tr><td><a href="/docs/classesandinterfaces/Companion%20objects.md">伴生对象</a></td><td>你可以从 Swift 中通过 `companion` 辅助对象显式访问 Kotlin 伴生对象的成员：ClassWithCompanionObject.companion.CONST_VAL_EXAMPLE。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Fun%20interfaces.md">函数式接口</a></td><td>在 Swift 中不能创建匿名类。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Interfaces.md">接口</a></td><td>接口变成了 @protocol。Xcode 在生成存根时将 val 属性转换为 var。</td></tr> <tr><td><a href="/docs/classesandinterfaces/Sealed%20interfaces.md">密封接口</a></td><td>生成彼此无关的单独协议。</td></tr> </table>

协程

<table> <tr><td><a href="/docs/coroutines/Suspend%20functions.md">挂起函数</a></td><td>转换为回调，实验性地转换为 async / await。可以使用 SKIE 和 KMP-NativeCoroutines 等库来改善互操作性并提供取消支持。</td></tr> <tr><td><a href="/docs/coroutines/Flows.md">流</a></td><td>转换为回调，实验性地转换为 async / await。泛型类型参数会丢失。可以使用 SKIE 和 KMP-NativeCoroutines 等库来改善互操作性并提供取消支持。</td></tr> </table>

扩展

<table> <tr><td><a href="/docs/extensions/Extension%20functions%20over%20platform%20class.md">平台类的扩展函数</a></td><td>出现一个包装类，其中有一个接受所需类对象的函数。</td></tr> <tr><td><a href="/docs/extensions/Extension%20functions%20over%20usual%20class.md">普通类的扩展函数</a></td><td>可以在类对象上使用该函数。</td></tr> <tr><td><a href="/docs/extensions/Extension%20properties%20over%20platform%20class.md">平台类的扩展属性</a></td><td>出现一个包装类，其中有一个接受所需类对象的函数。</td> <tr><td><a href="/docs/extensions/Extension%20properties%20over%20usual%20class.md">普通类的扩展属性</a></td><td>可以通过类对象访问该属性。</td> <tr><td><a href="/docs/extensions/Extension%20properties%20for%20companion%20object%20of%20platform%20class.md">平台类伴生对象的扩展属性</a></td><td>.h 文件中有一个属性，但在 Swift 中无法使用。</td></tr> <tr><td><a href="/docs/extensions/Extension%20properties%20for%20companion%20object%20of%20usual%20class.md">普通类伴生对象的扩展属性</a></td><td>可以通过伴生对象访问该属性。</td> </table>

泛型

<table> <tr><td><a href="/docs/generics/Generic%20classes.md">泛型类</a></td><td>支持一些功能。</td></tr> <tr><td><a href="/docs/generics/Generic%20functions.md">泛型函数</a></td><td>不支持自动类型推断和可空性。</td></tr> <tr><td><a href="/docs/generics/Bounded%20generics.md">有界泛型</a></td><td>不支持泛型类型限制。</td></tr> <tr><td><a href="/docs/generics/Contravariant%20generics.md">逆变泛型</a></td><td>需要类型转换。</td></tr> <tr><td><a href="/docs/generics/Covariant%20generics.md">协变泛型</a></td><td>需要类型转换。</td></tr> <tr><td><a href="/docs/generics/Reified%20functions.md">具体化函数</a></td><td>具体化函数在运行时崩溃。</td></tr> <tr><td><a href="/docs/generics/Star%20projection.md">星号投影</a></td><td>需要类型转换。</td></tr> <tr><td><a href="/docs/generics/Generic%20interfaces.md">泛型接口</a></td><td>不支持泛型接口。</td></tr> </table>

功能支持回顾

一些功能完全按预期工作

<ul> <li>类和函数</li> <li>成员属性（只读或可变）</li> <li>高阶函数（lambda作为参数或返回值）</li> <li>包含自定义类型的集合</li> <li>Unit和Nothing</li> <li>抽象类</li> <li>开放类</li> <li>接口</li> <li>普通类的扩展函数</li> <li>普通类的扩展属性</li> </ul>

一些特性通过小技巧可以实现

<ul> <li>顶层函数</li> <li>顶层属性（只读或可变）</li> <li>异常</li> <li>函数重载</li> <li>带默认参数的函数</li> <li>期望带接收者的lambda的函数</li> <li>带接收者的函数</li> <li>基本类型</li> <li>可选的基本类型</li> <li>包含基本类型的集合</li> <li>可变/不可变集合</li> <li>枚举类</li> <li>内部类</li> <li>密封类</li> <li>对象</li> <li>伴生对象</li> <li>密封接口</li> <li>平台类的扩展函数</li> <li>平台类的扩展属性</li> <li>普通类伴生对象的扩展属性</li> </ul>

一些特性使用社区解决方案效果更好

一些特性目前运行不太理想（谨慎使用）

一些特性无法正常工作（不要使用）

<ul> <li>带值类参数的函数</li> <li>带可变参数的函数</li> <li>内联函数</li> <li>注解</li> <li>内联类</li> <li>函数式接口</li> <li>平台类伴生对象的扩展属性</li> <li>有界泛型</li> <li>具体化函数</li> <li>泛型接口</li> </ul>