บทแนะนำ Bazel: สร้างแอป Android

หมายเหตุ: การใช้ Bazel เพื่อสร้างแอป Android มีข้อจำกัดที่ทราบ โปรดไปที่ team-Android hotlist ของ GitHub เพื่อดูรายการปัญหาที่ทราบ แม้ว่าทีม Bazel และผู้มีส่วนร่วมในซอฟต์แวร์โอเพนซอร์ส (OSS) จะพยายามแก้ไขปัญหาที่ทราบแล้ว แต่ผู้ใช้ควรทราบว่า Android Studio ไม่รองรับโปรเจ็กต์ Bazel อย่างเป็นทางการ

บทแนะนำนี้ครอบคลุมวิธีสร้างแอป Android แบบง่ายโดยใช้ Bazel

Bazel รองรับการสร้างแอป Android โดยใช้กฎ Android

บทแนะนำนี้มีไว้สำหรับผู้ใช้ Windows, macOS และ Linux และไม่จําเป็นต้องมีประสบการณ์ด้าน Bazel หรือการพัฒนาแอป Android คุณไม่จำเป็นต้องเขียนโค้ด Android ในบทแนะนำนี้

สิ่งที่คุณจะได้เรียนรู้

ในบทแนะนำนี้ คุณจะได้เรียนรู้วิธีต่อไปนี้

• ตั้งค่าสภาพแวดล้อมโดยการติดตั้ง Bazel และ Android Studio รวมถึงดาวน์โหลดโปรเจ็กต์ตัวอย่าง
• สร้างพื้นที่ทํางาน Bazel ที่มีซอร์สโค้ดสําหรับแอปและไฟล์ MODULE.bazel ที่ระบุระดับบนสุดของไดเรกทอรีพื้นที่ทํางาน
• อัปเดตไฟล์ MODULE.bazel ให้อ้างอิงถึงทรัพยากร Dependency ภายนอกที่จําเป็น เช่น Android SDK
• สร้างไฟล์ BUILD
• สร้างแอปด้วย Bazel
• ติดตั้งใช้งานและเรียกใช้แอปในโปรแกรมจำลอง Android หรืออุปกรณ์จริง

ก่อนเริ่มต้น

ติดตั้ง Bazel

ก่อนเริ่มบทแนะนำ ให้ติดตั้งซอฟต์แวร์ต่อไปนี้

• Bazel ทำตามวิธีการติดตั้งเพื่อติดตั้ง
• Android Studio หากต้องการติดตั้ง ให้ทำตามขั้นตอนการดาวน์โหลด Android Studio เรียกใช้วิซาร์ดการตั้งค่าเพื่อดาวน์โหลด SDK และกำหนดค่าสภาพแวดล้อม
• (ไม่บังคับ) Git ใช้ git เพื่อดาวน์โหลดโปรเจ็กต์แอป Android

รับโปรเจ็กต์ตัวอย่าง

สำหรับโปรเจ็กต์ตัวอย่าง ให้ใช้โปรเจ็กต์แอป Android พื้นฐานในที่เก็บตัวอย่างของ Bazel

แอปนี้มีปุ่มเดียวที่แสดงคําทักทายเมื่อมีการคลิก

รูปที่ 1 คําทักทายของปุ่มแอป Android

โคลนที่เก็บด้วย git (หรือดาวน์โหลดไฟล์ ZIP โดยตรง)

git clone https://github.com/bazelbuild/examples

โปรเจ็กต์ตัวอย่างสำหรับบทแนะนำนี้อยู่ใน examples/android/tutorial คุณจะเรียกใช้คําสั่งในไดเรกทอรีนี้ตลอดบทแนะนําที่เหลือ

ตรวจสอบไฟล์ต้นฉบับ

ดูไฟล์ต้นฉบับของแอป

.
├── README.md
└── src
    └── main
        ├── AndroidManifest.xml
        └── java
            └── com
                └── example
                    └── bazel
                        ├── AndroidManifest.xml
                        ├── Greeter.java
                        ├── MainActivity.java
                        └── res
                            ├── layout
                            │   └── activity_main.xml
                            └── values
                                ├── colors.xml
                                └── strings.xml

ไฟล์และไดเรกทอรีที่สำคัญมีดังนี้

บิลด์ด้วย Bazel

ตั้งค่าพื้นที่ทํางาน

พื้นที่ทํางานคือไดเรกทอรีที่มีไฟล์ซอร์สโค้ดสําหรับโปรเจ็กต์ซอฟต์แวร์อย่างน้อย 1 โปรเจ็กต์ และมีไฟล์ MODULE.bazel ที่รูท

