ตั้งค่าปลั๊กอินไลบรารี Android Gradle สำหรับ KMP

ปลั๊กอิน com.android.kotlin.multiplatform.library Gradle เป็นเครื่องมือที่ได้รับการสนับสนุนอย่างเป็นทางการ สำหรับการเพิ่มเป้าหมาย Android ลงใน Kotlin Multiplatform (KMP) โมดูลไลบรารี ซึ่งช่วยลดความซับซ้อนในการกำหนดค่าโปรเจ็กต์ ปรับปรุง ประสิทธิภาพของบิลด์ และผสานรวมกับ Android Studio ได้ดียิ่งขึ้น

การใช้ปลั๊กอิน com.android.library สำหรับการพัฒนา KMP ขึ้นอยู่กับ API ของปลั๊กอิน Android Gradle ที่เลิกใช้งานแล้วและต้องเลือกใช้ในปลั๊กอิน Android Gradle 9.0 ขึ้นไป (ไตรมาสที่ 4 ปี 2025) เราคาดว่าจะนำ API เหล่านี้ออกในปลั๊กอิน Android Gradle 10.0 (ครึ่งหลังของปี 2026)

หากต้องการใช้ปลั๊กอินนี้ โปรดดูส่วนใช้ปลั๊กอิน Android-KMP หากต้องการย้ายข้อมูลจาก API เดิม โปรดดูคำแนะนำ ในการย้ายข้อมูล

ฟีเจอร์หลักและความแตกต่าง

ปลั๊กอิน Android-KMP ออกแบบมาสำหรับโปรเจ็กต์ KMP โดยเฉพาะและแตกต่าง จากปลั๊กอิน com.android.library มาตรฐานในหลายๆ ด้านที่สำคัญ ดังนี้

  • สถาปัตยกรรมแบบตัวแปรเดียว: ปลั๊กอินใช้ตัวแปรเดียว ซึ่งจะนำการรองรับ รสชาติของผลิตภัณฑ์และประเภทบิลด์ออก ซึ่งจะช่วยลดความซับซ้อนในการกำหนดค่า และเพิ่มประสิทธิภาพการบิลด์

  • เพิ่มประสิทธิภาพสำหรับ KMP: ปลั๊กอินได้รับการออกแบบมาสำหรับไลบรารี KMP โดยมุ่งเน้นที่ โค้ด Kotlin ที่ใช้ร่วมกันและความสามารถในการทำงานร่วมกัน โดยไม่รองรับ บิลด์แบบเนทีฟเฉพาะ Android, AIDL และ RenderScript

  • การทดสอบที่ปิดใช้โดยค่าเริ่มต้น: การทดสอบหน่วยและการทดสอบอุปกรณ์ (การวัด) จะปิดใช้โดยค่าเริ่มต้นเพื่อเพิ่มความเร็วในการสร้าง คุณสามารถเปิดใช้ได้หากจำเป็น

  • ไม่มีส่วนขยาย Android ระดับบนสุด: การกำหนดค่าจะได้รับการจัดการด้วยบล็อก androidLibrary ภายใน KMP DSL ของ Gradle ซึ่งจะรักษาโครงสร้างโปรเจ็กต์ KMP ที่สอดคล้องกัน ไม่มีการบล็อกส่วนขยาย android ระดับบนสุด

  • เลือกใช้การคอมไพล์ Java: ระบบจะปิดใช้การคอมไพล์ Java โดยค่าเริ่มต้น ใช้ withJava() ในบล็อก androidLibrary เพื่อเปิดใช้ ซึ่งจะช่วยปรับปรุงเวลาบิลด์ เมื่อไม่จำเป็นต้องคอมไพล์ Java

ประโยชน์ของปลั๊กอินไลบรารี Android-KMP

