Experimental

Swift exportを使用したSwiftとの相互運用性

Kotlinは、Swift exportの実験的なサポートを提供しています。これにより、Kotlinソースを直接エクスポートし、Objective-Cヘッダーを必要とせずに、SwiftからKotlinコードをSwiftらしい方法（idiomatically）で呼び出すことができます。

Swift exportにより、Appleターゲット向けのマルチプラットフォーム開発がより効率的になります。例えば、トップレベル関数を持つKotlinモジュールがある場合、Swift exportを使用することで、Objective-C由来の紛らわしいアンダースコアやマングルされた名前を排除し、クリーンでモジュール固有のインポートが可能になります。

現在のSwift exportの機能は以下の通りです：

• マルチモジュール対応。各Kotlinモジュールは個別のSwiftモジュールとしてエクスポートされるため、関数呼び出しが簡素化されます。
• パッケージのサポート。Kotlinのパッケージはエクスポート中も明示的に保持され、生成されたSwiftコード内での名前の衝突を回避します。
• 型エイリアス。Kotlinの型エイリアスはエクスポートされSwiftでも保持されるため、可読性が向上します。
• プリミティブに対する強化されたNull許容性。Null許容性を保持するためにInt?のような型をKotlinIntのようなラッパークラスにボクシングする必要があったObjective-C相互運用とは異なり、Swift exportはNull許容性の情報を直接変換します。
• オーバーロード。Kotlinのオーバーロードされた関数を、曖昧さなくSwiftで呼び出すことができます。
• パッケージ構造のフラット化。KotlinのパッケージをSwiftのenumに変換し、生成されたSwiftコードからパッケージプレフィックスを削除できます。
• モジュール名のカスタマイズ。KotlinプロジェクトのGradle設定で、生成されるSwiftモジュール名をカスタマイズできます。

Swift exportを有効にする

この機能は現在実験的であり、本番環境での使用には適していません。 試してみるには、Kotlinプロジェクトのビルドファイルを設定し、Swift exportを統合するためのXcodeのセットアップを行ってください。

Kotlinプロジェクトの設定

Swift exportをセットアップするための開始点として、プロジェクトで以下のビルドファイルを使用できます。

// build.gradle.kts
kotlin {

    iosArm64()
    iosSimulatorArm64()

    swiftExport {
        // ルートモジュール名を設定
        moduleName = "Shared"

        // 折り畳みルール（collapse rule）を設定
        // 生成されたSwiftコードからパッケージプレフィックスを削除
        flattenPackage = "com.example.sandbox"

        // 外部モジュールのエクスポートを設定
        export(project(":subproject")) {
            // エクスポートされるモジュールの名前を設定 
            moduleName = "Subproject"
            // エクスポートされる依存関係の折り畳みルールを設定 
            flattenPackage = "com.subproject.library"
        }

        // リンクタスクにコンパイラ引数を提供
        configure {
            freeCompilerArgs.add("-Xexpect-actual-classes")
        }
    }
}

Kotlinコンパイラは、必要なすべてのファイル（swiftmoduleファイル、静的ライブラリ.a、ヘッダーファイル、modulemapファイルを含む）を自動的に生成し、アプリのビルドディレクトリにコピーします。これらにはXcodeからアクセスできます。

すでにSwift exportがセットアップされている公開サンプルをクローンすることもできます。

Xcodeプロジェクトの設定

XcodeでプロジェクトにSwift exportを統合するように設定するには：

1. Xcodeでプロジェクト設定を開きます。

2. Build Phasesタブで、embedAndSignAppleFrameworkForXcodeタスクを含むRun Scriptフェーズを探します。

3. 実行スクリプトフェーズのスクリプトを、embedSwiftExportForXcodeタスクに置き換えます。

   ./gradlew :<Shared module name>:embedSwiftExportForXcode

   

4. プロジェクトをビルドします。ビルドにより、出力ディレクトリにSwiftモジュールが生成されます。

現在の制限事項

Swift exportは現在、iOSフレームワークをXcodeプロジェクトに接続するために直接統合（direct integration）を使用しているプロジェクトでのみ動作します。 これは、IntelliJ IDEAのKotlin MultiplatformプラグインやWebウィザードで作成されたKotlin Multiplatformプロジェクトの標準的な構成です。

その他の既知の問題：

• SQLDelightのRuntimeモジュールとCompose Runtimeモジュールのように、Gradle座標でモジュール名が同じ場合にSwift exportが失敗します（KT-80185）。

• List、Set、またはMapを継承する型は、エクスポート時に無視されます（KT-80416）。

• List、Set、またはMapの継承クラスは、Swift側でインスタンス化できません（KT-80417）。

• Swiftにエクスポートされる際、Kotlinのジェネリック型パラメータは、その上限境界（upper bounds）へと型消去（type-erase）されます。

• SwiftのクロージャをKotlinに渡すことはできますが、KotlinからSwiftへ関数型をエクスポートすることはできません。

• 言語を跨いだ継承（Cross-language inheritance）はサポートされていないため、SwiftクラスがKotlinからエクスポートされたクラスやインターフェースを直接継承することはできません。

• IDEの移行ヒントや自動化は利用できません。

• オプトイン（opt-in）を必要とする宣言を使用する場合、Gradleビルドファイルで_モジュールレベル_の明示的なoptInコンパイラオプションを追加する必要があります。例えば、kotlinx.datetimeライブラリの場合は以下のようになります。

  swiftExport {
      moduleName = "Shared"
  
      export("org.jetbrains.kotlinx:kotlinx-datetime:0.7.1") {
          moduleName = "KotlinDateTime"
          flattenPackage = "kotlinx.datetime"
      }
  }
  
  // モジュールレベルで個別のopt-inブロックを追加
  compilerOptions {
      optIn.add("kotlin.time.ExperimentalTime")
  }

