เพิ่ม Kotlin Multiplatform ลงในโปรเจ็กต์ที่มีอยู่

หากต้องการสร้างโมดูล Kotlin Multiplatform (KMP) ภายในโปรเจ็กต์ Android ให้ใช้เทมเพลตโมดูลที่แชร์ Kotlin Multiplatform ซึ่งมีอยู่ใน Android Studio Meerkat และปลั๊กอิน Android Gradle เวอร์ชัน 8.8.0 ขึ้นไป

เทมเพลตโมดูลจะสร้างโมดูลใหม่โดยอัตโนมัติด้วยการกำหนดค่าขั้นต่ำที่กำหนดเป้าหมายไปยังแพลตฟอร์ม Android และ iOS

หมายเหตุ: หากต้องการสร้างแอป iOS คุณต้องมีเครื่อง macOS ที่ติดตั้ง Xcode แล้ว นอกจากนี้ คุณยังต้องติดตั้งโปรแกรมจำลอง iOS หรือมี iPhone ที่เตรียมไว้สำหรับการพัฒนาเพื่อเรียกใช้แอป

ตั้งค่าข้อบังคับ KMP ที่แชร์

หากต้องการสร้างโมดูล KMP ที่แชร์ ให้ทําตามขั้นตอนต่อไปนี้

1. เลือก File > New > New Module
2. เลือกเทมเพลตโมดูลที่แชร์แบบหลายแพลตฟอร์มของ Kotlin ในแผงเทมเพลต

รูปที่ 1 การสร้างข้อบังคับ KMP ใหม่

ฟิลด์ในเทมเพลตมีดังนี้

• ชื่อโมดูล - กําหนดชื่อโมดูล Gradle รวมถึงชื่อเฟรมเวิร์ก iOS (เปลี่ยนได้ในภายหลัง)
• ชื่อแพ็กเกจ - กําหนดชื่อแพ็กเกจสําหรับไฟล์ในโมดูลนี้
  1. คลิกเสร็จสิ้นและอนุญาตให้ Gradle ซิงค์กับโปรเจ็กต์ คุณอาจได้รับข้อความแจ้งให้เพิ่มไฟล์โมดูลที่สร้างขึ้นใหม่ไปยังการควบคุมแหล่งที่มาด้วย

หมายเหตุ: โมดูลที่สร้างขึ้นจะมีฟังก์ชันตัวยึดตำแหน่งพื้นฐานและการทดสอบบางอย่าง ฟังก์ชันตัวยึดตําแหน่งเหล่านี้ช่วยให้มั่นใจว่าโมดูลจะคอมไพล์และทํางานได้สําเร็จ

เมื่อเสร็จแล้ว มุมมองโปรเจ็กต์ของ Android Studio จะแสดงโมดูลที่แชร์ใหม่พร้อมกับชุดแหล่งที่มาสำหรับแต่ละแพลตฟอร์ม

รูปที่ 2 มุมมองโปรเจ็กต์ที่แสดงโมดูลที่แชร์ใหม่

ลิงก์โมดูลที่แชร์กับแอป Android

วิซาร์ดโมดูลจะไม่เพิ่มโมดูลที่สร้างขึ้นใหม่เป็นโมดูลที่ต้องพึ่งพาของโมดูลที่มีอยู่ ขั้นตอนถัดไป คุณต้องลิงก์โมดูลที่แชร์กับหนึ่งในโมดูล Gradle ที่มีอยู่ เช่นเดียวกับทรัพยากร Dependency อื่นๆ ของ Android

dependencies {
    ...
    implementation(project(":shared"))
}

หมายเหตุ: หากโปรเจ็กต์เปิดใช้ฟีเจอร์ตัวเข้าถึงโปรเจ็กต์ที่ปลอดภัยตามประเภทของ Gradle คุณจะเข้าถึงโมดูลที่แชร์ได้ด้วย projects.shared

เมื่อเปิดใช้แล้ว คุณจะเข้าถึงรหัสได้ตามปกติ จากแอป Android คุณจะเข้าถึงโค้ดที่อยู่ใน androidMain หรือ commonMain ได้

ดูข้อมูลเพิ่มเติมเกี่ยวกับโครงสร้างโปรเจ็กต์ Kotlin Multiplatform ได้ที่พื้นฐานของโครงสร้างโปรเจ็กต์ Kotlin Multiplatform

ตั้งค่าโมดูลที่แชร์ในแอป iOS

Swift ใช้โมดูล Kotlin โดยตรงไม่ได้ และต้องสร้างเฟรมเวิร์กไบนารีที่คอมไพล์แล้ว

หมายเหตุ: ปลั๊กอิน Kotlin Gradle ยังรองรับการผสานรวม Swift Package Manager หรือการผสานรวม Cocoapods เพื่อแชร์และใช้โค้ดทั่วไปที่สร้างสำหรับ Kotlin และ Native (iOS)

เทมเพลตโมดูลใหม่ใน Android Studio จะกำหนดค่าโมดูลที่แชร์เพื่อสร้างเฟรมเวิร์กสำหรับสถาปัตยกรรม iOS แต่ละรายการ คุณดูโค้ดต่อไปนี้ได้ในไฟล์ build.gradle.kts ของโมดูลที่แชร์

