一、前言
前面介绍了如何搭建 KMM 环境，本篇介绍如何使用 KMM 开发 Android&iOS 功能。
二、目录介绍
在 KMM 共享模块中，开发者需要关注以下目录：
├── androidApp # 实际 Android APP Module
└── shared # KMM 模块代码目录
├── build.gradle.kts # KMM 模块 Gradle 配置（依赖、插件、构建 Task、cinterop 等配置）
└── include # 默认不会创建，用来存放需要的 *.h文件、*.a文件
└── src # 内部模块形式都为 Gradle 工程 Module
├── androidMain # Android 差异化代码，最终生成 AAR
├── commonMain # 共享模块 API 代码
├── iosMain # iOS 差异化代码，
└── nativeInterop # 默认不会创建，用来存放 *.def 文件，描述与 C/C++ 代码，或 Apple Framework 交互时，构建 klib 的配置
三、开始使用
1、创建共享接口
因为我们希望在多平台上共享代码逻辑，所以需要创建一个共享的接口来定义各平台上的行为。
// 文件位置：commonMain/Platform.kt
// 定义一个 apm 的共享接口
interface APMPlatform {
/**
* 设置用户 id
* @param userId 用户id
*/
fun setUserId(userId: String?)
}
// expect 关键字表示这是一个预期的方法，定义此方法后，需要在对应的平台实现此方法，对应的关键字为 actual
expect fun getAPMPlatform(): APMPlatform
2、实现共享接口
上面我们已经在 commonMain 中定义了共享接口，现在则需要去对应的平台实现这个接口。
// 文件位置：androidMain/Platform.kt
// 文件位置：iosMain/Platform.kt
// 实现定义的共享接口
class APMAndroidPlatform : APMPlatform {
override fun setUserId(userId: String?) {
// 这里就是平台的差异化代码了，是具体的实现
LogManager.getInstance().setUserId(userId)
}
}
// actual 关键字，表示实际的方法，对应 commonMain 中定义的 expect 方法
actual fun getAPMPlatform(): APMPlatform = APMAndroidPlatform()
注意：共享接口的定义位置和实现位置，在文件目录上要相对一致且同名，这里的例子中均是 Platform.kt
androidMain 可以直接调用 commonMain 中的代码逻辑，但是 commonMain 中不能调用 androidMain/iosMain 中的代码逻辑，需要借助 expect/actual 关键字。
3、如何添加第三方SDK
除了官方提供的API使用以外，我们经常还需要添加一些第三方 SDK 帮助我们开发功能，在 KMM 我们可以用以下方式添加第三方 SDK 依赖。
3.1、添加官方提供的依赖库
第一步，打开共享模块（shareModule）的 build.gralde.kts 文件。
第二步，在 commonMain 中添加你所需要的依赖，修改如下：
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.4.0")
}
}
}
}
第三步，sync 一下就可以用了。
3.2、添加官方没有提供的依赖库
官方目前提供的依赖库数量、功能并不多，因此在实际开发中，我们还是有添加非官方依赖库的需求。
3.2.1、Android 如何添加
对于 Android 而言，由于 Kotlin 是官方指定开发语言，所以在添加第三方 SDK 时可以说没有任何区别，打开共享模块下的 build.gradle.kts，修改如下：
kotlin {
sourceSets {
val androidMain by getting {
dependencies {
// 在这里添加自己想要的第三方 SDK 即可，这里添加了阿里云的 SLS
implementation("com.aliyun.openservices:aliyun-log-android-sdk:2.6.0")
}
}
}
}
3.2.2、iOS 如何添加
iOS 添加起来相对 Android 比较复杂，提供了两种方式，一种是 CocoaPods，另一种是 Klib。
3.2.2.1、CocoaPods 添加依赖
第一步，确认本地已安装 CocoaPods，没有的话需要自行安装。
第二步，修改 build.gradle.kts 文件，添加插件、配置等，详细可参考 CocoaPods 设置。
// 当前文件 build.gradle.kts
// 添加插件
plugins {
kotlin("multiplatform") version "1.9.10"
kotlin("native.cocoapods") version "1.9.10"
}
// 添加 cocoapods 配置
kotlin {
cocoapods {
// Required properties
// Specify the required Pod version here. Otherwise, the Gradle project version is used.
version = "1.0"
summary = "Some description for a Kotlin/Native module"
homepage = "Link to a Kotlin/Native module homepage"
// Optional properties
// Configure the Pod name here instead of changing the Gradle project name
name = "MyCocoaPod"
framework {
// Required properties
// Framework name configuration. Use this property instead of deprecated 'frameworkName'
baseName = "MyFramework"
// Optional properties
// Specify the framework linking type. It's dynamic by default.
isStatic = false
// Dependency export
export(project(":anotherKMMModule"))
transitiveExport = false // This is default.
// Bitcode embedding
embedBitcode(BITCODE)
}
// Maps custom Xcode configuration to NativeBuildType
xcodeConfigurationToNativeBuildType["CUSTOM_DEBUG"] = NativeBuildType.DEBUG
xcodeConfigurationToNativeBuildType["CUSTOM_RELEASE"] = NativeBuildType.RELEASE
}
}
第三步，在配置好 CocoaPods 后，开始添加依赖，可以参考添加 iOS 依赖。
kotlin {
cocoapods {
//..
pod("Alamofire") {
version = "5.7.0"
}
}
}
第四步，开始使用。
import cocoapods.Alamofire.*
3.2.2.2、Klib 添加依赖
对于现有的项目，有些功能我们已经开发完成了，并不希望重新开发一套，就想着能不能把现有的功能打包起来，供 KMM 使用，答案是可以的，接下来来介绍如何使用 Klib 的方式，对现有功能进行打包，并接入到 KMM 中。
第一步，创建一个 .def 文件，比如 apm.def，文件目录 src/nativeInterop/cinterop/apm.def
第二步，编辑 apm.def 文件中的内容，如下
// 在第一行添加语言类型，如果你希望使用纯C语言，也可以不添加
language = Objective-C
// 描述了哪些头文件将被 cinterop 处理
headers = x1.h x2.h
// 设置了这些声明应该放入的包的名称
package = cn.xxx.LBAPM
第三步，在 build.gradle.kts 中配置 def 文件，如下
kotlin {
iosArm64() {
compilations.getByName("main") {
val LBAPM by cinterops.creating {
// def 文件的位置
defFile("$projectDir/src/nativeInterop/cinterop/apm.def")
// 头文件的位置
includeDirs("$projectDir/include/LBAPM/Headers/LBAPM")
}
}
binaries.all {
// 实现文件的位置
linkerOpts("-L${projectDir}/include/LBAPM", "-lLBAPM", "-ObjC")
}
}
}
第四步，编译后开始使用。
import cn.xxx.LBAPM.*
四、如何运行iOS程序
需要在 Xcode 添加配置，原理是运行时，执行共享模块的脚本任务，生成 framework，再引用 framework，参看官方文档
五、结束语
在本次实践中，CocoaPods 没有配置成功，后续再进行尝试，可能是本地环境有些不对。
最终选择了 Klib 的方式，以下是一些心得：
- def 文件的位置要放在 src/nativeInterop/cinterop/apm.def
- 打包 Klib 是借助 Kotlin Native 的工具 cinterop 进行的，macOS 安装命令：
brew installkotlin-native，但是这种方式安装的是最新版本，也可以自己去 Github 上下载指定版本，页面最下面有个 Assets 目录，下载指定环境的 Kotlin-Native 安装即可。 - 只 sync 的话，经常会遇到没有生成 Klib 的情况，建议 Clean → Sync → Rebuild Project
- 项目中除了需要内置头文件(.h)以外，还需要内置实现文件(.a)，并且要在 binaries.all 中链接实现文件
网友评论