ปลั๊กอิน Android-KMP มีประโยชน์ดังต่อไปนี้สำหรับโปรเจ็กต์ KMP

  • ปรับปรุงประสิทธิภาพและความเสถียรในการสร้าง: ออกแบบมาเพื่อความเร็วในการสร้างที่ได้รับการเพิ่มประสิทธิภาพและความเสถียรที่ดียิ่งขึ้นภายในโปรเจ็กต์ KMP การมุ่งเน้นที่เวิร์กโฟลว์ KMP ช่วยให้กระบวนการบิลด์มีประสิทธิภาพและเชื่อถือได้มากขึ้น

  • การผสานรวม IDE ที่ดียิ่งขึ้น: ช่วยให้การเติมโค้ด การนำทาง การแก้ไขข้อบกพร่อง และประสบการณ์โดยรวมของนักพัฒนาซอฟต์แวร์ดีขึ้นเมื่อทำงานกับ ไลบรารี KMP Android

  • การกำหนดค่าโปรเจ็กต์ที่ง่ายขึ้น: ปลั๊กอินช่วยลดความซับซ้อนในการกำหนดค่า สำหรับโปรเจ็กต์ KMP โดยการนำความซับซ้อนเฉพาะของ Android เช่น ตัวแปรบิลด์ ออก ซึ่งจะทำให้ไฟล์บิลด์สะอาดและดูแลรักษาง่ายขึ้น ก่อนหน้านี้ การใช้ปลั๊กอิน com.android.library ในโปรเจ็กต์ KMP อาจสร้างชื่อชุดแหล่งข้อมูลที่สับสน เช่น androidAndroidTest รูปแบบการตั้งชื่อนี้ ไม่ค่อยเป็นที่เข้าใจสำหรับนักพัฒนาซอฟต์แวร์ที่คุ้นเคยกับโครงสร้างโปรเจ็กต์ KMP มาตรฐาน

สิ่งที่ต้องมีก่อน

หากต้องการใช้ปลั๊กอิน com.android.kotlin.multiplatform.library คุณต้องกำหนดค่าโปรเจ็กต์ให้มีเวอร์ชันขั้นต่ำต่อไปนี้หรือสูงกว่า

  • ปลั๊กอิน Android Gradle (AGP): 8.10.0
  • ปลั๊กอิน Gradle ของ Kotlin (KGP): 2.0.0

ใช้ปลั๊กอิน Android-KMP กับโมดูลที่มีอยู่

หากต้องการใช้ปลั๊กอิน Android-KMP กับโมดูลไลบรารี KMP ที่มีอยู่ ให้ทำตามขั้นตอนต่อไปนี้

  1. ประกาศปลั๊กอินในแคตตาล็อกเวอร์ชัน เปิดไฟล์ TOML ของแคตตาล็อกเวอร์ชัน (โดยปกติคือ gradle/libs.versions.toml) แล้วเพิ่มส่วนคำจำกัดความของปลั๊กอิน

    # To check the version number of the latest Kotlin release, go to
    # https://kotlinlang.org/docs/releases.html
    
    [versions]
    androidGradlePlugin = "8.13.2"
    kotlin = "KOTLIN_VERSION"
    
    [plugins]
    kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
    android-kotlin-multiplatform-library = { id = "com.android.kotlin.multiplatform.library", version.ref = "androidGradlePlugin" }
    
  2. ใช้การประกาศปลั๊กอินในไฟล์บิลด์รูท เปิดไฟล์ build.gradle.kts ที่อยู่ในไดเรกทอรีรากของโปรเจ็กต์ เพิ่มอีเมลแทนของปลั๊กอินลงในบล็อก plugins โดยใช้ apply false ซึ่งจะทำให้ นามแฝงของปลั๊กอินพร้อมใช้งานกับโปรเจ็กต์ย่อยทั้งหมดโดยไม่ต้องใช้ตรรกะของปลั๊กอิน กับโปรเจ็กต์รูทเอง

    Kotlin

    // Root build.gradle.kts file
    
    plugins {
       alias(libs.plugins.kotlin.multiplatform) apply false
    
       // Add the following
       alias(libs.plugins.android.kotlin.multiplatform.library) apply false
    }

    Groovy

    // Root build.gradle file
    
    plugins {
       alias(libs.plugins.kotlin.multiplatform) apply false
    
       // Add the following
       alias(libs.plugins.android.kotlin.multiplatform.library) apply false
    }
  3. ใช้ปลั๊กอินในไฟล์บิลด์ของโมดูลไลบรารี KMP เปิดไฟล์ build.gradle.kts ในโมดูลไลบรารี KMP แล้วใช้ปลั๊กอินที่ด้านบนของไฟล์ภายในบล็อก plugins

    Kotlin

    // Module-specific build.gradle.kts file
    
    plugins {
       alias(libs.plugins.kotlin.multiplatform)
    
       // Add the following
       alias(libs.plugins.android.kotlin.multiplatform.library)
    }

    Groovy

    // Module-specific build.gradle file
    
    plugins {
       alias(libs.plugins.kotlin.multiplatform)
    
       // Add the following
       alias(libs.plugins.android.kotlin.multiplatform.library)
    }
  4. กำหนดค่าเป้าหมาย KMP ของ Android กำหนดค่าบล็อก Kotlin Multiplatform (kotlin) เพื่อกำหนดเป้าหมาย Android ภายในkotlinบล็อก ให้ระบุ เป้าหมาย Android โดยใช้androidLibrary:

    Kotlin

    kotlin {
       androidLibrary {
           namespace = "com.example.kmpfirstlib"
           compileSdk = 33
           minSdk = 24
    
           withJava() // enable java compilation support
           withHostTestBuilder {}.configure {}
           withDeviceTestBuilder {
               sourceSetTreeName = "test"
           }
    
           compilerOptions.configure {
               jvmTarget.set(
                   org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_1_8
               )
           }
       }
    
       sourceSets {
           androidMain {
               dependencies {
                   // Add Android-specific dependencies here
               }
           }
           getByName("androidHostTest") {
               dependencies {
               }
           }
    
           getByName("androidDeviceTest") {
               dependencies {
               }
           }
       }
       // ... other targets (JVM, iOS, etc.) ...
    }

    Groovy

    kotlin {
       androidLibrary {
           namespace = "com.example.kmpfirstlib"
           compileSdk = 33
           minSdk = 24
    
           withJava() // enable java compilation support
           withHostTestBuilder {}.configure {}
           withDeviceTestBuilder {
               it.sourceSetTreeName = "test"
           }
    
           compilerOptions.options.jvmTarget.set(
               org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_1_8
           )
       }
    
       sourceSets {
           androidMain {
               dependencies {
               }
           }
           androidHostTest {
               dependencies {
               }
           }
           androidDeviceTest {
               dependencies {
               }
           }
       }
       // ... other targets (JVM, iOS, etc.) ...
    }
  5. ใช้การเปลี่ยนแปลง หลังจากใช้ปลั๊กอินและกำหนดค่าkotlin บล็อกแล้ว ให้ซิงค์โปรเจ็กต์ Gradle เพื่อใช้การเปลี่ยนแปลง

