本文要点

Kotlin Multiplatform让开发者在开发跨平台应用时省去很多重复编写代码逻辑的麻烦。
用KMP并不能做出在各个平台完全共享的代码，因为很多时候UI逻辑需要原生编程，各平台的逻辑很难通用。
Swift和Kotlin语法有很高的相似度，这极大降低了学习使用KMP业务逻辑的难度。
可以使用Android Studio创建可复用的KMP组件，然后将其作为框架导入Xcode项目。

iOS开发者的福音：Kotlin Multiplatform

DRY（避免重复劳动）是编程的基本原则之一，但开发跨平台应用时经常需要重复编写许多代码逻辑。出色的编程工作就是要尽量减少重复劳动，而应用使用的跨平台共享代码越多，重复劳动越少，代码质量也就越高。

想想你正在开发的iOS项目：它是否支持Android或web等平台？如果答案是肯定的，那么你的iOS应用与其它平台的版本共享了多少代码逻辑？如果答案是否定的，但你准备开发支持其它平台的版本，那么跨平台开发会带来多少重复劳动？不管是哪个问题，答案都很可能是”很多“。

了解一下Kotlin Multiplatform（KMP）吧。Kotlin是一种静态类型的编程语言，与Swift有着惊人的相似度，并可与Java完全互操作。从某些角度来看，你可以把它当作是Android上的Swift。KMP是Kotlin的一项功能组件，用它可以在应用的各平台版本之间共享代码，这样各个平台的原生UI就可以调用公共的底层代码了。KMP并不能实现跨平台版本之间完全共享代码，但它也向这一目标迈出了重要的一步。

KMP使用Kotlin来编写跨平台应用中通用的业务逻辑。接下来各个平台的原生UI会调用这些公共逻辑。很多时候UI逻辑还是要原生开发的，因为各个平台的差异太大了。在iOS中，这意味着要将用KMP编写的.frameworkfile像其它外部库一样导入到Xcode项目中。在iOS上使用KMP也要用到Swift语言，所以KMP没法取代Swift。

KMP也可以迭代式引入项目，所以实现KMP不需要中断当前项目，不需要替换现有的Swift代码。你只要在下次为跨平台应用加入新功能的时候使用KMP编写业务逻辑，然后将其部署到各个平台，并开发原生UI就行了。在iOS这边，就是用Kotlin开发业务逻辑并用Swift开发UI逻辑。

Swift和Kotlin的语法高度相似，所以学习用KMP编写业务逻辑会非常容易。需要下功夫学习的就只有一个IDE了：那就是Android Studio。

Kotlin Multiplatform项目仍然是Kotlin的实验性功能组件，所以每次更新后其API都可能有改动。

入门

本教程适用于几乎没接触过Android Studio或Kotlin的iOS开发者。如果你还没有安装Android Studio，请按照安装指南操作。

把我们制作的入门项目克隆下来。它带有一个KMP样板项目，其中有一个空的KMP库。这个入门项目还有一个iOS应用和一个Android应用，两个应用都是用来显示一个URL列表的GIF图片的，列表中有25个硬编码的“meh”URL。

这两个应用是为你准备的，但那个库不是，因为本文的重点就是如何制作一个KMP库，不是教你应用该如何使用KMP库。但请放心，如果你想深入了解Android开发的话，这篇文章教你的知识也会很有用。

你要用KMP编写网络逻辑，在Giphy的公共API中搜索短语“whoa”，获取25个URL，替换掉两个平台中原来的硬编码地址。

现在打开Android Studio，选择Open an existing Android Studio project。在弹出的Finder窗口中选择之前克隆来的启动项目的顶级GifGetter/目录。

如果弹出这个对话框，请按“Update”。

Android Studio

如果你之前没有深入研究过Android Studio，可能就要花些时间先来熟悉它了。这一章会讲解本教程用到的Android Studio的一些功能。如果你想深入了解这个IDE，请点击此处。