val xcfName = "sharedKit"

iosX64 {
  binaries.framework {
    baseName = xcfName
  }
}

iosArm64 {
  binaries.framework {
    baseName = xcfName
  }
}

iosSimulatorArm64 {
  binaries.framework {
    baseName = xcfName
  }
}

ดูข้อมูลเกี่ยวกับการกําหนดประเภทสถาปัตยกรรมอื่นๆ ได้ที่โครงสร้างโปรเจ็กต์แบบลําดับชั้น

หมายเหตุ: เฟรมเวิร์กเอาต์พุตจะเรียกว่า sharedKit โดยค่าเริ่มต้นตามที่ระบุไว้ในไฟล์ build.gradle.kts ของโมดูลที่แชร์ ในโปรเจ็กต์ของคุณเอง คุณสามารถเปลี่ยนชื่อได้ตามต้องการโดยควบคุมตัวแปร xcfName

ลิงก์ไลบรารีที่ใช้ร่วมกันในโปรเจ็กต์ iOS

หากต้องการเปิดใช้การเข้าถึงโค้ดที่แชร์จากโปรเจ็กต์ iOS ให้เพิ่มระยะการทำงานของสคริปต์เพื่อสร้างเฟรมเวิร์ก Kotlin ก่อนคอมไพล์ซอร์สโค้ด Swift โดยทำดังนี้

หมายเหตุ: คุณยังเปิดโปรเจ็กต์ Xcode ได้โดยดับเบิลคลิกไฟล์ xcodeproj ใน Finder

1. คลิกขวาที่ไฟล์ใน Android Studio แล้วเลือกเปิดในและเปิดในแอปพลิเคชันที่เกี่ยวข้อง ซึ่งจะเปิดแอป iOS ใน Xcode

รูปที่ 3 เปิดในแอปพลิเคชันที่เกี่ยวข้อง

1. เปิดการตั้งค่าโปรเจ็กต์โดยดับเบิลคลิกชื่อโปรเจ็กต์ในเครื่องมือนำทางโปรเจ็กต์

รูปที่ 4 กล่องโต้ตอบการตั้งค่าโปรเจ็กต์ Xcode

1. เปลี่ยนชื่อเริ่มต้นของเรียกใช้สคริปต์เป็นคอมไพล์เฟรมเวิร์ก Kotlin เพื่อให้ระบุสิ่งที่เฟสนี้ทําได้ดีขึ้น ดับเบิลคลิกชื่อเรียกใช้สคริปต์เพื่อแก้ไข
2. ขยายระยะการสร้าง และป้อนโค้ดสคริปต์ต่อไปนี้ในช่องข้อความ Shell

รูปที่ 5 เรียกใช้ระยะการสร้างสคริปต์

หมายเหตุ: cd "$SRCROOT/.." นำทางสคริปต์ไปยังโฟลเดอร์รูทของโปรเจ็กต์ KMP Gradle ซึ่งในกรณีนี้จะเป็นโฟลเดอร์หลัก หากโปรเจ็กต์ iOS อยู่ในเส้นทางอื่น คุณจะต้องปรับแต่งที่นี่

1. ลากระยะเรียกใช้สคริปต์ไว้ก่อนระยะคอมไพล์แหล่งที่มา

   

   รูปที่ 6 เรียกใช้ระยะการสร้างสคริปต์ก่อนคอมไพล์ซอร์สโค้ด

2. บิลด์โปรเจ็กต์ใน Xcode โดยคลิก ⌘B หรือไปที่เมนูผลิตภัณฑ์ แล้วเลือกสร้าง

เมื่อบิลด์สําเร็จ คุณจะเห็นไอคอนต่อไปนี้

รูปที่ 7 การสร้างสําเร็จ

เข้าถึงรหัสที่แชร์ในแอป iOS

หากต้องการยืนยันว่าแอป iOS สามารถเข้าถึงโค้ดจากโมดูลที่แชร์ได้สําเร็จ ให้ทําดังนี้

1. ในโปรเจ็กต์ iOS ให้เปิดไฟล์ ContentView.swift ที่ Sources/View/ContentView.swift
2. เพิ่มการนําเข้า sharedKit ที่ด้านบนของไฟล์
3. แก้ไขมุมมองข้อความให้รวมข้อมูล Platform_iosKt.platform() ในสตริงที่แสดงดังต่อไปนี้

หมายเหตุ: การแทรกสตริงใน Swift ใช้ไวยากรณ์ (code)

การอัปเดตนี้จะตรวจสอบว่าแอปเรียกใช้ฟังก์ชัน platform() จากโมดูลที่แชร์ได้หรือไม่ ซึ่งควรแสดงผลเป็น "iOS" เมื่อทำงานบนแพลตฟอร์ม iOS

รูปที่ 8 เครื่องจำลอง Xcode ที่เรียกใช้แอป iOS

แหล่งข้อมูลเพิ่มเติม

หากคุณเพิ่งเริ่มพัฒนา KMP โปรดดูคำแนะนำเพิ่มเติมในเอกสารประกอบอย่างเป็นทางการของ KMP หากคุณเพิ่งเริ่มพัฒนา iOS โปรดดูเอกสารประกอบเกี่ยวกับพื้นฐานของ Swift