Ringkasan Ekstensi

Laporkan masalah Lihat sumber Nightly · 8.2 · 8.1 · 8.0 · 7.6 · 7.5

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:

Makro dan aturan

Makro adalah fungsi yang membuat instance aturan. Makro terdiri dari dua jenis: makro simbolis (baru di Bazel 8) dan makro lama. Kedua ragam makro ditentukan secara berbeda, tetapi berperilaku hampir sama dari sudut pandang pengguna. Makro berguna saat file BUILD menjadi terlalu berulang atau terlalu kompleks, karena makro memungkinkan Anda menggunakan kembali beberapa kode. Fungsi dievaluasi segera setelah file BUILD dibaca. Setelah evaluasi file BUILD, Bazel memiliki sedikit informasi tentang makro. Jika makro Anda menghasilkan genrule, Bazel akan berperilaku hampir seperti Anda mendeklarasikan genrule tersebut dalam file BUILD. (Satu pengecualian adalah target yang dideklarasikan dalam makro simbolis memiliki semantik visibilitas khusus: makro simbolis dapat menyembunyikan target internalnya dari paket lainnya.)

Aturan lebih canggih 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, mulailah dengan makro; sebaiknya gunakan makro simbolis, kecuali jika Anda perlu mendukung versi Bazel yang lebih lama. Jika makro menjadi kompleks, sebaiknya buat makro tersebut menjadi aturan. Dukungan untuk bahasa baru biasanya dilakukan dengan aturan. Aturan ditujukan untuk pengguna tingkat lanjut, dan sebagian besar pengguna tidak akan pernah perlu 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 file BUILD 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. Tindakan menjelaskan cara membuat serangkaian output dari serangkaian input, seperti "jalankan gcc di hello.c dan dapatkan hello.o". Anda harus mencantumkan secara eksplisit file mana yang akan dihasilkan 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 file BUILD. File dibaca maksimal satu kali per build dan hasil evaluasi di-cache dan digunakan kembali. File hanya dievaluasi setelah semua dependensinya (pernyataan load()) telah di-resolve. Secara desain, memuat file .bzl tidak memiliki efek samping yang terlihat, hanya menentukan 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

Dua link di bawah ini akan sangat berguna saat Anda menulis ekstensi sendiri. Simpan item tersebut dalam jangkauan:

Melangkah lebih jauh

Selain makro dan aturan, Anda mungkin ingin menulis aspek dan aturan repositori.