首先是基础操作：左边是项目导航器，应该会显示项目的文件结构。如果没看到文件结构，请点击左上角的“Projcet”选项卡，弹出项目导航器。在项目导航器顶部，你很可能会看到标有Android的下拉菜单。点一下，然后在下拉菜单中选择“Project”选项。

Android Studio顶部的按钮行是工具栏。这一栏有许多功能，如构建、运行、调试运行、应用新更改以及启动Android虚拟设备（AVD）管理器。在它下面是导航栏，显示项目文件夹结构中当前打开文件的位置，在本例中为：

/GifGetter/GifLibrary/commonMain/kotlin/platform/common.kt。

以下是工具栏中的一些工具介绍：
锤子图形是Build按钮
旁边的下拉列表是configurations
它旁边是Run按钮，就像在Xcode中一样

Android的官方文档把它叫做工具窗口之一，但人们一般叫它项目结构、文件结构、文件夹结构或类似术语。它和Xcode中的项目导航器是一个用途。

请注意顶部的Project下拉菜单。这里它应该指的是本教程使用的Project。如果它显示的是Android或别的什么内容，请重新选择Project，否则你的文件和文件夹可能会在下面的结构视图里显示不全。

这里是编辑器窗口，写代码用的。注意顶部的文件：android.kt、common.kt、ios.kt和GifLibrary，这些都是当前打开的后台选项卡。右键单击其中一个选项卡就有选项可以在右侧、左侧、顶部或底部打开更多的编辑器窗口。
包在外面一圈的叫工具窗口栏，这里只用到黄圈中的选项卡，尤其是Terminal和Build这俩。

项目结构

下面介绍KMP的项目结构：