ย้ายข้อมูลจากปลั๊กอินเดิม

คู่มือนี้จะช่วยคุณย้ายข้อมูลจากปลั๊กอิน com.android.library เดิมไปยังปลั๊กอิน com.android.kotlin.multiplatform.library

1. การประกาศทรัพยากร Dependency

งานทั่วไปคือการประกาศการขึ้นต่อกันสำหรับชุดแหล่งที่มาเฉพาะของ Android ปลั๊กอินใหม่กำหนดให้ต้องวางรายการเหล่านี้ไว้ภายในบล็อก sourceSets อย่างชัดเจน ซึ่งแตกต่างจากบล็อก dependencies ทั่วไปที่ใช้ก่อนหน้านี้

Android-KMP

ปลั๊กอินใหม่นี้ช่วยให้โครงสร้างสะอาดขึ้นด้วยการจัดกลุ่มการอ้างอิง Android ภายในชุดแหล่งที่มา androidMain นอกจากชุดแหล่งข้อมูลหลักแล้ว ยังมีชุดแหล่งข้อมูลทดสอบ 2 ชุดซึ่งสร้างขึ้นตามคำขอ androidDeviceTest และ androidHostTest (ดูข้อมูลเพิ่มเติมได้ที่การกำหนดค่าการทดสอบโฮสต์และอุปกรณ์)

// build.gradle.kts

kotlin {
    androidLibrary {}
    //... other targets

    sourceSets {
        commonMain.dependencies {
            implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0")
        }

        // Dependencies are now scoped to the specific Android source set
        androidMain.dependencies {
            implementation("androidx.appcompat:appcompat:1.7.0")
            implementation("com.google.android.material:material:1.11.0")
        }
    }
}

ชุดแหล่งที่มามีการคอมไพเลชัน Kotlin ที่เกี่ยวข้องซึ่งมีชื่อว่า main, deviceTest และ hostTest คุณกำหนดค่าชุดแหล่งที่มาและการคอมไพล์ได้ใน สคริปต์บิลด์ดังนี้

// build.gradle.kts

kotlin {
    androidLibrary {
        compilations.getByName("deviceTest") {
            kotlinOptions.languageVersion = "2.0"
        }
    }
}

ปลั๊กอินเดิม

ปลั๊กอินเวอร์ชันเดิมช่วยให้คุณประกาศการขึ้นต่อกันเฉพาะ Android ใน บล็อกการขึ้นต่อกันระดับบนสุดได้ ซึ่งบางครั้งอาจทำให้เกิดความสับสนใน โมดูลหลายแพลตฟอร์ม

// build.gradle.kts

kotlin {
  androidTarget()
  //... other targets
}

// Dependencies for all source sets were often mixed in one block
dependencies {
  // Common dependencies
  commonMainImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0")

  // Android-specific dependencies
  implementation("androidx.appcompat:appcompat:1.7.0")
  implementation("com.google.android.material:material:1.11.0")
}

