Halaman ini menjelaskan cara membangun atau menguji project Xcode dengan Bazel. Panduan ini menjelaskan perbedaan antara Xcode dan Bazel, serta memberikan langkah-langkah untuk mengonversi project Xcode menjadi project Bazel. Artikel ini juga memberikan solusi pemecahan masalah untuk mengatasi error umum.
Perbedaan antara Xcode dan Bazel
Bazel mengharuskan Anda menentukan setiap target build dan dependensinya secara eksplisit, ditambah setelan build yang sesuai melalui aturan build.
Bazel mengharuskan semua file yang menjadi tempat project bergantung ada dalam direktori ruang kerja atau ditentukan sebagai impor dalam file
WORKSPACE
.Saat mem-build project Xcode dengan Bazel, file
BUILD
menjadi sumber tepercaya. Jika mengerjakan project di Xcode, Anda harus membuat versi baru project Xcode yang cocok dengan fileBUILD
menggunakan rules_xcodeproj setiap kali Anda memperbarui fileBUILD
. Perubahan tertentu pada fileBUILD
seperti menambahkan dependensi ke target tidak memerlukan pembuatan ulang project yang dapat mempercepat pengembangan. Jika Anda tidak menggunakan Xcode, perintahbazel build
danbazel test
akan memberikan kemampuan build dan pengujian dengan batasan tertentu yang akan dijelaskan nanti dalam panduan ini.
Sebelum memulai
Sebelum memulai, lakukan hal berikut:
Instal Bazel jika Anda belum melakukannya.
Jika Anda tidak terbiasa dengan Bazel dan konsepnya, selesaikan tutorial aplikasi iOS). Anda harus memahami ruang kerja Bazel, termasuk file
WORKSPACE
danBUILD
, serta konsep target, aturan build, dan paket Bazel.Menganalisis dan memahami dependensi proyek.
Menganalisis dependensi project
Tidak seperti Xcode, Bazel mengharuskan Anda secara eksplisit mendeklarasikan semua dependensi untuk setiap target dalam file BUILD
.
Untuk informasi selengkapnya tentang dependensi eksternal, lihat Menggunakan dependensi eksternal.
Membangun atau menguji project Xcode dengan Bazel
Untuk membangun atau menguji project Xcode dengan Bazel, lakukan hal berikut:
Langkah 1: Buat file WORKSPACE
Buat file WORKSPACE
di direktori baru. Direktori ini menjadi root workspace
Bazel. Jika project tidak menggunakan dependensi eksternal, file ini bisa
kosong. Jika project bergantung pada file atau paket yang tidak ada di salah satu
direktori project, tentukan dependensi eksternal ini dalam file
WORKSPACE
.
Langkah 2: (Eksperimental) Mengintegrasikan dependensi SwiftPM
Untuk mengintegrasikan dependensi SwiftPM ke dalam ruang kerja Bazel dengan swift_bazel, Anda harus mengonversinya menjadi paket Bazel seperti yang dijelaskan dalam tutorial berikut.
Langkah 3: Buat file BUILD
Setelah menentukan ruang kerja dan dependensi eksternal, Anda harus
membuat file BUILD
yang memberi tahu Bazel cara menyusun project. Buat file BUILD
di root ruang kerja Bazel dan konfigurasikan untuk melakukan build awal project sebagai berikut:
- Langkah 3a: Tambahkan target aplikasi
- Langkah 3b: (Opsional) Tambahkan target pengujian
- Langkah 3c: Tambahkan target library
Tips: Untuk mempelajari paket dan konsep Bazel lainnya lebih lanjut, lihat Ruang kerja, paket, dan target.
Langkah 3a: Tambahkan target aplikasi
Tambahkan target aturan macos_application
atau ios_application
. Target ini masing-masing mem-build paket aplikasi macOS atau iOS.
Di target, tentukan minimal hal berikut:
bundle_id
- ID paket (jalur Reverse-DNS yang diikuti dengan nama aplikasi) biner.provisioning_profile
- profil penyediaan dari akun Apple Developer Anda (jika mem-build untuk perangkat iOS).families
(khusus iOS) - apakah akan mem-build aplikasi untuk iPhone, iPad, atau keduanya.infoplists
- daftar file .plist yang akan digabungkan ke dalam file Info.plist akhir.minimum_os_version
- versi minimum macOS atau iOS yang didukung aplikasi. Tindakan ini memastikan Bazel mem-build aplikasi dengan API level yang benar.
Langkah 3b: (Opsional) Tambahkan target pengujian
Aturan build Apple Bazel mendukung pengujian unit dan UI yang berjalan di semua platform Apple. Tambahkan target pengujian sebagai berikut:
macos_unit_test
untuk menjalankan pengujian unit berbasis library dan berbasis aplikasi di macOS.ios_unit_test
untuk membuat dan menjalankan pengujian unit berbasis library di iOS.ios_ui_test
untuk mem-build dan menjalankan pengujian antarmuka pengguna di simulator iOS.Aturan pengujian serupa ada untuk tvOS, watchOS, dan visionOS.
Minimal, tentukan nilai untuk atribut minimum_os_version
. Meskipun
atribut paket lainnya, seperti bundle_identifier
dan infoplists
,
memiliki nilai default yang paling sering digunakan, pastikan bahwa default tersebut kompatibel
dengan project dan sesuaikan jika diperlukan. Untuk pengujian yang memerlukan simulator
iOS, tentukan juga nama target ios_application
sebagai nilai
atribut test_host
.
Langkah 3c: Menambahkan target library
Tambahkan target objc_library
untuk setiap library Objective-C dan target swift_library
untuk setiap library Swift yang menjadi dependensi aplikasi dan/atau pengujian.
Tambahkan target library sebagai berikut:
Tambahkan target library aplikasi sebagai dependensi ke target aplikasi.
Tambahkan target library pengujian sebagai dependensi ke target pengujian.
Cantumkan sumber penerapan dalam atribut
srcs
.Cantumkan header dalam atribut
hdrs
.
Anda dapat mencari contoh yang ada untuk berbagai jenis aplikasi secara langsung pada direktori contoh aturan_apple. Contoh:
Untuk mengetahui informasi selengkapnya tentang aturan build, lihat Apple Rules untuk Bazel.
Pada tahap ini, sebaiknya uji build:
bazel build //:<application_target>
Langkah 4: (Opsional) Buat build menjadi terperinci
Jika project berukuran besar, atau seiring berkembangnya project, pertimbangkan untuk membaginya menjadi beberapa paket Bazel. Peningkatan perincian ini memberikan:
Peningkatan inkrementalitas build,
Peningkatan paralelisasi tugas build,
Pengelolaan yang lebih baik untuk pengguna di masa depan,
Kontrol yang lebih baik atas visibilitas kode sumber di seluruh target dan paket. Tindakan ini akan mencegah masalah seperti library yang berisi detail implementasi yang bocor ke API publik.
Tips untuk membuat project menjadi terperinci:
Masukkan setiap library ke dalam paket Bazel-nya sendiri. Mulailah dengan yang memerlukan dependensi paling sedikit dan lanjutkan ke hierarki dependensi.
Saat Anda menambahkan file
BUILD
dan menentukan target, tambahkan target baru ini ke atributdeps
target yang bergantung padanya.Fungsi
glob()
tidak melewati batas paket sehingga jumlah paket bertambah, file yang cocok denganglob()
akan menyusut.Saat menambahkan file
BUILD
ke direktorimain
, tambahkan juga fileBUILD
ke direktoritest
yang sesuai.Terapkan batas visibilitas yang baik di seluruh paket.
Build project setelah setiap perubahan besar pada file
BUILD
dan perbaiki error build saat Anda menemukannya.
Langkah 5: Jalankan build
Jalankan build yang dimigrasikan sepenuhnya untuk memastikan build selesai tanpa error atau peringatan. Jalankan setiap aplikasi dan target pengujian satu per satu untuk lebih mudah menemukan sumber error yang terjadi.
Contoh:
bazel build //:my-target
Langkah 6: Buat project Xcode dengan rules_xcodeproj
Saat mem-build dengan Bazel, file WORKSPACE
dan BUILD
menjadi sumber
kebenaran tentang build. Agar Xcode mengetahui hal ini, Anda harus membuat
project Xcode yang kompatibel dengan Bazel menggunakan rules_xcodeproj.
Pemecahan masalah
Error Bazel dapat muncul saat tidak sinkron dengan versi Xcode yang dipilih, seperti saat Anda menerapkan update. Berikut beberapa hal yang dapat dicoba jika Anda mengalami error dengan Xcode, misalnya "Versi Xcode harus ditentukan untuk menggunakan CROSSTOOL Apple".
Jalankan Xcode secara manual dan setujui semua persyaratan dan ketentuan.
Gunakan Xcode select untuk menunjukkan versi yang benar, menyetujui lisensi, dan menghapus status Bazel.
sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
sudo xcodebuild -license
bazel sync --configure
- Jika tidak berhasil, Anda juga dapat mencoba menjalankan
bazel clean --expunge
.