ระบบบิลด์ Android จะคอมไพล์ทรัพยากรของแอปและซอร์สโค้ด แล้วแพ็กเกจเป็น APK หรือ Android App Bundle ที่คุณทดสอบ นำไปใช้งาน ลงนาม และเผยแพร่ได้
ในภาพรวมการสร้างของ Gradle และโครงสร้างการสร้างของ Android เราได้พูดถึงแนวคิดการสร้างและโครงสร้างของแอป Android ตอนนี้ถึงเวลากำหนดค่าการสร้างแล้ว
อภิธานศัพท์บิลด์ของ Android
Gradle และปลั๊กอิน Android Gradle ช่วยคุณกำหนดค่าด้านต่างๆ ต่อไปนี้ของบิลด์
- ประเภทบิลด์
-
ประเภทการสร้างจะกำหนดพร็อพเพอร์ตี้บางอย่างที่ Gradle ใช้เมื่อสร้างและแพ็กเกจแอป โดยปกติแล้วประเภทการสร้างจะกำหนดค่าสำหรับระยะต่างๆ ของวงจรการพัฒนา
ตัวอย่างเช่น ประเภทบิลด์การแก้ไขข้อบกพร่องจะเปิดใช้ตัวเลือกการแก้ไขข้อบกพร่อง และรับรองแอปด้วยคีย์การแก้ไขข้อบกพร่อง ในขณะที่ประเภทบิลด์รุ่นอาจย่อ ปรับให้ยากต่อการอ่าน (Obfuscate) และรับรองแอปด้วยคีย์รุ่นสำหรับการเผยแพร่
คุณต้องกำหนดประเภทบิลด์อย่างน้อย 1 ประเภทเพื่อสร้างแอป Android Studio จะสร้างประเภทบิลด์แก้ไขข้อบกพร่องและรุ่นโดยค่าเริ่มต้น หากต้องการเริ่มปรับแต่งการตั้งค่าการแพ็กเกจสำหรับแอป ให้ดูวิธีกำหนดค่าประเภทบิลด์
- รสชาติของผลิตภัณฑ์
- ตัวแปรผลิตภัณฑ์แสดงถึงแอปเวอร์ชันต่างๆ ที่คุณเผยแพร่ให้ผู้ใช้ใช้ได้ เช่น เวอร์ชันฟรีและเวอร์ชันที่ต้องชำระเงิน คุณสามารถปรับแต่ง Flavour ของผลิตภัณฑ์เพื่อใช้โค้ดและทรัพยากรที่แตกต่างกันขณะแชร์และใช้ซ้ำในส่วนที่เหมือนกันกับแอปทุกเวอร์ชันได้ Flavour ของผลิตภัณฑ์เป็นตัวเลือกที่คุณสร้างได้เอง หากต้องการเริ่มสร้างแอปเวอร์ชันต่างๆ ให้ดูวิธีกําหนดค่ารุ่นผลิตภัณฑ์
- ตัวแปรของบิลด์
- ตัวแปรการสร้างคือผลิตภัณฑ์ร่วมของประเภทการสร้างและตัวแปรผลิตภัณฑ์ และเป็นการกำหนดค่าที่ Gradle ใช้สร้างแอป การใช้ตัวแปรการสร้างจะช่วยให้คุณสร้างตัวแปรผลิตภัณฑ์เวอร์ชันแก้ไขข้อบกพร่องในระหว่างการพัฒนา และตัวแปรผลิตภัณฑ์เวอร์ชันที่เผยแพร่และรับรองแล้วสำหรับการเผยแพร่ได้ แม้ว่าคุณจะไม่ได้กำหนดค่าตัวแปรของบิวด์โดยตรง แต่คุณก็กำหนดค่าประเภทบิวด์และตัวแปรผลิตภัณฑ์ที่รวมกันเป็นตัวแปรของบิวด์ได้ การสร้างประเภทบิลด์เพิ่มเติมหรือเวอร์ชันผลิตภัณฑ์ยังเป็นการสร้างตัวแปรของบิลด์เพิ่มเติมด้วย หากต้องการดูวิธีสร้างและจัดการตัวแปรของบิวด์ โปรดอ่านภาพรวมกำหนดค่าตัวแปรของบิวด์
- รายการ Manifest
- คุณสามารถระบุค่าสำหรับพร็อพเพอร์ตี้บางอย่างของไฟล์ Manifest ในการกำหนดค่าตัวแปรของบิลด์ได้ ค่าการสร้างเหล่านี้จะลบล้างค่าที่มีอยู่ในไฟล์ Manifest ซึ่งจะมีประโยชน์หากคุณต้องการสร้างตัวแปรหลายรายการของแอปที่มีชื่อแอปพลิเคชัน เวอร์ชัน SDK ขั้นต่ำ หรือเวอร์ชัน SDK เป้าหมายแตกต่างกัน เมื่อมีไฟล์ Manifest หลายรายการ เครื่องมือผสานไฟล์ Manifest จะผสานการตั้งค่าไฟล์ Manifest
- Dependency
- ระบบบิลด์จะจัดการทรัพยากร Dependency ของโปรเจ็กต์จากระบบไฟล์ในเครื่องและจากที่เก็บระยะไกล ซึ่งหมายความว่าคุณไม่จําเป็นต้องค้นหา ดาวน์โหลด และคัดลอกแพ็กเกจไบนารีของไลบรารีที่ใช้ร่วมกันลงในไดเรกทอรีโปรเจ็กต์ด้วยตนเอง ดูข้อมูลเพิ่มเติมได้ที่หัวข้อเพิ่มการพึ่งพิงบิวด์
- การลงชื่อ
- ระบบบิลด์ช่วยให้คุณระบุการตั้งค่าการรับรองในการกำหนดค่าบิลด์ได้ และสามารถรับรองแอปโดยอัตโนมัติในระหว่างกระบวนการบิลด์ ระบบบิลด์จะเซ็นชื่อเวอร์ชันแก้ไขข้อบกพร่องด้วยคีย์และใบรับรองเริ่มต้นโดยใช้ข้อมูลเข้าสู่ระบบที่ทราบเพื่อหลีกเลี่ยงข้อความแจ้งให้ป้อนรหัสผ่านขณะสร้าง ระบบบิลด์จะไม่เซ็นชื่อเวอร์ชันที่เผยแพร่ เว้นแต่คุณจะกำหนดค่าการเซ็นชื่อสำหรับบิลด์นี้อย่างชัดเจน หากไม่มีคีย์รุ่น คุณสามารถสร้างคีย์ได้ตามที่อธิบายไว้ในลงนามแอป คุณต้องเผยแพร่บิลด์รุ่นที่ลงนามแล้วผ่าน App Store ส่วนใหญ่
- การลดขนาดโค้ดและทรัพยากร
- ระบบการสร้างช่วยให้คุณระบุไฟล์กฎ ProGuard ที่แตกต่างกันสำหรับตัวแปรการสร้างแต่ละรายการได้ เมื่อสร้างแอป ระบบบิลด์จะใช้ชุดกฎที่เหมาะสมเพื่อย่อโค้ดและทรัพยากรโดยใช้เครื่องมือลดขนาดในตัว เช่น R8 การย่อโค้ดและทรัพยากรจะช่วยลดความจุของ APK หรือ AAB
- การรองรับ APK หลายรายการ
- ระบบบิลด์ช่วยให้คุณสร้าง APK ที่แตกต่างกันโดยอัตโนมัติ ซึ่งแต่ละรายการจะมีเฉพาะโค้ดและทรัพยากรที่จําเป็นสําหรับความหนาแน่นของหน้าจอหรือ Application Binary Interface (ABI) ที่เฉพาะเจาะจง ดูข้อมูลเพิ่มเติมได้ที่ สร้าง APK หลายรายการ อย่างไรก็ตาม เราขอแนะนำให้เผยแพร่ AAB รายการเดียว เนื่องจากมีการแยกตามภาษานอกเหนือจากความหนาแน่นของหน้าจอและ ABI และคุณไม่จำเป็นต้องอัปโหลดอาร์ติแฟกต์หลายรายการไปยัง Google Play แอปใหม่ทั้งหมดที่ส่งหลังจากเดือนสิงหาคม 2021 ต้องใช้ AAB
เวอร์ชัน Java ในบิลด์ Android
ไม่ว่าซอร์สโค้ดจะเขียนด้วย Java, Kotlin หรือทั้ง 2 อย่าง คุณต้องเลือกเวอร์ชัน JDK หรือภาษา Java สำหรับบิลด์ในหลายตำแหน่ง ดูรายละเอียดได้ที่เวอร์ชัน Java ในบิลด์ Android
ไฟล์การกำหนดค่าบิวด์
การสร้างการกำหนดค่าบิลด์ที่กำหนดเองกำหนดให้คุณต้องทําการเปลี่ยนแปลงในไฟล์การกําหนดค่าบิลด์อย่างน้อย 1 ไฟล์ ไฟล์ข้อความธรรมดาเหล่านี้ใช้ภาษาเฉพาะโดเมน (DSL) เพื่ออธิบายและจัดการตรรกะของบิลด์โดยใช้สคริปต์ Kotlin ซึ่งเป็นรูปแบบหนึ่งของภาษา Kotlin นอกจากนี้ คุณยังใช้ Groovy ซึ่งเป็นภาษาแบบไดนามิกสําหรับเครื่องเสมือน Java (JVM) เพื่อกําหนดค่าบิลด์ได้ด้วย
คุณไม่จำเป็นต้องรู้สคริปต์ Kotlin หรือ Groovy เพื่อเริ่มกำหนดค่าบิลด์ เนื่องจากปลั๊กอิน Gradle ของ Android จะแนะนำองค์ประกอบ DSL ส่วนใหญ่ที่คุณต้องการ หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ DSL ของปลั๊กอิน Android Gradle โปรดอ่านเอกสารอ้างอิง DSL สคริปต์ Kotlin ยังต้องอาศัย Gradle Kotlin DSL พื้นฐานด้วย
เมื่อเริ่มต้นโปรเจ็กต์ใหม่ Android Studio จะสร้างไฟล์เหล่านี้บางส่วนให้คุณโดยอัตโนมัติ และป้อนข้อมูลไฟล์ตามค่าเริ่มต้นที่เหมาะสม ดูภาพรวมของไฟล์ที่สร้างขึ้นได้ที่โครงสร้างบิลด์ของ Android
ไฟล์ Gradle Wrapper
Gradle Wrapper (gradlew
) เป็นแอปพลิเคชันขนาดเล็กที่รวมอยู่ในซอร์สโค้ดที่ดาวน์โหลดและเปิดใช้ Gradle เอง
ซึ่งจะทําให้การดำเนินการบิลด์สอดคล้องกันมากขึ้น นักพัฒนาแอปจะดาวน์โหลดแหล่งที่มาของแอปพลิเคชันและเรียกใช้ gradlew
ซึ่งจะดาวน์โหลดการกระจายของ Gradle ที่จำเป็น
และเปิดใช้ Gradle เพื่อสร้างแอปพลิเคชันของคุณ
ไฟล์ gradle/wrapper/gradle-wrapper.properties
ประกอบด้วยพร็อพเพอร์ตี้ distributionUrl
ซึ่งอธิบายว่าใช้ Gradle เวอร์ชันใดเพื่อเรียกใช้บิลด์
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
ไฟล์การตั้งค่า Gradle
ไฟล์ settings.gradle.kts
(สำหรับ DSL ของ Kotlin) หรือไฟล์ settings.gradle
(สำหรับ DSL ของ Groovy) จะอยู่ในไดเรกทอรีรูทของโปรเจ็กต์ ไฟล์การตั้งค่านี้จะกำหนดการตั้งค่าที่เก็บระดับโปรเจ็กต์และแจ้งให้ Gradle ทราบว่าควรรวมโมดูลใดบ้างเมื่อสร้างแอป โปรเจ็กต์แบบหลายโมดูลต้องระบุแต่ละโมดูลที่ควรรวมไว้ในบิลด์ขั้นสุดท้าย
สําหรับโปรเจ็กต์ส่วนใหญ่ ไฟล์จะมีลักษณะดังต่อไปนี้โดยค่าเริ่มต้น
Kotlin
pluginManagement { /** * The pluginManagement.repositories block configures the * repositories Gradle uses to search or download the Gradle plugins and * their transitive dependencies. Gradle pre-configures support for remote * repositories such as JCenter, Maven Central, and Ivy. You can also use * local repositories or define your own remote repositories. Here we * define the Gradle Plugin Portal, Google's Maven repository, * and the Maven Central Repository as the repositories Gradle should use to look for its * dependencies. */ repositories { gradlePluginPortal() google() mavenCentral() } } dependencyResolutionManagement { /** * The dependencyResolutionManagement.repositories * block is where you configure the repositories and dependencies used by * all modules in your project, such as libraries that you are using to * create your application. However, you should configure module-specific * dependencies in each module-level build.gradle file. For new projects, * Android Studio includes Google's Maven repository and the Maven Central * Repository by default, but it does not configure any dependencies (unless * you select a template that requires some). */ repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { google() mavenCentral() } } rootProject.name = "My Application" include(":app")
Groovy
pluginManagement { /** * The pluginManagement.repositories block configures the * repositories Gradle uses to search or download the Gradle plugins and * their transitive dependencies. Gradle pre-configures support for remote * repositories such as JCenter, Maven Central, and Ivy. You can also use * local repositories or define your own remote repositories. Here we * define the Gradle Plugin Portal, Google's Maven repository, * and the Maven Central Repository as the repositories Gradle should use to look for its * dependencies. */ repositories { gradlePluginPortal() google() mavenCentral() } } dependencyResolutionManagement { /** * The dependencyResolutionManagement.repositories * block is where you configure the repositories and dependencies used by * all modules in your project, such as libraries that you are using to * create your application. However, you should configure module-specific * dependencies in each module-level build.gradle file. For new projects, * Android Studio includes Google's Maven repository and the Maven Central * Repository by default, but it does not configure any dependencies (unless * you select a template that requires some). */ repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { google() mavenCentral() } } rootProject.name = "My Application" include ':app'
ไฟล์บิลด์ระดับบนสุด
ไฟล์ build.gradle.kts
ระดับบนสุด (สำหรับ DSL ของ Kotlin) หรือไฟล์ build.gradle
(สำหรับ DSL ของ Groovy) จะอยู่ในไดเรกทอรีรูทของโปรเจ็กต์ โดยปกติแล้วจะใช้กำหนดเวอร์ชันทั่วไปของปลั๊กอินที่ใช้โดยโมดูลในโปรเจ็กต์
ตัวอย่างโค้ดต่อไปนี้อธิบายการตั้งค่าเริ่มต้นและองค์ประกอบ DSL ในสคริปต์บิลด์ระดับบนสุดหลังจากสร้างโปรเจ็กต์ใหม่
Kotlin
plugins { /** * Use `apply false` in the top-level build.gradle file to add a Gradle * plugin as a build dependency but not apply it to the current (root) * project. Don't use `apply false` in sub-projects. For more information, * see Applying external plugins with same version to subprojects. */ id("com.android.application") version "8.7.0" apply false id("com.android.library") version "8.7.0" apply false id("org.jetbrains.kotlin.android") version "2.0.20" apply false }
Groovy
plugins { /** * Use `apply false` in the top-level build.gradle file to add a Gradle * plugin as a build dependency but not apply it to the current (root) * project. Don't use `apply false` in sub-projects. For more information, * see Applying external plugins with same version to subprojects. */ id 'com.android.application' version '8.7.0' apply false id 'com.android.library' version '8.7.0' apply false id 'org.jetbrains.kotlin.android' version '2.0.20' apply false }
ไฟล์บิลด์ระดับโมดูล
ไฟล์ build.gradle.kts
(สําหรับ DSL ของ Kotlin) หรือ build.gradle
(สําหรับ DSL ของ Groovy) ระดับโมดูลจะอยู่ในไดเรกทอรี project/module/
แต่ละไดเรกทอรี ซึ่งจะช่วยให้คุณกำหนดการตั้งค่าการสร้างสำหรับโมดูลที่เฉพาะเจาะจงได้ การกำหนดการตั้งค่าบิลด์เหล่านี้ช่วยให้คุณระบุตัวเลือกแพ็กเกจที่กำหนดเองได้ เช่น ประเภทบิลด์เพิ่มเติมและเวอร์ชันผลิตภัณฑ์ รวมถึงลบล้างการตั้งค่าในไฟล์ Manifest ของแอป main/
หรือสคริปต์บิลด์ระดับบนสุด
การตั้งค่า Android SDK
ไฟล์บิลด์ระดับโมดูลสําหรับแอปพลิเคชันของคุณมีการตั้งค่าที่ระบุเวอร์ชัน Android SDK ที่ใช้เมื่อคอมไพล์ เลือกลักษณะการทํางานของแพลตฟอร์ม และระบุเวอร์ชันขั้นต่ำที่แอปพลิเคชันของคุณทํางานได้
-
compileSdk
-
compileSdk
จะกำหนดว่า API ของ Android และ Java ใดบ้างที่พร้อมใช้งานเมื่อคอมไพล์ซอร์สโค้ด หากต้องการใช้ฟีเจอร์ล่าสุดของ Android ให้ใช้ Android SDK เวอร์ชันล่าสุดเมื่อคอมไพล์API ของแพลตฟอร์ม Android บางรายการอาจไม่พร้อมใช้งานใน API ระดับที่เก่ากว่า คุณสามารถปกป้องการใช้ฟีเจอร์ใหม่แบบมีเงื่อนไขหรือใช้ไลบรารีความเข้ากันได้ของ AndroidX เพื่อใช้ฟีเจอร์ใหม่กับ API ของ Android ระดับต่ำกว่าได้
SDK ของ Android แต่ละรายการจะมี Java API ชุดย่อยสําหรับใช้ในแอปพลิเคชัน ตารางที่หัวข้อ ฉันใช้ Java API ระดับใดในซอร์สโค้ด Java หรือ Kotlin ได้บ้างจะแสดงระดับ Java API ที่พร้อมใช้งานตามเวอร์ชัน Android SDK Android เวอร์ชันเก่ารองรับ Java API เวอร์ชันใหม่ผ่านการถอด Sugar ซึ่งต้องเปิดใช้ในบิลด์
Android Studio จะแสดงคำเตือนหาก
compileSdk
ของคุณขัดแย้งกับข้อกำหนดของ Android Studio, AGP หรือไลบรารีของโปรเจ็กต์เวอร์ชันปัจจุบัน -
minSdk
-
minSdk
จะระบุ Android เวอร์ชันต่ำสุดที่คุณต้องการให้แอปรองรับ การตั้งค่าminSdk
จะจำกัดอุปกรณ์ที่ติดตั้งแอปได้การรองรับ Android เวอร์ชันที่ต่ำกว่าอาจต้องใช้การตรวจสอบแบบมีเงื่อนไขเพิ่มเติมในโค้ดหรือการใช้ไลบรารีความเข้ากันได้ของ AndroidX มากขึ้น คุณควรชั่งน้ำหนักค่าใช้จ่ายในการบำรุงรักษาเพื่อรองรับเวอร์ชันที่ต่ำกว่าเมื่อเทียบกับเปอร์เซ็นต์ของผู้ใช้ที่ยังใช้เวอร์ชันที่ต่ำกว่า ดูแผนภูมิเวอร์ชันในวิซาร์ดใหม่ของโปรเจ็กต์ของ Android Studio เพื่อดูเปอร์เซ็นต์การใช้เวอร์ชันปัจจุบัน
เมื่อแก้ไขโค้ดใน Android Studio หรือเรียกใช้การตรวจสอบระหว่างการสร้าง Lint จะเตือนเกี่ยวกับ API ที่คุณใช้ซึ่งไม่พร้อมใช้งานใน
minSdk
คุณควรแก้ไขข้อบกพร่องเหล่านี้โดยทำให้ฟีเจอร์ใหม่เป็นแบบมีเงื่อนไข หรือใช้Appcompat
เพื่อให้มีความเข้ากันได้แบบย้อนหลัง -
targetSdk
-
targetSdk
มีไว้เพื่อวัตถุประสงค์ 2 อย่าง ได้แก่- ซึ่งจะกำหนดลักษณะการทํางานของรันไทม์ของแอปพลิเคชัน
- ข้อมูลนี้ระบุเวอร์ชัน Android ที่คุณทดสอบ
หากคุณใช้อุปกรณ์ที่ใช้ Android เวอร์ชันสูงกว่า
targetSdk
ของคุณ Android จะเรียกใช้แอปในโหมดความเข้ากันได้ที่มีลักษณะการทำงานคล้ายกับเวอร์ชันต่ำกว่าที่ระบุไว้ในtargetSdk
ตัวอย่างเช่น เมื่อ API 23 เปิดตัวรูปแบบสิทธิ์รันไทม์ แอปบางแอปยังไม่พร้อมที่จะใช้รูปแบบดังกล่าวในทันที เมื่อตั้งค่าtargetSdk
เป็น 22 แอปเหล่านั้นจะทำงานในอุปกรณ์ API 23 ได้โดยไม่ต้องใช้สิทธิ์รันไทม์ และใช้ฟีเจอร์ที่มีในcompileSdk
เวอร์ชันล่าสุดได้ นโยบายการจัดจำหน่ายของ Google Play บังคับใช้นโยบายเพิ่มเติมในระดับ API เป้าหมายค่าของ
targetSdk
ต้องน้อยกว่าหรือเท่ากับค่าของcompileSdk
หมายเหตุ: ค่าของ compileSdk
และ targetSdk
ไม่จำเป็นต้องเหมือนกัน โปรดคำนึงถึงหลักการพื้นฐานต่อไปนี้
compileSdk
ให้สิทธิ์เข้าถึง API ใหม่แก่คุณtargetSdk
กำหนดลักษณะการทํางานรันไทม์ของแอปtargetSdk
ต้องน้อยกว่าหรือเท่ากับcompileSdk
ตัวอย่างสคริปต์การสร้างโมดูลแอป
ตัวอย่างสคริปต์การสร้างโมดูลแอป Android นี้แสดงองค์ประกอบและการตั้งค่า DSL พื้นฐานบางส่วน
Kotlin
/** * The first section in the build configuration applies the Android Gradle plugin * to this build and makes the android block available to specify * Android-specific build options. */ plugins { id("com.android.application") } /** * Locate (and possibly download) a JDK used to build your kotlin * source code. This also acts as a default for sourceCompatibility, * targetCompatibility and jvmTarget. Note that this does not affect which JDK * is used to run the Gradle build itself, and does not need to take into * account the JDK version required by Gradle plugins (such as the * Android Gradle Plugin) */ kotlin { jvmToolchain(11) } /** * The android block is where you configure all your Android-specific * build options. */ android { /** * The app's namespace. Used primarily to access app resources. */ namespace = "com.example.myapp" /** * compileSdk specifies the Android API level Gradle should use to * compile your app. This means your app can use the API features included in * this API level and lower. */ compileSdk = 33 /** * The defaultConfig block encapsulates default settings and entries for all * build variants and can override some attributes in main/AndroidManifest.xml * dynamically from the build system. You can configure product flavors to override * these values for different versions of your app. */ defaultConfig { // Uniquely identifies the package for publishing. applicationId = "com.example.myapp" // Defines the minimum API level required to run the app. minSdk = 21 // Specifies the API level used to test the app. targetSdk = 33 // Defines the version number of your app. versionCode = 1 // Defines a user-friendly version name for your app. versionName = "1.0" } /** * The buildTypes block is where you can configure multiple build types. * By default, the build system defines two build types: debug and release. The * debug build type is not explicitly shown in the default build configuration, * but it includes debugging tools and is signed with the debug key. The release * build type applies ProGuard settings and is not signed by default. */ buildTypes { /** * By default, Android Studio configures the release build type to enable code * shrinking, using minifyEnabled, and specifies the default ProGuard rules file. */ getByName("release") { isMinifyEnabled = true // Enables code shrinking for the release build type. proguardFiles( getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro" ) } } /** * The productFlavors block is where you can configure multiple product flavors. * This lets you create different versions of your app that can * override the defaultConfig block with their own settings. Product flavors * are optional, and the build system does not create them by default. * * This example creates a free and paid product flavor. Each product flavor * then specifies its own application ID, so that they can exist on the Google * Play Store or an Android device simultaneously. * * If you declare product flavors, you must also declare flavor dimensions * and assign each flavor to a flavor dimension. */ flavorDimensions += "tier" productFlavors { create("free") { dimension = "tier" applicationId = "com.example.myapp.free" } create("paid") { dimension = "tier" applicationId = "com.example.myapp.paid" } } /** * To override source and target compatibility (if different from the * toolchain JDK version), add the following. All of these * default to the same value as kotlin.jvmToolchain. If you're using the * same version for these values and kotlin.jvmToolchain, you can * remove these blocks. */ //compileOptions { // sourceCompatibility = JavaVersion.VERSION_11 // targetCompatibility = JavaVersion.VERSION_11 //} //kotlinOptions { // jvmTarget = "11" //} } /** * The dependencies block in the module-level build configuration file * specifies dependencies required to build only the module itself. * To learn more, go to Add build dependencies. */ dependencies { implementation(project(":lib")) implementation("androidx.appcompat:appcompat:1.7.0") implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.jar")))) }
Groovy
/** * The first line in the build configuration applies the Android Gradle plugin * to this build and makes the android block available to specify * Android-specific build options. */ plugins { id 'com.android.application' } /** * Locate (and possibly download) a JDK used to build your kotlin * source code. This also acts as a default for sourceCompatibility, * targetCompatibility and jvmTarget. Note that this does not affect which JDK * is used to run the Gradle build itself, and does not need to take into * account the JDK version required by Gradle plugins (such as the * Android Gradle Plugin) */ kotlin { jvmToolchain 11 } /** * The android block is where you configure all your Android-specific * build options. */ android { /** * The app's namespace. Used primarily to access app resources. */ namespace 'com.example.myapp' /** * compileSdk specifies the Android API level Gradle should use to * compile your app. This means your app can use the API features included in * this API level and lower. */ compileSdk 33 /** * The defaultConfig block encapsulates default settings and entries for all * build variants and can override some attributes in main/AndroidManifest.xml * dynamically from the build system. You can configure product flavors to override * these values for different versions of your app. */ defaultConfig { // Uniquely identifies the package for publishing. applicationId 'com.example.myapp' // Defines the minimum API level required to run the app. minSdk 21 // Specifies the API level used to test the app. targetSdk 33 // Defines the version number of your app. versionCode 1 // Defines a user-friendly version name for your app. versionName "1.0" } /** * The buildTypes block is where you can configure multiple build types. * By default, the build system defines two build types: debug and release. The * debug build type is not explicitly shown in the default build configuration, * but it includes debugging tools and is signed with the debug key. The release * build type applies ProGuard settings and is not signed by default. */ buildTypes { /** * By default, Android Studio configures the release build type to enable code * shrinking, using minifyEnabled, and specifies the default ProGuard rules file. */ release { minifyEnabled true // Enables code shrinking for the release build type. proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } /** * The productFlavors block is where you can configure multiple product flavors. * This lets you create different versions of your app that can * override the defaultConfig block with their own settings. Product flavors * are optional, and the build system does not create them by default. * * This example creates a free and paid product flavor. Each product flavor * then specifies its own application ID, so that they can exist on the Google * Play Store or an Android device simultaneously. * * If you declare product flavors, you must also declare flavor dimensions * and assign each flavor to a flavor dimension. */ flavorDimensions "tier" productFlavors { free { dimension "tier" applicationId 'com.example.myapp.free' } paid { dimension "tier" applicationId 'com.example.myapp.paid' } } /** * To override source and target compatibility (if different from the * tool chain JDK version), add the following. All of these * default to the same value as kotlin.jvmToolchain. If you're using the * same version for these values and kotlin.jvmToolchain, you can * remove these blocks. */ //compileOptions { // sourceCompatibility JavaVersion.VERSION_11 // targetCompatibility JavaVersion.VERSION_11 //} //kotlinOptions { // jvmTarget = '11' //} } /** * The dependencies block in the module-level build configuration file * specifies dependencies required to build only the module itself. * To learn more, go to Add build dependencies. */ dependencies { implementation project(":lib") implementation 'androidx.appcompat:appcompat:1.7.0' implementation fileTree(dir: 'libs', include: ['*.jar']) }
ไฟล์พร็อพเพอร์ตี้ Gradle
นอกจากนี้ Gradle ยังมีไฟล์พร็อพเพอร์ตี้ 2 ไฟล์ที่อยู่ในไดเรกทอรีรูทของโปรเจ็กต์ ซึ่งคุณใช้เพื่อระบุการตั้งค่าสำหรับเครื่องมือสร้าง Gradle ได้ ดังนี้
-
gradle.properties
- ซึ่งคุณจะกำหนดการตั้งค่า Gradle ของทั้งโปรเจ็กต์ได้ เช่น ขนาดฮีปสูงสุดของ Daemon ของ Gradle ดูข้อมูลเพิ่มเติมได้ที่สภาพแวดล้อมการสร้าง
-
local.properties
-
กำหนดค่าพร็อพเพอร์ตี้สภาพแวดล้อมในเครื่องสำหรับระบบบิลด์ ซึ่งรวมถึงสิ่งต่อไปนี้
ndk.dir
- เส้นทางไปยัง NDK เลิกใช้งานพร็อพเพอร์ตี้นี้แล้ว ระบบจะติดตั้ง NDK เวอร์ชันที่ดาวน์โหลดไว้ในไดเรกทอรีndk
ภายในไดเรกทอรี Android SDKsdk.dir
- เส้นทางไปยัง Android SDKcmake.dir
- Path to CMakendk.symlinkdir
- ใน Android Studio 3.5 ขึ้นไป จะสร้างลิงก์สัญลักษณ์ไปยัง NDK ที่สั้นกว่าเส้นทาง NDK ที่ติดตั้ง
แมป NDK กับเส้นทางที่สั้นลง (Windows เท่านั้น)
ใน Windows เครื่องมือในโฟลเดอร์ NDK ที่ติดตั้ง เช่น ld.exe
จะมีเส้นทางที่ยาว เครื่องมือไม่รองรับเส้นทางที่ยาวมากนัก
หากต้องการสร้างเส้นทางที่สั้นลง ให้ตั้งค่าพร็อพเพอร์ตี้ local.properties
ใน ndk.symlinkdir
เพื่อขอให้ปลั๊กอิน Android Gradle สร้างลิงก์สัญลักษณ์ไปยัง NDK เส้นทางของลิงก์สัญลักษณ์นั้นสั้นกว่าโฟลเดอร์ NDK ที่มีอยู่ได้
ตัวอย่างเช่น ndk.symlinkdir = C:\
จะให้ผลลัพธ์เป็นลิงก์สัญลักษณ์ต่อไปนี้ C:\ndk\19.0.5232133
ซิงค์โปรเจ็กต์กับไฟล์ Gradle
เมื่อคุณทำการเปลี่ยนแปลงไฟล์การกำหนดค่าการสร้างในโปรเจ็กต์ Android Studio จะกำหนดให้คุณซิงค์ไฟล์โปรเจ็กต์เพื่อให้สามารถนำเข้าการเปลี่ยนแปลงการกำหนดค่าการสร้างและเรียกใช้การตรวจสอบบางอย่างเพื่อให้แน่ใจว่าการกำหนดค่าจะไม่ทำให้เกิดข้อผิดพลาดในการสร้าง
หากต้องการซิงค์ไฟล์โปรเจ็กต์ ให้คลิกซิงค์เลยในแถบการแจ้งเตือนที่ปรากฏขึ้นเมื่อคุณทำการเปลี่ยนแปลง ดังที่แสดงในรูปที่ 2 หรือคลิกซิงค์โปรเจ็กต์ จากแถบเมนู หาก Android Studio พบข้อผิดพลาดเกี่ยวกับการกําหนดค่า เช่น โค้ดต้นทางของคุณใช้ฟีเจอร์ API ที่พร้อมใช้งานใน API ระดับสูงกว่า compileSdkVersion
เท่านั้น หน้าต่างข้อความจะอธิบายปัญหา
ชุดแหล่งที่มา
Android Studio จะจัดกลุ่มซอร์สโค้ดและทรัพยากรของโมดูลแต่ละรายการเป็นชุดซอร์สโค้ดอย่างเป็นระบบ เมื่อคุณสร้างโมดูลใหม่ Android Studio จะสร้างชุดแหล่งที่มา main/
ภายในโมดูล ชุดแหล่งที่มา main/
ของโมดูลจะมีโค้ดและทรัพยากรที่ใช้โดยตัวแปรบิลด์ทั้งหมด
คุณไม่จำเป็นต้องใช้ไดเรกทอรีชุดแหล่งที่มาเพิ่มเติม และ Android Studio จะไม่สร้างไดเรกทอรีเหล่านี้ให้คุณโดยอัตโนมัติเมื่อคุณกำหนดค่าตัวแปรบิลด์ใหม่ อย่างไรก็ตาม การสร้างชุดแหล่งที่มาซึ่งคล้ายกับ main/
จะช่วยจัดระเบียบไฟล์และทรัพยากรที่ Gradle ควรใช้เมื่อสร้างแอปบางเวอร์ชันเท่านั้น ดังนี้
-
src/main/
- ชุดแหล่งที่มานี้ประกอบด้วยโค้ดและทรัพยากรที่ใช้ร่วมกันสำหรับตัวแปรของบิลด์ทั้งหมด
-
src/buildType/
- สร้างชุดแหล่งที่มานี้เพื่อรวมโค้ดและทรัพยากรสําหรับประเภทบิลด์ที่เฉพาะเจาะจงเท่านั้น
-
src/productFlavor/
-
สร้างชุดแหล่งที่มานี้เพื่อรวมโค้ดและทรัพยากรสำหรับผลิตภัณฑ์รุ่นที่เฉพาะเจาะจงเท่านั้น
หมายเหตุ: หากกำหนดค่าบิลด์ให้รวมตัวแปรผลิตภัณฑ์หลายรายการ คุณสามารถสร้างไดเรกทอรีชุดแหล่งที่มาสำหรับชุดค่าผสมตัวแปรผลิตภัณฑ์แต่ละรายการระหว่างมิติข้อมูลตัวแปร ดังนี้
src/productFlavor1ProductFlavor2/
-
src/productFlavorBuildType/
- สร้างชุดแหล่งที่มานี้เพื่อรวมโค้ดและทรัพยากรสำหรับตัวแปรการสร้างที่เฉพาะเจาะจงเท่านั้น
ตัวอย่างเช่น หากต้องการสร้างแอปเวอร์ชัน "fullDebug" ระบบบิลด์จะรวมโค้ด การตั้งค่า และทรัพยากรจากชุดแหล่งที่มาต่อไปนี้
-
src/fullDebug/
(ชุดแหล่งที่มาของตัวแปรบิลด์) -
src/debug/
(ชุดแหล่งที่มาของประเภทบิลด์) -
src/full/
(ชุดแหล่งที่มาของเวอร์ชันผลิตภัณฑ์) -
src/main/
(ชุดแหล่งที่มาหลัก)
หมายเหตุ: เมื่อสร้างไฟล์หรือไดเรกทอรีใหม่ใน Android Studio ให้ใช้ตัวเลือกเมนูไฟล์ > ใหม่เพื่อสร้างไฟล์หรือไดเรกทอรีสำหรับชุดแหล่งที่มาที่เฉพาะเจาะจง ชุดแหล่งที่มาที่คุณเลือกได้จะอิงตามการกำหนดค่าบิลด์ และ Android Studio จะสร้างไดเรกทอรีที่จำเป็นโดยอัตโนมัติหากยังไม่มี
หากชุดแหล่งที่มาต่างๆ มีไฟล์เดียวกันในเวอร์ชันที่แตกต่างกัน Gradle จะจัดลําดับความสําคัญต่อไปนี้เมื่อตัดสินใจว่าจะใช้ไฟล์ใด ชุดแหล่งที่มาทางด้านซ้ายจะลบล้างไฟล์และการตั้งค่าของชุดแหล่งที่มาทางด้านขวา
ตัวแปรของบิลด์ > ประเภทบิลด์ > เวอร์ชันผลิตภัณฑ์ > ชุดแหล่งที่มาหลัก > ทรัพยากร Dependency ของไลบรารี
ซึ่งจะช่วยให้ Gradle ใช้ไฟล์เฉพาะสำหรับตัวแปรการสร้างที่คุณพยายามจะสร้างได้ขณะนํากิจกรรม ตรรกะแอปพลิเคชัน และทรัพยากรที่ใช้ร่วมกันกับแอปเวอร์ชันอื่นๆ มาใช้ซ้ำ
เมื่อรวมไฟล์ Manifest หลายรายการ Gradle เรียงลำดับความสำคัญเดียวกันเพื่อให้ตัวแปรของบิลด์แต่ละรายการกำหนดคอมโพเนนต์หรือสิทธิ์ต่างๆ ในไฟล์ Manifest สุดท้ายได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างชุดแหล่งที่มาที่กําหนดเองได้ที่หัวข้อสร้างชุดแหล่งที่มา
แคตตาล็อกเวอร์ชัน
หากบิลด์ของคุณมีหลายโมดูลที่มีการพึ่งพาร่วมกัน หรือคุณมีโปรเจ็กต์อิสระหลายรายการที่มีการพึ่งพาร่วมกัน เราขอแนะนำให้ใช้แคตตาล็อกเวอร์ชันหรือใบรายการวัสดุ (BOM) เพื่อระบุเวอร์ชันที่ใช้ร่วมกัน
ระบบบิลด์อื่นๆ
คุณสร้างแอป Android ด้วย Bazel ได้ แต่ไม่รองรับอย่างเป็นทางการ Android Studio ไม่รองรับโปรเจ็กต์ Bazel อย่างเป็นทางการ
ดูปัญหาที่ทราบเพื่อทำความเข้าใจข้อจำกัดในปัจจุบันในการสร้างด้วย Bazel ให้ดียิ่งขึ้น