Halaman ini menjelaskan cara memperluas bahasa BUILD menggunakan makro dan aturan.
Ekstensi Bazel adalah file yang berakhiran .bzl
. Gunakan
pernyataan pemuatan untuk mengimpor simbol dari ekstensi.
Sebelum mempelajari konsep yang lebih lanjut, pertama-tama:
Baca tentang bahasa Starlark, yang digunakan dalam File
BUILD
dan.bzl
.Pelajari cara membagikan variabel antara dua file
BUILD
.
Makro dan aturan
Makro adalah fungsi yang membuat instance aturan. Hal ini berguna saat
file BUILD
menjadi terlalu berulang atau terlalu kompleks, karena memungkinkan Anda menggunakan kembali
beberapa kode. Fungsi dievaluasi segera setelah file BUILD
dibaca. Sesudah
saat mengevaluasi file BUILD
, Bazel hanya memiliki sedikit informasi tentang makro:
jika makro menghasilkan genrule
, Bazel akan berperilaku seolah-olah Anda menulis
genrule
. Akibatnya, bazel query
hanya akan mencantumkan genrule
yang dihasilkan.
Aturan lebih efektif daripada makro. Alat ini dapat mengakses internal Bazel dan memiliki kontrol penuh atas apa yang terjadi. Misalnya, aturan ini dapat meneruskan informasi ke aturan lain.
Jika Anda ingin menggunakan kembali logika sederhana, mulai dengan makro. Jika sebuah makro menjadi rumit, sering kali merupakan ide yang baik untuk menjadikannya sebagai aturan. Dukungan untuk bahasa baru biasanya dilakukan dengan sebuah aturan. Aturan ditujukan untuk pengguna tingkat lanjut, dan sebagian besar pengguna tidak akan pernah harus menulisnya; mereka hanya akan memuat dan memanggil aturan yang ada.
Model evaluasi
Build terdiri dari tiga fase.
Fase pemuatan. Pertama, muat dan evaluasi semua ekstensi dan semua file
BUILD
yang diperlukan untuk build. Eksekusi fileBUILD
hanya membuat instance aturan (setiap kali aturan dipanggil, aturan tersebut akan ditambahkan ke grafik). Di sinilah makro dievaluasi.Fase analisis. Kode aturan dijalankan (fungsi
implementation
-nya), dan tindakan dibuat instance-nya. Sebuah tindakan menjelaskan cara menghasilkan satu set {i>output<i} dari satu set input, seperti "jalankan gcc pada hello.c dan dapatkan hello.o". Anda harus mencantumkan secara eksplisit file mana yang akan dibuat sebelum menjalankan perintah yang sebenarnya. Dengan kata lain, fase analisis mengambil grafik yang dihasilkan oleh fase pemuatan dan menghasilkan grafik tindakan.Fase eksekusi. Tindakan dieksekusi, jika setidaknya salah satu outputnya diperlukan. Jika file tidak ada atau jika perintah gagal menghasilkan satu output, build akan gagal. Pengujian juga dijalankan selama fase ini.
Bazel menggunakan paralelisme untuk membaca, mengurai, dan mengevaluasi file .bzl
dan BUILD
. Sebuah file dibaca paling banyak sekali per build dan hasil evaluasinya adalah
di-cache dan digunakan kembali. File hanya dievaluasi setelah semua dependensinya (load()
berbeda) telah diselesaikan. Sesuai desain, pemuatan file .bzl
tidak memiliki
efek samping, hanya mendefinisikan nilai dan fungsi.
Bazel mencoba menjadi cerdas: Bazel menggunakan analisis dependensi untuk mengetahui file mana yang harus dimuat, aturan mana yang harus dianalisis, dan tindakan mana yang harus dijalankan. Misalnya, jika aturan menghasilkan tindakan yang tidak Anda perlukan untuk build saat ini, tindakan tersebut tidak akan dieksekusi.
Membuat ekstensi
Buat makro pertama Anda untuk menggunakan kembali beberapa kode. Lalu pelajari lebih lanjut tentang makro dan menggunakannya untuk membuat "kata kerja kustom".
Ikuti tutorial aturan untuk mulai menggunakan aturan. Selanjutnya, Anda dapat membaca selengkapnya tentang konsep aturan.
Dua link di bawah ini akan sangat berguna saat menulis ekstensi Anda sendiri. Pastikan item tersebut mudah dijangkau:
Lebih jauh
Selain makro dan aturan, Anda mungkin ingin menulis aspek dan aturan repositori.
Gunakan Buildifier secara konsisten untuk memformat dan melakukan lint pada kode Anda.
Ikuti panduan gaya
.bzl
.Uji kode Anda.
Buat dokumentasi untuk membantu pengguna Anda.
Optimalkan performa kode Anda.
Deploy ekstensi Anda kepada orang lain.