2. การเปิดใช้ทรัพยากร Android

ระบบไม่ได้เปิดใช้การรองรับทรัพยากร Android (โฟลเดอร์ res) โดยค่าเริ่มต้นใน ปลั๊กอินใหม่เพื่อเพิ่มประสิทธิภาพการสร้าง คุณต้องเลือกใช้เพื่อใช้งาน การเปลี่ยนแปลงนี้ช่วยให้มั่นใจได้ว่าโปรเจ็กต์ที่ไม่ต้องใช้ทรัพยากรเฉพาะของ Android จะไม่ได้รับภาระจากค่าใช้จ่ายในการบิลด์ที่เกี่ยวข้อง

Android-KMP

คุณต้องเปิดใช้การประมวลผลทรัพยากร Android อย่างชัดเจน ควรวางทรัพยากรไว้ใน src/androidMain/res

// build.gradle.kts

kotlin {
  androidLibrary {
    // ...
    // Enable Android resource processing
    androidResources {
      enable = true
    }
  }
}

// Project Structure
// └── src
//     └── androidMain
//         └── res
//             ├── values
//             │   └── strings.xml
//             └── drawable
//                 └── icon.xml

ปลั๊กอินเดิม

ระบบเปิดใช้การประมวลผลทรัพยากรโดยค่าเริ่มต้น คุณสามารถเพิ่มไดเรกทอรี res ใน src/main และเริ่มเพิ่ม Drawable, ค่า XML ฯลฯ ได้ทันที

// build.gradle.kts

android {
    namespace = "com.example.library"
    compileSdk = 34
    // No extra configuration was needed to enable resources.
}

// Project Structure
// └── src
//     └── main
//         └── res
//             ├── values
//             │   └── strings.xml
//             └── drawable
//                 └── icon.xml

3. การกำหนดค่าการทดสอบโฮสต์และอุปกรณ์

การเปลี่ยนแปลงที่สำคัญในปลั๊กอินใหม่คือการทดสอบฝั่งโฮสต์ (หน่วย) ของ Android และการทดสอบฝั่งอุปกรณ์ (Instrumented) จะปิดใช้โดยค่าเริ่มต้น คุณต้องเลือกใช้โดยชัดแจ้ง เพื่อสร้างชุดแหล่งข้อมูลและการกำหนดค่าการทดสอบ ในขณะที่ปลั๊กอินเวอร์ชันเก่า จะสร้างชุดแหล่งข้อมูลและการกำหนดค่าการทดสอบโดยอัตโนมัติ

โมเดลการเลือกใช้นี้ช่วยยืนยันว่าโปรเจ็กต์ของคุณยังคงมีขนาดเล็กและมีเฉพาะตรรกะการสร้างและชุดแหล่งที่มาที่คุณใช้งานอยู่เท่านั้น

Android-KMP

ในปลั๊กอินใหม่ คุณจะเปิดใช้และกำหนดค่าการทดสอบภายในบล็อก kotlin.androidLibrary ซึ่งจะทำให้การตั้งค่าชัดเจนยิ่งขึ้นและหลีกเลี่ยง การสร้างคอมโพเนนต์การทดสอบที่ไม่ได้ใช้ test แหล่งที่มาของชุดข้อมูลจะกลายเป็น androidHostTest และ androidTest จะกลายเป็น androidDeviceTest

// build.gradle.kts

kotlin {
  androidLibrary {
    // ...

    // Opt-in to enable and configure host-side (unit) tests
    withHostTest {
      isIncludeAndroidResources = true
    }

    // Opt-in to enable and configure device-side (instrumented) tests
    withDeviceTest {
      instrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
      execution = "ANDROIDX_TEST_ORCHESTRATOR"
    }
  }
}

// Project Structure (After Opt-in)
// └── src
//     ├── androidHostTest
//     └── androidDeviceTest

ปลั๊กอินเดิม

เมื่อใช้ปลั๊กอิน com.android.library ระบบจะสร้างชุดแหล่งข้อมูล test และ androidTest โดยค่าเริ่มต้น คุณจะกำหนดค่าลักษณะการทำงานของบล็อกภายใน android โดยปกติจะใช้ testOptions DSL

// build.gradle.kts

android {
  defaultConfig {
    // Runner was configured in defaultConfig
    testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
  }

  testOptions {
    // Configure unit tests (for the 'test' source set)
    unitTests.isIncludeAndroidResources = true

    // Configure device tests (for the 'androidTest' source set)
    execution = "ANDROIDX_TEST_ORCHESTRATOR"
  }
}

