Swift Klib Gradle 插件使用教程

Swift Klib Gradle 插件使用教程

swift-klib-pluginGradle Plugin for injecting Swift code into Kotlin Multiplatform Mobile shared module项目地址:https://gitcode.com/gh_mirrors/sw/swift-klib-plugin

项目介绍

Swift Klib Gradle 插件是一个用于将 Swift 代码集成到 Kotlin Multiplatform Mobile (KMM) 共享模块中的 Gradle 插件。该插件通过 cinterop 机制，使得 Kotlin 代码能够访问 Swift 代码，特别适用于以下场景：

• 访问仅支持 Swift 的库（例如 CryptoKit）
• 创建 Kotlin 友好的 Swift API
• 学习 Swift 与 Kotlin 的互操作性

项目快速启动

安装插件

使用插件 DSL 进行安装：

plugins {
    id("io.github.ttypic.swiftklib") version "0.6.3"
}

使用传统插件应用方式进行安装：

buildscript {
    repositories {
        maven {
            url = uri("https://plugins.gradle.org/m2/")
        }
    }
    dependencies {
        classpath("io.github.ttypic:plugin:0.6.3")
    }
}
apply(plugin = "io.github.ttypic.swiftklib")

准备 Swift 代码

将 Swift 文件放置在项目中的单独文件夹中（例如 native/HelloSwift）。确保要暴露给 Kotlin 的 Swift API 是兼容 Objective-C 的：

@objc public class HelloWorld : NSObject {
    @objc public class func helloWorld() -> String {
        return "HeLLo WorLd"
    }
}

配置 swiftklib 扩展

在 Kotlin Multiplatform 插件中添加 cinterop 配置：

kotlin {
    listOf(iosX64(), iosArm64(), iosSimulatorArm64()).forEach {
        it.compilations["main"].cinterops {
            create("HelloSwift")
        }
    }
}

最后，在 swiftklib 扩展中提供设置：

swiftklib {
    create("HelloSwift") {
        path = file("native/HelloSwift")
        packageName("com.ttypic.objclibs.greeting")
    }
}

应用案例和最佳实践

访问 Swift 专用库

假设你需要在 KMM 项目中使用 Swift 的 CryptoKit 库，你可以通过 Swift Klib 插件将 CryptoKit 集成到 Kotlin 代码中，从而在 iOS 平台上使用加密功能。

创建 Kotlin 友好的 Swift API

通过定义兼容 Objective-C 的 Swift 类和方法，可以轻松地将 Swift 功能暴露给 Kotlin，实现两者的无缝集成。

典型生态项目

Kotlin Multiplatform Mobile (KMM)

Swift Klib 插件与 Kotlin Multiplatform Mobile 项目紧密结合，使得开发者能够在同一项目中同时使用 Kotlin 和 Swift，充分利用两者的优势。

CryptoKit 集成示例

通过 Swift Klib 插件，可以在 KMM 项目中集成 Swift 的 CryptoKit 库，实现安全的加密操作。

import CryptoKit

@objc public class CryptoUtils : NSObject {
    @objc public class func sha256(data: Data) -> Data {
        return SHA256.hash(data: data)
    }
}

在 Kotlin 中调用：

val cryptoUtils = CryptoUtils()
val hash = cryptoUtils.sha256(data)

通过以上步骤，你可以在 KMM 项目中轻松集成和使用 Swift 代码，实现更丰富的功能和更好的平台兼容性。

swift-klib-pluginGradle Plugin for injecting Swift code into Kotlin Multiplatform Mobile shared module项目地址:https://gitcode.com/gh_mirrors/sw/swift-klib-plugin