**.gradle/和.idea/**文件夹：这里存放的是本地文件，不要把它们提交到多数Android Studio项目会使用的源码管理平台里。它们包括IDE、项目和依赖项的本地设置，因此与本教程无关。
androidApp/文件夹：这是整个KMP项目中Android应用项目的根目录，其中有Android端的所有UI逻辑。
build/文件夹：存放KMP构建的输出。它也不要提交到源代码管理平台上。
iosApp/文件夹：整个KMP项目中Xcode项目的根目录。

GifLibrary/文件夹：KMP逻辑的主目录。它将作为Android项目的业务逻辑，然后KMP将它生成为iOS项目使用的GifLibrary.framework。其中src/文件夹包含以下内容：

androidLibMain：Android平台专用的KMP逻辑
commonMain：不需要任何平台专属代码的KMP业务逻辑
iosMain：iOS平台专用的KMP逻辑，能够与Apple API交互（如UIKit、GCD等）
main：包含一个AndroidManifest.xml文件，该文件将GifLibrary/定义为Android库。很大程度上它就像一个Xcode.plist。

build.gradle：这可能是一个新概念，因为iOS开发中没有直接对应的概念。某种层次上它是一个构建脚本或makefile，用于定义项目的依赖项、脚本和其它设置。这样来看，它也有点像.xcodeproj文件。
External Libraries：项目的所有依赖项。Android和KMP项目与iOS项目的不同之处在于前者需要的外部依赖项要多很多。

项目顶层的其它文件（如local.properties和所有.iml文件）由Android Studio生成，与我们在KMP中的操作无关。另外，settings.gradle是应提交到源代码控制中的配置文件。与build.gradle文件不同，settings.gradle不是构建脚本，而是gradle的配置文件。

现在你已经了解了Android Studio的基础知识，该来研究KMP项目了！

为KMP配置Gradle

注意：如前所述，KMP仍然是实验性组件，因此这些gradle配置很容易发生变化。

打开GifLibrary/build.gradle，然后看kotlin {}块：

kotlin {
   targets {
       fromPreset(presets.android, 'androidLib')


       def buildForDevice = project.findProperty("device")?.toBoolean() ?: false
       def iosPreset = (buildForDevice) ? presets.iosArm64 : presets.iosX64
       def iOSTarget = System.getenv('SDK_NAME')?.startsWith('iphoneos') \
                       ? presets.iosArm64 : presets.iosX64
       fromPreset(iosPreset, 'ios') {
           binaries {
               framework {
                  // Disable bitcode embedding for the simulator build.
                   if (!buildForDevice) {
                       embedBitcode("disable")
                   }
               }
           }
       }


   fromPreset(iOSTarget, 'ios') {
       compilations.main.outputKinds('FRAMEWORK')
   }
}


   sourceSets {
       commonMain {
           dependencies {
               implementation "io.ktor:ktor-client-json:$ktor_version"
           }
       }
   }

这是新建项目常见的KMP gradle配置。首先看一下kotlin {}块内的targets {}块。简单来说，fromPreset() {}为gradle提供了KMP的预设配置。iOS的预设需要额外的代码，因为设备和模拟器构建所需的预设不一样。

然后看一下sourceSets {}块。现在只有commonMain是有其它依赖项的sourceSet，但另外两个sourceSet也需要其它依赖项。在commonMain {}之后将以下内容添加到sourceSets {}：

androidLibMain {
   dependencies {
       implementation "io.ktor:ktor-client-json-jvm:$ktor_version"
   }
}


iosMain {
   dependencies {
       implementation "io.ktor:ktor-client-ios:$ktor_version"
       implementation "io.ktor:ktor-client-json-native:$ktor_version"
   }
}

添加成功后应该会弹出一个消息框说：Gradle files have changed since the last project sync. A project sync may be necessary for the IDE to work properly（自上次项目同步以来Gradle文件已更改。IDE可能需要项目同步才能正常工作）。暂时忽略此消息，因为这个gradle文件还要做很多改动。

现在三个必需的依赖项都已包含在sourceSets中了，但还需要最后一次更改才能让这个gradle准备就绪。在kotlin {}块下面有一个名为copyFramework {}的task，它负责将KMP项目作为iOS框架复制到相应的文件夹中，这样iosApp/ project就能找到它了。

为了确保在项目构建时执行这些task，请在copyFramework {}之后插入下面这行：

tasks.build.dependsOn copyFramework

现在点击Sync Now以更新gradle文件。需要下载新的依赖项时可能要花些时间。你可以在Android Studio底部的标签栏中查看Gradle同步的进度。

探索Giphy的API

先去查阅Giphy的API并创建一个Giphy开发者帐户。如果你已经有帐户就登录进去。然后点击“Create an App”并在出现提示时输入“GifGetter”和描述信息。然后复制新生成的Api密钥。

现在返回Android Studio并打开GifLibrary/src/commonMain/kotlin/GiphyAPI并找到以下类：

class GiphyAPI {
    val apiKey：String =“”
 }

将你的Giphy API密钥粘贴到这个val语句的值中。这就是在Kotlin中声明类和字符串常量的方式。注意到目前为止，所有这些代码都可以用在Swift里，只有val关键字是例外，在Kotlin中它等同于Swift的let。

平台专属代码

针对iOS和Android平台的差异部分，KMP会告诉公共代码在各个平台会得到怎样的反馈。先转到GifLibrary/src/commonMain/kotlin/platform/。点击File→New→Kotlin File/Class，然后创建一个新的Kotlin文件/类并将其命名为common。然后在下面的Kinddropdown菜单中点击File。

这些iOS和Android应用需要做网络调用，因此他们需要运行异步代码。iOS使用Grand Central Dispatch（GCD）处理此类并发操作，但由于Android不使用GCD所以这部分代码不能进入公共部分。相对应的，你要告诉公共代码它们能从各个平台得到的期望expect。本例中，公共代码需要期望获得以下调度器dispatcher：

import kotlinx.coroutines.CoroutineDispatcher


internal expect val dispatcher: CoroutineDispatcher

这里将出现错误，因为iosMan/和androidLibMain/组件现在期望声明一个类型为CoroutineDispatcher的常量命名dispatcher。在iOS这边，转到GifLibrary/src/iosMain/platform/并创建一个名为iOS的新文件粘贴到下面的代码里：

internal actual val dispatcher: CoroutineDispatcher = NsQueueDispatcher(dispatch_get_main_queue())


internal class NsQueueDispatcher(private val dispatchQueue: dispatch_queue_t) : CoroutineDispatcher() {
   override fun dispatch(context: CoroutineContext, block: Runnable) {
       dispatch_async(dispatchQueue.freeze()) {
           block.run()
       }
   }
}

这个逻辑是说，对于iOS平台，KMP将使用GCD获取主队列来运行异步代码。Android这边，转到Android模块中的对应文件夹：GifLibrary/src/androidLibMain/platform/。创建另一个Kotlin文件并将其命名为Android。所幸Android平台上可以轻松获取主调度器：

internal actual val dispatcher: CoroutineDispatcher = Dispatchers.Main

这样应该就不会出现编译错误了，因为commonMain对两个平台各自期望的调度器都已经获得了对应的实现。

准备数据

现在我们需要能够代表我们从Giphy API获得的JSON数据的类。去GifLibrary/src/commonMain/kotlin/中创建一个新的Kotlin文件，将其命名为Data。将以下代码粘贴到新文件中：

import kotlinx.serialization.Serializable


@Serializable
data class GifResult(
       val `data`: List
<
Data
>


)


@Serializable
data class Data(
       val images: Images
)


@Serializable
data class Images(
       val original: Original
)


@Serializable
data class Original(
       val url: Stri

在这个文件顶部必须导入Serializable以识别数据类前面的@Serializable语句。数据类可以视为Swift中的结构。它们不是值类型对象，但它们的行为很像后者。从Giphy API获得的JSON将映射到这些数据类上。现在，commonMain已经为大部分业务逻辑做好了准备。

编写KMP业务逻辑

现在回到GiphyAPI文件并将以下代码粘贴到apiKey下面：

private val client: HttpClient = HttpClient { // 1
   install(JsonFeature) { // 2
       serializer = KotlinxSerializer(Json.nonstrict).apply { // 3
           setMapper(GifResult::class, GifResult.serializer()) // 4
       }
   }
}


private fun HttpRequestBuilder.apiUrl(path: String) { // 5
   url { // 6
       takeFrom("https://api.giphy.com/") // 7
       encodedPath = path // 8
   }
}

下面逐条解释这段代码的效果：

声明一个类型为HttpClient的常量。这一行代码与Swift中写法的唯一区别还是关键字val，不是Swift中的let。
将JsonFeature安装到client对象中，使其能够序列化和反序列化JSON。
实例化并配置serializer，这是HttpClient对象的一个属性，默认值为null。Json.nonstrict格式表示响应的JSON将包含与下一行设置的数据类无关的字段。
为serializer提供顶级数据类，然后它会将响应的JSON序列化为GifResult对象。JSON中的“data”字段将填充对应的GifResult.data属性。这些字段将继续填充嵌套数据类的层次结构。
将函数apiUrl(path：String)添加到HttpRequestBuilder类。
构造一个URL。
提供基础URL。
使用指定的路径扩展URL。

现在有了网络逻辑模版，就该对Giphy的端点做联网调用以获取“whoa”的搜索结果了。在你刚粘贴的网络代码下面添加以下代码：

suspend fun callGiphyAPI(): GifResult = client.get {
   apiUrl(path = "v1/gifs/trending?api_key=$apiKey&limit=25&rating=G")
}

等一下，suspend关键字是哪里来的？有什么用？其实这是通过协程在Kotlin中执行异步代码的一种方法。现在你只要知道这里只能从一个协程或其它挂起函数调用该函数就行了，例如HttpClient上的get {}函数。

下一步是设置可用于iOS和Android应用的函数。这里的语法又很接近Swift：

fun getGifUrls(callback: (List
<
String
>
) -> Unit) { // 1
   GlobalScope.apply { // 2
       launch(dispatcher) { // 3
           val result: GifResult = callGiphyAPI() // 4
           val urls = result.data.map { // 5
               it.images.original.url // 6
           }
           callback(urls) // 7
       }
   }
}

声明函数getGifUrls(callback: (List) → Unit)。Android和iOS代码将会调用这个函数。返回的Unit类型相当于Swift里的void。
在GlobalScope的上下文中运行后面的代码，其中包括它自己的调度器和作业取消逻辑。
启动我们自己的dispatcher，这里不用默认的调度器。记住，调度器的实现在各个平台是不一样的。
声明一个值，等于callGiphyApi()函数返回的值。
映射GifResult对象的数据列表；
映射完毕后就能获得每个url的属性了。url是一个字符串，因此它将映射到List对象。Kotlin中的it关键字表示lambda的参数，这里只有一个参数。
将这个URL列表传递给作为函数参数提供的回调。

在Android平台上实现KMP

Android应用的最后一步是使用从Giphy API获取的URL替换原来的硬编码URL列表。其实这也没那么难啦。

首先打开androidApp/src/main/kotlin/MainActivity文件。Android的Activity与ViewController密切相关，这里MainActivity中实现的第一个函数是onCreate(savedInstanceState:Bundle?)，这与viewDidLoad()有点相似：

override fun onCreate(savedInstanceState: Bundle?) {
   super.onCreate(savedInstanceState)
   setContentView(R.layout.activity_main)


   val gifList: RecyclerView = findViewById(R.id.gif_list)
   val layoutManager = LinearLayoutManager(this)
   gifList.layoutManager = layoutManager


   adapter = GifAdapter(this)
   gifList.adapter = adapter
   adapter.setResults(urls)

删掉这个函数的最后一行（原来这行是用fakedata设定输出的），换成：

getGifUrls {
   adapter.setResults(it)
}

setResults(results: List)这个函数会将获取的gif URL设置为新的数据源并重新加载RecyclerView，后者实际上是UITableView和UICollectionView的Android版本，不过它们还是有一些关键区别的。现在Android这边的所有逻辑就完成了！

如果它没能自动导入，你还遇到了未解决的引用错误，则可能需要将以下内容添加到文件顶部的导入列表中：

import org.gifLibrary.GiphyAPI

在Android模拟器上运行

点击Android Studio顶部工具栏中的“Run”按钮。它的图标与Xcode的“运行”按钮很像。之后Android虚拟设备（AVD）管理器将显示一个窗口，类似Xcode管理模拟器的那个窗口。不同之处在于Xcode里的模拟器是现成的，无需再下载。

在新窗口中，如果你在列表中看到有什么可用的Android设备就选择它运行应用。否则就点击“Create New Virtual Device”。在设备列表中选择Phone类别和Pixel 2 XL，然后点击右下方的Next。

接下来选择Android最新版本旁边的Download，这样会下载API级别最高的系统版本。然后会出现另一个窗口来安装所选的Android版本。要是没看到下载按钮说明你已经下好了，那就选择该版本，然后再点击Next。等系统下载完以后点击Finish就行了。

Android这边就搞定了！好好庆祝一下，体验自己的成果吧。接下来回到熟悉的领域。

Xcode设置

打开Xcode项目并转到iosApp目标的Build Phases并点击**+**，就是下图的红圈部分：

从弹出的列表中选择“New Run Script Phase”选项。你会在主窗口的列表末尾看到一个新的Run Script。将其向上拖动到列表中，使其位于Compile Sources之上。单击它旁边的箭头并粘贴以下脚本：

cd "$SRCROOT/../"
./gradlew GifLibrary:copyFramework \
-Pconfiguration.build.dir="$CONFIGURATION_BUILD_DIR"          \
-Pkotlin.build.type="$KOTLIN_BUILD_TYPE"                      \
-Pdevice="$KOTLIN_DEVICE"

这个运行脚本会读取Xcode项目的Build Settings中的定义，以便在copyFramework gradle任务中使用，回到GifGetter/GifLibrary/build.gradle中就能看到这个任务。但Xcode项目还没有这些设置。为了创建这些设置，请转到目标的Build Settings选项卡，然后点击**+**按钮，如下所示：

在弹出的小下拉菜单中选择Add User-Defined Setting。将新设置命名为“KOTLIN_BUILD_TYPE”。单击它旁边的箭头以显示Debug和Release环境。为Debug赋值“DEBUG”，为Release赋值“RELEASE”。

添加另一个用户定义的设置，并将其命名为“KOTLIN_DEVICE”。然后单击Debug右侧的**+按钮。这将在Debug下创建一个字段，表示Any Architecture** | Any SDK。单击它以查看架构选项列表，然后选择Any iOS Simulator SDK。为该字段赋值false。对Debug做相同操作，但这次添加的是Any iOS SDK并将其赋值为true。

在“KOTLIN_DEVICE”下的Release中重复这些步骤。最后，你的User-Defined Settings应该变成这样：

然后在右上角的搜索栏中搜索“Framework Search Paths”：

将以下内容添加到Debug和Release的Framework Search Paths：

"$(SRCROOT)/../GifLibrary/build"

KMP会把**.framework文件输出到这里，这个文件包含iOS应用所需的业务逻辑。在Finder中访问GifGetter/GifLibrary/build/，你会看到GifLibrary.framework**文件已准备好供Xcode使用了。

然后转到iOSApp目标的“General”选项卡，滚动到底部，然后Embedded点击Embedded Binaries下的**+按钮。在弹出的窗口中点击底部的“Add Other”；在弹出的Finder窗口中选择GifGetter/GifLibrary/build/并选中GifLibrary.framework文件，然后按点击“Open”。这样就会把框架添加到Linked Binaries and Frameworks**了。

打开GifRetriever.swift，你会看到一个包含25个URL字符串的硬编码数组。在它下面是requestGifs(_closure: @escaping StringsClosure)函数，负责传回硬编码URL。在文件顶部的import Foundation语句下添加import GifLibrary。

现在替换requestGifs(_closure: @escaping StringsClosure) 函数的主体，像这样：

func requestGifs(_ closure: @escaping StringsClosure) {
   GiphyAPI().getGifUrls { gifs -> KotlinUnit in
       closure(gifs)
       return KotlinUnit()
   }
}

iOS应用也可以进模拟器运行了！现在你已经在两个平台上部署了同一个应用，两个版本通过KMP共享网络逻辑！

结语

可以在GitHub上访问已完成的项目以供参考。请记住，KMP仍然是实验性组件，很容易发生变化，而且它在迅速发展和进化。不仅如此，已经有App Store中的现实应用成功应用KMP了。对于想要做跨平台开发的iOS开发者来说KMP是首选。

KMP不仅是iOS工程师成为跨平台移动开发者的捷径，你还可以用它创建业务逻辑库，然后将其部署到其它平台。如果你希望将应用部署到Javascript环境，这个业务逻辑库就能派上用场了。

如果你想深入了解KMP或Kotlin，请查看这些资源，其中包括Kotlin reddit版块和Slack频道的链接。美国东部时间2019年6月4日下午1点到2点，Touchlab将举办一次网络研讨会，主题与本文相同。最后，下面是一些关于KMP的文章介绍以供查阅：

作者介绍

Ben Whitley是纽约的一名iOS开发者，拥有4年的Xcode、Swift和Objective-C工作经验。在过去的一年半中，他一直是Touchlab的主力iOS开发人员，在此期间他与多家知名客户密切合作过。他目前致力于将Kotlin Multiplatform发展为iOS开发者的原生平台，并帮助Android开发者将他们的iOS和Xcode相关问题转化到KMP上解决。

查看英文原文：Kotlin Multiplatform for iOS Developers

创作场景

iOS 跨平台开发：Kotlin Multiplatform 入门