// Project Structure (Defaults)
// └── src
//     ├── test
//     └── androidTest

4. เปิดใช้การคอมไพล์แหล่งที่มาของ Java

หากไลบรารี KMP ต้องคอมไพล์แหล่งที่มาของ Java สำหรับเป้าหมาย Android คุณ ต้องเปิดใช้ฟังก์ชันนี้อย่างชัดเจนด้วยปลั๊กอินใหม่ โปรดทราบว่าการดำเนินการนี้จะ เปิดใช้การคอมไพล์ไฟล์ Java ที่อยู่ในโปรเจ็กต์โดยตรง ไม่ใช่ การคอมไพล์การอ้างอิงของโปรเจ็กต์ นอกจากนี้ วิธีตั้งค่าเวอร์ชันเป้าหมาย JVM ของคอมไพเลอร์ Java และ Kotlin ก็จะเปลี่ยนไปด้วย

Android-KMP

คุณต้องเลือกใช้การคอมไพล์ Java โดยเรียกใช้ withJava() ตอนนี้ได้กำหนดค่าเป้าหมาย JVM ไว้ภายในบล็อก kotlin { androidLibrary {} } โดยตรง เพื่อให้การตั้งค่าเป็นไปในทิศทางเดียวกันมากขึ้น การตั้งค่า jvmTarget ที่นี่จะมีผลกับการคอมไพล์ทั้ง Kotlin และ Java สำหรับเป้าหมาย Android

// build.gradle.kts

kotlin {
  androidLibrary {
    //  Opt-in to enable Java source compilation
    withJava()
    // Configure the JVM target for both Kotlin and Java sources
    compilerOptions {
      jvmTarget.set(org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_1_8)
    }
  }
  // ...
}

// Project Structure:
// └── src
//     └── androidMain
//         ├── kotlin
//         │   └── com/example/MyKotlinClass.kt
//         └── java
//             └── com.example/MyJavaClass.java

ปลั๊กอินเดิม

ระบบจะเปิดใช้การคอมไพล์ Java โดยค่าเริ่มต้น เป้าหมาย JVM สำหรับทั้งแหล่งที่มาของ Java และ Kotlin ได้รับการตั้งค่าในบล็อก android โดยใช้ compileOptions

// build.gradle.kts

android {
  // ...
  compileOptions {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
  }
}

kotlin {
  androidTarget {
    compilations.all {
      kotlinOptions.jvmTarget = "1.8"
    }
  }
}

5. โต้ตอบกับตัวแปรบิลด์โดยใช้ androidComponents

androidComponents ยังคงพร้อมให้ใช้งานสำหรับการโต้ตอบกับอาร์ติแฟกต์บิลด์ โดยใช้โปรแกรม แม้ว่า Variant API ส่วนใหญ่จะยังคงเหมือนเดิม แต่AndroidKotlinMultiplatformVariant อินเทอร์เฟซใหม่จะมีการจำกัดมากกว่าเนื่องจากปลั๊กอินจะสร้างได้เพียงตัวแปรเดียว

ดังนั้น พร็อพเพอร์ตี้ที่เกี่ยวข้องกับประเภทบิลด์และผลิตภัณฑ์จึงไม่ พร้อมใช้งานในออบเจ็กต์ตัวแปรอีกต่อไป

Android-KMP

ตอนนี้บล็อก onVariants จะวนซ้ำตัวแปรเดียว คุณยังคงเข้าถึงพร็อพเพอร์ตี้ทั่วไป เช่น name และ artifacts ได้ แต่จะเข้าถึงพร็อพเพอร์ตี้ที่เฉพาะเจาะจงกับประเภทบิลด์ไม่ได้

// build.gradle.kts

androidComponents {
  onVariants { variant ->
      val artifacts = variant.artifacts
  }
}

ปลั๊กอินเดิม

ตัวแปรหลายรายการช่วยให้คุณเข้าถึงพร็อพเพอร์ตี้เฉพาะประเภทบิลด์เพื่อ กำหนดค่าทาสก์ได้

// build.gradle.kts

androidComponents {
  onVariants(selector().withBuildType("release")) { variant ->
    // ...
  }
}

6. เลือกตัวแปรของทรัพยากร Dependency ของไลบรารี Android

ไลบรารี KMP จะสร้างตัวแปรเดียวสำหรับ Android อย่างไรก็ตาม คุณอาจ ต้องใช้ไลบรารี Android มาตรฐาน (com.android.library) ที่มีหลาย ตัวแปร (เช่น free/paid รสชาติของผลิตภัณฑ์) การควบคุมวิธีที่โปรเจ็กต์ เลือกตัวแปรจาก Dependency นั้นเป็นข้อกำหนดทั่วไป