マッピング

以下の表は、Kotlinの概念がSwiftにどのようにマッピングされるかを示しています。

Kotlin	Swift	備考
class	class	備考
object	sharedプロパティを持つclass	備考
enum class	enum	備考
typealias	typealias	備考
関数	関数	備考
プロパティ	プロパティ	備考
コンストラクタ	イニシャライザ	備考
パッケージ	ネストされたenum	備考
Boolean	Bool
Char	Unicode.UTF16.CodeUnit
Byte	Int8
Short	Int16
Int	Int32
Long	Int64
UByte	UInt8
UShort	UInt16
UInt	UInt32
ULong	UInt64
Float	Float
Double	Double
Any	KotlinBase クラス
Unit	Void
Nothing	Never	備考

宣言

クラス

Swift exportは、class Foo()のように、Anyを直接継承するfinalクラスのみをサポートしています。 これらは、特別なKotlinBaseクラスを継承するSwiftクラスに変換されます。

// Kotlin
class MyClass {
    val property: Int = 0

    fun method() {}
}

// Swift
public class MyClass : KotlinRuntime.KotlinBase {
    public var property: Swift.Int32 {
        get {
            // ...
        }
    }
    public override init() {
        // ...
    }
    public func method() -> Swift.Void {
        // ...
    }
}

オブジェクト

オブジェクトは、プライベートなinitとstaticなsharedアクセサを持つSwiftクラスに変換されます。

// Kotlin
object O

// Swift
public class O : KotlinRuntime.KotlinBase {
    public static var shared: O {
        get {
            // ...
        }
    }
    private override init() {
        // ...
    }
}

型エイリアス

Kotlinの型エイリアスは、そのままエクスポートされます。

// Kotlin
typealias MyInt = Int

// Swift
public typealias MyInt = Swift.Int32

Enum

Kotlinのenum class宣言は、通常のネイティブなSwiftのenum型としてエクスポートされます。

// Kotlin
enum class Color(val rgb: Int) {
    RED(0xFF0000),
    GREEN(0x00FF00),
    BLUE(0x0000FF)
}

val color = Color.RED

// Swift
public enum Color: Swift.CaseIterable, Swift.LosslessStringConvertible, Swift.RawRepresentable {
    case RED, GREEN, BLUE

    public var rgb: Swift.Int32 { get }
}

関数

Swift exportは、単純なトップレベル関数とメソッドをサポートしています。

// Kotlin
fun foo(a: Short, b: Bar) {}

fun baz(): Long = 0

// Swift
public func foo(a: Swift.Int16, b: Bar) -> Swift.Void {
    // ...
}

public func baz() -> Swift.Int64 {
    // ...
}

Kotlinの拡張関数の場合、レシーバーパラメータは最初の位置にある通常のSwiftパラメータになります。

// Kotlin
fun Int.foo(): Unit = TODO()

// Swift
func foo(_ receiver: Int32) {}

Kotlinのvararg付きの関数は、Swiftの可変長引数関数パラメータにマッピングされます。

// Kotlin
fun log(vararg messages: String)

// Swift
public func log(messages: Swift.String...)

suspend、inline、operatorキーワードを持つ関数のサポートは、現在制限されています。 ジェネリック型は一般的​​にサポートされていません。

プロパティ

Kotlinのプロパティは、Swiftのプロパティに変換されます。

// Kotlin
val a: Int = 0

var b: Short = 15

const val c: Int = 0

// Swift
public var a: Swift.Int32 {
    get {
        // ...
    }
}
public var b: Swift.Int16 {
    get {
        // ...
    }
    set {
        // ...
    }
}
public var c: Swift.Int32 {
    get {
        // ...
    }
}

コンストラクタ

コンストラクタは、Swiftのイニシャライザに変換されます。

// Kotlin
class Foo(val prop: Int)

// Swift
public class Foo : KotlinRuntime.KotlinBase {
    public init(
        prop: Swift.Int32
    ) {
        // ...
    }
}

型

kotlin.Nothing

KotlinのNothing型は、Never型に変換されます。

// Kotlin
fun foo(): Nothing = TODO()

fun baz(input: Nothing) {}

// Swift
public func foo() -> Swift.Never {
    // ...
}

public func baz(input: Swift.Never) -> Void {
    // ...
}

クラシファイア型

Swift exportは現在、Anyを直接継承するfinalクラスのみをサポートしています。

パッケージ

Kotlinのパッケージは、名前の衝突を避けるためにネストされたSwiftのenumに変換されます。

// Kotlin
// foo.barパッケージ内のbar.ktファイル
fun callMeMaybe() {}

// Kotlin
// foo.bazパッケージ内のbaz.ktファイル
fun callMeMaybe() {}

// Swift
public extension foo.bar {
    public func callMeMaybe() {}
}

public extension foo.baz {
    public func callMeMaybe() {}
}

public enum foo {
    public enum bar {}

    public enum baz {}
}

Swift exportの進化

今後のKotlinリリースにおいて、Swift exportを拡大し、徐々に安定化させていく予定です。特にコルーチンやFlowを中心に、KotlinとSwift間の相互運用性を向上させます。

フィードバックをお寄せください：

• Kotlin Slackで – 招待を受け取り、#swift-exportチャンネルに参加してください。
• YouTrackで問題を報告してください。