ไฟล์ MODULE.bazel อาจว่างเปล่าหรือมีการอ้างอิงถึงทรัพยากรภายนอกที่จําเป็นสําหรับการสร้างโปรเจ็กต์

ก่อนอื่น ให้เรียกใช้คําสั่งต่อไปนี้เพื่อสร้างไฟล์ MODULE.bazel ว่าง

ใช้งาน Bazel

ตอนนี้คุณตรวจสอบได้ว่า Bazel ทํางานอย่างถูกต้องหรือไม่ด้วยคําสั่งต่อไปนี้

bazel info workspace

หาก Bazel พิมพ์เส้นทางของไดเรกทอรีปัจจุบัน แสดงว่าคุณพร้อมใช้งานแล้ว หากไม่มีไฟล์ MODULE.bazel คุณอาจเห็นข้อความแสดงข้อผิดพลาด เช่น

ERROR: The 'info' command is only supported from within a workspace.

ผสานรวมกับ Android SDK

Bazel จำเป็นต้องเรียกใช้ Android SDK เครื่องมือสร้าง เพื่อสร้างแอป ซึ่งหมายความว่าคุณต้องเพิ่มข้อมูลบางอย่างลงในไฟล์ MODULE.bazel เพื่อให้ Bazel รู้ว่าจะหาข้อมูลเหล่านั้นได้จากที่ใด

เพิ่มบรรทัดต่อไปนี้ลงในไฟล์ MODULE.bazel

bazel_dep(name = "rules_android", version = "0.5.1")

ซึ่งจะใช้ Android SDK ในเส้นทางที่อ้างอิงโดยANDROID_HOMEตัวแปรสภาพแวดล้อม และตรวจหา API ระดับสูงสุดและเครื่องมือสร้างเวอร์ชันล่าสุดที่ติดตั้งภายในตำแหน่งนั้นโดยอัตโนมัติ

คุณสามารถตั้งค่าตัวแปร ANDROID_HOME เป็นตำแหน่งของ Android SDK ค้นหาเส้นทางไปยัง SDK ที่ติดตั้งโดยใช้ SDK Manager ของ Android Studio สมมติว่าติดตั้ง SDK ไว้ในตำแหน่งเริ่มต้น คุณสามารถใช้คำสั่งต่อไปนี้เพื่อตั้งค่าตัวแปร ANDROID_HOME

คำสั่งข้างต้นจะตั้งค่าตัวแปรสำหรับเซสชันเชลล์ปัจจุบันเท่านั้น หากต้องการทำให้ค่าดังกล่าวถาวร ให้เรียกใช้คำสั่งต่อไปนี้

ไม่บังคับ: หากต้องการคอมไพล์โค้ดเนทีฟลงในแอป Android คุณจะต้องดาวน์โหลด Android NDK และใช้ rules_android_ndk โดยเพิ่มบรรทัดต่อไปนี้ลงในไฟล์ MODULE.bazel

bazel_dep(name = "rules_android_ndk", version = "0.1.2")

ดูข้อมูลเพิ่มเติมได้ที่การใช้ Android Native Development Kit กับ Bazel

คุณไม่จำเป็นต้องตั้งค่าระดับ API เป็นค่าเดียวกันสำหรับ SDK และ NDK หน้านี้มีแผนที่จากรุ่น Android ไปยังระดับ API ที่ NDK รองรับ

สร้างไฟล์ BUILD

ไฟล์ BUILD จะอธิบายความสัมพันธ์ระหว่างชุดเอาต์พุตของบิลด์ เช่น ทรัพยากร Android ที่คอมไพล์แล้วจาก aapt หรือไฟล์คลาสจาก javac กับทรัพยากรที่ต้องพึ่งพา ไลบรารีเหล่านี้อาจเป็นไฟล์ซอร์สโค้ด (Java, C++) ในเวิร์กスペースหรือเอาต์พุตการสร้างอื่นๆ ไฟล์ BUILD เขียนด้วยภาษาที่เรียกว่า Starlark

ไฟล์ BUILD เป็นส่วนหนึ่งของแนวคิดใน Bazel ที่เรียกว่าลําดับชั้นของแพ็กเกจ ลําดับชั้นของแพ็กเกจเป็นโครงสร้างเชิงตรรกะที่วางซ้อนกับโครงสร้างไดเรกทอรีในพื้นที่ทํางาน แพ็กเกจแต่ละรายการคือไดเรกทอรี (และไดเรกทอรีย่อย) ที่มีชุดไฟล์ต้นทางที่เกี่ยวข้องและไฟล์ BUILD แพ็กเกจนี้ยังมีไดเรกทอรีย่อยด้วย ยกเว้นไดเรกทอรีย่อยที่มีไฟล์ BUILD ของตัวเอง ชื่อแพ็กเกจคือเส้นทางไปยังไฟล์ BUILD ที่สัมพันธ์กับไฟล์ MODULE.bazel