Android-KMP

ปลั๊กอินใหม่จะรวมและชี้แจงตรรกะนี้ภายในบล็อก kotlin.androidLibrary.localDependencySelection ซึ่งจะช่วยให้เห็นได้ชัดเจนยิ่งขึ้นว่าระบบจะเลือกการขึ้นต่อกันภายนอกเวอร์ชันใดสำหรับไลบรารี KMP แบบเวอร์ชันเดียว

// build.gradle.kts
kotlin {
  androidLibrary {
    localDependencySelection {
      // For dependencies with multiple build types, select 'debug' first, and 'release' in case 'debug' is missing
      selectBuildTypeFrom.set(listOf("debug", "release"))

      // For dependencies with a 'type' flavor dimension...
      productFlavorDimension("type") {
        // ...select the 'typeone' flavor.
        selectFrom.set(listOf("typeone"))
      }
    }
  }
}

ปลั๊กอินเดิม

คุณกำหนดค่ากลยุทธ์การเลือกการขึ้นต่อกันภายในบล็อก buildTypes and productFlavors ซึ่งมักเกี่ยวข้องกับการใช้ missingDimensionStrategy เพื่อระบุรสชาติเริ่มต้นสำหรับมิติข้อมูลที่ไม่มีในคลัง หรือ matchingFallbacks ภายในรสชาติที่เฉพาะเจาะจงเพื่อกำหนดลำดับการค้นหา

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้งาน API ที่หัวข้อแก้ไขข้อผิดพลาดในการจับคู่

7. ทรัพยากร Dependency ของตัวอย่าง Compose

โดยปกติแล้ว เราต้องการให้ไลบรารีที่เฉพาะเจาะจงอยู่ในขอบเขตของสภาพแวดล้อมการพัฒนาในเครื่อง เพื่อป้องกันไม่ให้เครื่องมือภายในรั่วไหลไปยังอาร์ติแฟกต์ที่เผยแพร่ขั้นสุดท้าย ซึ่งเป็นความท้าทายสำหรับปลั๊กอิน Android KMP ใหม่เนื่องจาก จะนำสถาปัตยกรรมประเภทบิลด์ที่ใช้แยกการพัฒนา การอ้างอิงออกจากโค้ดที่เผยแพร่ออก

Android-KMP

หากต้องการเพิ่มการอ้างอิงสำหรับการพัฒนาและการทดสอบในเครื่องเท่านั้น ให้เพิ่ม การอ้างอิงลงในการกำหนดค่า classpath ของรันไทม์โดยตรง (ในบล็อก dependencies ระดับบนสุด) ของการคอมไพล์ Android หลัก ซึ่งจะช่วยให้มั่นใจได้ว่าการอ้างอิงจะพร้อมใช้งานในขณะรันไทม์ (เช่น สำหรับเครื่องมืออย่าง Compose Preview) แต่ไม่ได้เป็นส่วนหนึ่งของ classpath ในการคอมไพล์หรือ API ที่เผยแพร่ของไลบรารี

// build.gradle.kts
dependencies {
  "androidRuntimeClasspath"(libs.androidx.compose.ui.tooling)
}

ปลั๊กอินเดิม

โปรเจ็กต์ Kotlin Multiplatform ที่ใช้ปลั๊กอิน com.android.library สำหรับเป้าหมาย Android ควรใช้การกำหนดค่า debugImplementation ซึ่งกำหนดขอบเขตการอ้างอิงไปยังประเภทบิลด์ดีบักและป้องกันไม่ให้รวมไว้ในตัวแปรการเผยแพร่ของไลบรารีที่ผู้บริโภคใช้

// build.gradle.kts
dependencies {
  debugImplementation(libs.androidx.compose.ui.tooling)
}

8. กำหนดค่าเป้าหมาย JVM สำหรับเป้าหมาย Android ของ KMP

ปลั๊กอิน KMP Android จะตั้งค่าเป้าหมาย JVM โดยใช้ androidLibrary.compilerOptions.jvmTarget ซึ่งใช้ได้กับทั้ง Java และ Kotlin ทำให้การกำหนดค่าง่ายขึ้นเมื่อเทียบกับบล็อก compileOptions และ kotlinOptions แยกกันในโปรเจ็กต์ Android ล้วน

Android-KMP

