Project Icon

kotlin-swift-interopedia

Kotlin 与 Swift 互操作性全面指南

本项目提供 Kotlin 和 Swift 互操作性的详细指南,涵盖基本类型到协程等多种语言特性,并说明它们在两种语言间的转换方法。项目配备交互式 iOS 应用,方便开发者测试代码示例。适合需要在 iOS 项目中集成 Kotlin 代码的开发人员参考。

JetBrains官方项目

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,所以你可以轻松调用它。

更多关于函数

重载函数使用相同参数名称时有一些特殊情况。
带默认参数的函数你总是必须指定所有函数参数。使用SKIE可获得改进的互操作性。
带默认参数的构造函数你总是必须为构造函数指定所有参数。
期望带接收者的lambda的函数扩展函数变成带参数的lambda。
带接收者的函数带接收者的函数变成带参数的函数,这不太方便。
带值类参数的函数函数出现在.h文件中,但内联类参数变成基本类型。
带vararg参数的函数vararg被映射到KotlinArray,而不是Swift的可变参数。
内联函数内联函数在.h文件中,可以被调用。但它们是常规函数,没有内联。

类型

基本类型整数数据类型可能需要映射,Char也需要映射。
可选基本类型一些基本类型需要映射到特殊的可选类型。
带自定义类型的集合元素为自定义类型的集合不需要额外映射。
带基本类型的集合元素为基本类型(除String外)的集合需要包装器。
可变、不可变集合使用let和var关键字调整可变性。可变集合需要额外映射。
Unit和NothingUnit和Nothing类型可以像在Kotlin中一样使用:Unit作为对象或void,Nothing不能被创建。
## 类和接口
抽象类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 等库来改善互操作性并提供取消支持。

扩展

平台类的扩展函数出现一个包装类,其中有一个接受所需类对象的函数。
普通类的扩展函数可以在类对象上使用该函数。
平台类的扩展属性出现一个包装类,其中有一个接受所需类对象的函数。
普通类的扩展属性可以通过类对象访问该属性。
平台类伴生对象的扩展属性.h 文件中有一个属性,但在 Swift 中无法使用。
普通类伴生对象的扩展属性可以通过伴生对象访问该属性。

泛型

泛型类支持一些功能。
泛型函数不支持自动类型推断和可空性。
有界泛型不支持泛型类型限制。
逆变泛型需要类型转换。
协变泛型需要类型转换。
具体化函数具体化函数在运行时崩溃。
星号投影需要类型转换。
泛型接口不支持泛型接口。

功能支持回顾

一些功能完全按预期工作

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

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

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

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

  • 挂起函数
  • Flow

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

  • 数据类
  • 泛型类
  • 泛型函数
  • 逆变泛型
  • 协变泛型
  • 星号投影

一些特性无法正常工作(不要使用)

  • 带值类参数的函数
  • 带可变参数的函数
  • 内联函数
  • 注解
  • 内联类
  • 函数式接口
  • 平台类伴生对象的扩展属性
  • 有界泛型
  • 具体化函数
  • 泛型接口
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号