โปรดทราบว่าลําดับชั้นของแพ็กเกจ Bazel แตกต่างกับลําดับชั้นของแพ็กเกจ Java ในไดเรกทอรีแอป Android ที่มีไฟล์ BUILD อยู่ แม้ว่าไดเรกทอรีจะจัดระเบียบเหมือนกันก็ตาม

สําหรับแอป Android แบบง่ายในบทแนะนํานี้ ไฟล์ต้นฉบับใน src/main/ จะประกอบกันเป็นแพ็กเกจ Bazel รายการเดียว โปรเจ็กต์ที่ซับซ้อนมากขึ้นอาจมีแพ็กเกจที่ฝังอยู่หลายรายการ

เพิ่มกฎ android_library

ไฟล์ BUILD มีการประกาศหลายประเภทสำหรับ Bazel ประเภทที่สำคัญที่สุดคือกฎการสร้าง ซึ่งบอก Bazel ว่าจะสร้างเอาต์พุตซอฟต์แวร์ระดับกลางหรือขั้นสุดท้ายจากชุดไฟล์ต้นทางหรือไลบรารีอื่นๆ อย่างไร Bazel มีกฎการสร้าง 2 รายการ ได้แก่ android_library และ android_binary ซึ่งคุณใช้สร้างแอป Android ได้

ในบทแนะนํานี้ คุณจะใช้กฎ android_library ก่อนเพื่อบอกให้ Bazel สร้างโมดูลไลบรารี Android จากซอร์สโค้ดของแอปและไฟล์ทรัพยากร จากนั้นคุณจะใช้กฎ android_binary เพื่อบอก Bazel วิธีสร้างแพ็กเกจแอปพลิเคชัน Android

สร้างไฟล์ BUILD ใหม่ในไดเรกทอรี src/main/java/com/example/bazel และประกาศเป้าหมาย android_library ใหม่ ดังนี้

src/main/java/com/example/bazel/BUILD:

package(
    default_visibility = ["//src:__subpackages__"],
)

android_library(
    name = "greeter_activity",
    srcs = [
        "Greeter.java",
        "MainActivity.java",
    ],
    manifest = "AndroidManifest.xml",
    resource_files = glob(["res/**"]),
)

กฎการสร้าง android_library มีชุดแอตทริบิวต์ที่ระบุข้อมูลที่ Bazel ต้องใช้ในการสร้างโมดูลไลบรารีจากไฟล์ต้นฉบับ โปรดทราบว่าชื่อของกฎคือ greeter_activity คุณจะอ้างอิงกฎโดยใช้ชื่อนี้เป็นทรัพยากรในกฎ android_binary

เพิ่มกฎ android_binary

กฎ android_binary จะสร้างแพ็กเกจแอปพลิเคชัน Android (ไฟล์ .apk) สําหรับแอปของคุณ

สร้างไฟล์ BUILD ใหม่ในไดเรกทอรี src/main/ และประกาศเป้าหมาย android_binary ใหม่ ดังนี้

src/main/BUILD:

android_binary(
    name = "app",
    manifest = "AndroidManifest.xml",
    deps = ["//src/main/java/com/example/bazel:greeter_activity"],
)

ในที่นี้ แอตทริบิวต์ deps จะอ้างอิงเอาต์พุตของกฎ greeter_activity ที่เพิ่มลงในไฟล์ BUILD ด้านบน ซึ่งหมายความว่าเมื่อ Bazel บิลด์เอาต์พุตของกฎนี้ ระบบจะตรวจสอบก่อนว่ามีการบิลด์เอาต์พุตของกฎไลบรารี greeter_activity ไว้แล้วและเป็นเวอร์ชันล่าสุดหรือไม่ หากไม่มี Bazel จะสร้างไฟล์นั้นขึ้นมา แล้วใช้เอาต์พุตดังกล่าวเพื่อสร้างไฟล์แพ็กเกจแอปพลิเคชัน

จากนั้นบันทึกและปิดไฟล์

สร้างแอป

ลองสร้างแอปเลย เรียกใช้คําสั่งต่อไปนี้เพื่อสร้างเป้าหมาย android_binary

bazel build //src/main:app

คำสั่งย่อย build จะสั่งให้ Bazel บิลด์เป้าหมายที่ตามมา เป้าหมายจะระบุเป็นชื่อกฎการสร้างภายในไฟล์ BUILD พร้อมกับเส้นทางแพ็กเกจที่สัมพันธ์กับไดเรกทอรีเวิร์กスペース ในตัวอย่างนี้ เป้าหมายคือ app และเส้นทางแพ็กเกจคือ //src/main/

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