เมื่อทำงานกับโปรเจ็กต์ Kotlin Multiplatform (KMP) ที่มีเป้าหมาย Android คุณจะมีหลายวิธีในการกำหนดค่าเวอร์ชันเป้าหมาย JVM สำหรับทั้งคอมไพเลอร์ Kotlin และ Java การทำความเข้าใจขอบเขตและลำดับชั้นของการกำหนดค่าเหล่านี้เป็นกุญแจสำคัญในการจัดการความเข้ากันได้ของไบต์โค้ดของโปรเจ็กต์

ต่อไปนี้คือ 3 วิธีหลักในการตั้งค่าเป้าหมาย JVM โดยเรียงจาก ลำดับความสำคัญต่ำสุดไปสูงสุด ค่าเป้าหมาย JVM ที่มีความสําคัญสูงกว่า จะมีผลกับชุดย่อยที่เล็กกว่าของเป้าหมายที่กําหนดค่าไว้ และจะลบล้างค่าที่มี ความสําคัญต่ำกว่า ซึ่งหมายความว่าคุณสามารถตั้งค่า JVM เวอร์ชันต่างๆ สําหรับเป้าหมายและการคอมไพล์ต่างๆ ภายในเป้าหมายในโปรเจ็กต์ได้

การใช้เครื่องมือ Kotlin (ลำดับความสำคัญต่ำสุด)

วิธีที่ทั่วไปที่สุดในการตั้งค่าเป้าหมาย JVM คือการระบุ Toolchain ในบล็อก kotlin ของไฟล์ build.gradle.kts วิธีนี้จะกำหนดเป้าหมายสำหรับทั้งงานการคอมไพล์ Kotlin และ Java ในเป้าหมายที่อิงตาม JVM ทั้งหมดในโปรเจ็กต์ รวมถึง Android

// build.gradle.kts
kotlin {
    jvmToolchain(21)
}

การกำหนดค่านี้ทำให้ทั้ง kotlinc และ javac กำหนดเป้าหมายเป็น JVM 21 ซึ่งเป็นวิธีที่ยอดเยี่ยมในการสร้างพื้นฐานที่สอดคล้องกันสำหรับทั้งโปรเจ็กต์

การใช้ตัวเลือกคอมไพเลอร์ระดับเป้าหมายของ Android (ลำดับความสำคัญปานกลาง)

คุณระบุเป้าหมาย JVM สำหรับเป้าหมาย KMP ของ Android โดยเฉพาะได้ ภายในบล็อก android การตั้งค่านี้จะลบล้างการกำหนดค่า jvmToolchain ทั่วทั้งโปรเจ็กต์และมีผลกับการคอมไพล์ Android ทั้งหมด

// build.gradle.kts
kotlin {
    androidLibrary {
        compilerOptions {
            jvmTarget.set(JvmTarget.JVM_11)
        }
    }
}

ในกรณีนี้ แม้ว่าจะตั้งค่า jvmToolchain เป็นเวอร์ชันอื่น แต่ระบบจะคอมไพล์โค้ด Kotlin และ Java ของเป้าหมาย Android เพื่อกำหนดเป้าหมาย JVM 11

การใช้ตัวเลือกคอมไพเลอร์ระดับการคอมไพล์ (ลำดับความสำคัญสูงสุด)

หากต้องการควบคุมแบบละเอียดที่สุด คุณสามารถกำหนดค่าตัวเลือกคอมไพเลอร์ใน แต่ละการคอมไพล์ (เช่น ใน androidMain หรือ androidHostTest เท่านั้น) ซึ่งจะเป็นประโยชน์หากการคอมไพล์ที่เฉพาะเจาะจงต้องกำหนดเป้าหมายเป็น JVM เวอร์ชันอื่น การตั้งค่านี้จะลบล้างทั้ง Toolchain ของ Kotlin และ ตัวเลือกที่ระดับเป้าหมายของ Android

// build.gradle.kts
kotlin {
    androidLibrary {
        compilations.all {
            compileTaskProvider.configure {
                compilerOptions.jvmTarget.set(JvmTarget.JVM_11)
            }
        }
    }
}

การกำหนดค่านี้ช่วยให้มั่นใจได้ว่าการคอมไพล์ทั้งหมดภายในเป้าหมาย Android จะใช้ JVM 11 ซึ่งให้การควบคุมแบบละเอียด

ปลั๊กอินเดิม

ในโปรเจ็กต์ KMP ที่ใช้ปลั๊กอินไลบรารี Android มาตรฐาน (com.android.library) การกำหนดค่าจะแตกต่างเล็กน้อยจากเมื่อ คุณใช้ปลั๊กอิน KMP Android (แต่ในเชิงแนวคิดจะคล้ายกัน)

การใช้ชุดเครื่องมือ Kotlin

เมธอด kotlin.jvmToolchain() ทำงานในลักษณะเดียวกัน โดยตั้งค่า sourceCompatibility และ targetCompatibility สำหรับ Java และ jvmTarget สำหรับ Kotlin เราขอแนะนำให้ใช้วิธีนี้

// build.gradle.kts
kotlin {
    jvmToolchain(21)
}

compileOptions และ kotlinOptions

หากไม่ได้ใช้เครื่องมือ Kotlin คุณจะต้องกำหนดค่าเป้าหมาย JVM โดยใช้บล็อกแยกต่างหากสำหรับ Java และ Kotlin

// build.gradle.kts
android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_11
        targetCompatibility = JavaVersion.VERSION_11
    }

    kotlinOptions {
        jvmTarget = "11"
    }
}

เอกสารอ้างอิง API ของปลั๊กอิน

ปลั๊กอินใหม่มีพื้นผิว API ที่แตกต่างจาก com.android.library ดูข้อมูลโดยละเอียดเกี่ยวกับ DSL และอินเทอร์เฟซใหม่ได้ที่เอกสารอ้างอิง API

ปัญหาที่ทราบในปลั๊กอินไลบรารี Android-KMP

ปัญหาที่ทราบซึ่งอาจเกิดขึ้นเมื่อใช้ปลั๊กอิน com.android.kotlin.multiplatform.library ใหม่มีดังนี้

ฟีเจอร์ที่ไม่รองรับ

เมื่อเทียบกับการผสานรวม KMP กับปลั๊กอิน com.android.library ปลั๊กอิน com.android.kotlin.multiplatform.library จะไม่มีฟีเจอร์ต่อไปนี้

  • การเชื่อมโยงข้อมูลและการเชื่อมโยงมุมมอง

    ฟีเจอร์เหล่านี้เป็นฟีเจอร์ของเฟรมเวิร์ก UI ที่เฉพาะเจาะจงของ Android ซึ่งเชื่อมโยงอย่างใกล้ชิดกับระบบ Android View และเลย์เอาต์ XML ในปลั๊กอินไลบรารี Android-KMP ใหม่ เราขอแนะนำให้คุณจัดการ UI โดยใช้เฟรมเวิร์กแบบหลายแพลตฟอร์ม เช่น Compose Multiplatform การเชื่อมโยงข้อมูลและการเชื่อมโยง View ถือเป็นรายละเอียดการใช้งานของแอป Android สุดท้าย ไม่ใช่ไลบรารีที่แชร์ได้

  • การรองรับการสร้างโฆษณาเนทีฟ

    ปลั๊กอินใหม่นี้มุ่งเน้นการสร้าง AAR มาตรฐานสำหรับเป้าหมาย Android การผสานรวมโค้ดเนทีฟใน Kotlin Multiplatform จะได้รับการจัดการโดยเป้าหมายเนทีฟของ KMP เองโดยตรง (เช่น androidNativeArm64 และ androidNativeX86) และความสามารถในการทำงานร่วมกันกับ C หากต้องการรวมโค้ด C/C++ แบบเนทีฟ คุณควร กำหนดโค้ดดังกล่าวเป็นส่วนหนึ่งของชุดแหล่งที่มาทั่วไปหรือชุดแหล่งที่มาแบบเนทีฟ และกำหนดค่า C-interop ภายในบล็อก kotlin แทนที่จะใช้กลไก externalNativeBuild เฉพาะของ Android

    หรือหากต้องการการสนับสนุนการบิลด์เนทีฟ เราขอแนะนำให้สร้าง com.android.library แบบสแตนด์อโลนแยกต่างหาก ซึ่งคุณสามารถผสานรวมโค้ดเนทีฟและใช้ไลบรารีแบบสแตนด์อโลนจากโปรเจ็กต์ไลบรารี Kotlin Multiplatform ได้

  • BuildConfig ชั้นเรียน

    ฟีเจอร์ BuildConfig มีประโยชน์มากที่สุดในสภาพแวดล้อมที่มีหลายตัวแปร เนื่องจากปลั๊กอินไลบรารี Kotlin Multiplatform ใหม่ไม่ขึ้นอยู่กับตัวแปร และไม่รองรับประเภทบิลด์และรสชาติผลิตภัณฑ์ เราจึงไม่ได้ใช้ฟีเจอร์นี้ เราขอแนะนำให้ใช้BuildKonfigปลั๊กอิน หรือโซลูชันชุมชนที่คล้ายกันเพื่อสร้างข้อมูลเมตาสำหรับเป้าหมายทั้งหมดแทน