Bazel จะเริ่มสร้างแอปตัวอย่าง ในระหว่างกระบวนการสร้าง เอาต์พุตจะปรากฏคล้ายกับตัวอย่างต่อไปนี้

INFO: Analysed target //src/main:app (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //src/main:app up-to-date:
  bazel-bin/src/main/app_deploy.jar
  bazel-bin/src/main/app_unsigned.apk
  bazel-bin/src/main/app.apk

ค้นหาเอาต์พุตของบิลด์

Bazel จะใส่เอาต์พุตของทั้งการดำเนินการบิลด์ขั้นกลางและขั้นสุดท้ายไว้ในชุดไดเรกทอรีเอาต์พุตต่อผู้ใช้ต่อเวิร์กสเปซ ไดเรกทอรีเหล่านี้เป็นลิงก์สัญลักษณ์จากตำแหน่งต่อไปนี้ที่ระดับบนสุดของไดเรกทอรีโปรเจ็กต์ซึ่งมีไฟล์ MODULE.bazel

• bazel-bin จัดเก็บไฟล์ปฏิบัติการแบบไบนารีและเอาต์พุตการสร้างอื่นๆ ที่เรียกใช้ได้
• bazel-genfiles จัดเก็บไฟล์ต้นฉบับสื่อกลางที่สร้างขึ้นโดยกฎ Bazel
• bazel-out จัดเก็บเอาต์พุตบิลด์ประเภทอื่นๆ

Bazel จะจัดเก็บไฟล์ .apk ของ Android ที่สร้างขึ้นโดยใช้กฎ android_binary ในไดเรกทอรี bazel-bin/src/main โดยที่ชื่อไดเรกทอรีย่อย src/main มาจากชื่อแพ็กเกจ Bazel

ที่พรอมต์คำสั่ง ให้แสดงรายการเนื้อหาของไดเรกทอรีนี้และค้นหาไฟล์ app.apk

เรียกใช้แอป

ตอนนี้คุณทำให้แอปใช้งานได้ในอุปกรณ์ Android หรือโปรแกรมจำลองที่เชื่อมต่ออยู่จากบรรทัดคำสั่งโดยใช้คำสั่ง bazel mobile-install คำสั่งนี้ใช้ Android Debug Bridge (adb) เพื่อสื่อสารกับอุปกรณ์ คุณต้องตั้งค่าอุปกรณ์ให้ใช้ adb โดยทําตามวิธีการใน Android Debug Bridge ก่อนการนําไปใช้งาน นอกจากนี้ คุณยังเลือกติดตั้งแอปในโปรแกรมจำลอง Android ที่รวมอยู่ใน Android Studio ได้ด้วย ตรวจสอบว่าโปรแกรมจําลองทํางานอยู่ก่อนเรียกใช้คําสั่งด้านล่าง

ป้อนข้อมูลต่อไปนี้

bazel mobile-install //src/main:app

ต่อไป ให้ค้นหาและเปิด "แอปบทแนะนำ Bazel"

รูปที่ 2 แอปบทแนะนำ Bazel

ยินดีด้วย คุณเพิ่งติดตั้งแอป Android ที่สร้างขึ้นด้วย Bazel แอปแรก

โปรดทราบว่าคำสั่งย่อย mobile-install ยังรองรับ Flag --incremental ที่ใช้เพื่อทำให้ใช้งานได้เฉพาะส่วนของแอปที่มีการเปลี่ยนแปลงนับตั้งแต่การทำให้ใช้งานได้ครั้งล่าสุด

นอกจากนี้ยังรองรับ Flag --start_app เพื่อเริ่มแอปทันทีที่ติดตั้ง

อ่านเพิ่มเติม

ดูรายละเอียดเพิ่มเติมได้ที่หน้าต่อไปนี้

• เปิดปัญหาใน GitHub
• ข้อมูลเพิ่มเติมเกี่ยวกับ mobile-install
• ผสานรวมการพึ่งพาภายนอก เช่น AppCompat, Guava และ JUnit จากที่เก็บ Maven โดยใช้ rules_jvm_external
• เรียกใช้การทดสอบ Robolectric ด้วยการผสานรวม robolectric-bazel
• การทดสอบแอปด้วยการทดสอบเครื่องมือวัดประสิทธิภาพของ Android
• การผสานรวมโค้ด C และ C++ เข้ากับแอป Android ด้วย NDK
• ดูโปรเจ็กต์ตัวอย่าง Bazel เพิ่มเติมของสิ่งต่อไปนี้
  • แอป Kotlin
  • การทดสอบ Robolectric
  • การทดสอบ Espresso

ขอให้สนุกกับการสร้าง