Ringkasan Ekstensi

Nightly · 9.1 · 9.0 · 8.7 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

Halaman ini menjelaskan cara memperluas bahasa BUILD menggunakan makro dan aturan.

Ekstensi Bazel adalah file yang berakhiran .bzl. Gunakan a pernyataan load untuk mengimpor simbol dari ekstensi.

Sebelum mempelajari konsep yang lebih canggih, pertama:

  • Baca tentang bahasa Starlark, yang digunakan dalam file BUILD dan .bzl.

  • Pelajari cara berbagi variabel antara dua file BUILD.

Makro dan aturan

A makro adalah fungsi yang membuat instance aturan. Makro berguna jika file BUILD menjadi terlalu berulang atau terlalu kompleks, karena 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 seolah-olah Anda menulis genrule. Akibatnya, bazel query hanya akan mencantumkan genrule yang dihasilkan.

Aturan lebih canggih daripada makro. Aturan dapat mengakses internal Bazel dan memiliki kontrol penuh atas apa yang terjadi. Misalnya, aturan dapat meneruskan informasi ke aturan lain.

Jika ingin menggunakan kembali logika sederhana, mulailah dengan makro. Jika makro menjadi kompleks, sebaiknya jadikan makro sebagai aturan. Dukungan untuk bahasa baru biasanya dilakukan dengan aturan. Aturan ditujukan untuk pengguna tingkat lanjut, dan sebagian besar pengguna tidak perlu menulis aturan; 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 akan ditambahkan ke grafik). Di sinilah makro dievaluasi.

  • Fase analisis. Kode aturan dieksekusi (fungsi implementation-nya), dan tindakan dibuat instance-nya. Tindakan menjelaskan cara membuat sekumpulan output dari sekumpulan input, seperti "jalankan gcc di hello.c dan dapatkan hello.o". Anda harus mencantumkan secara eksplisit file mana yang akan dibuat sebelum menjalankan perintah 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 paling banyak satu kali per build dan hasil evaluasi di-cache dan digunakan kembali. File hanya dievaluasi setelah semua dependensinya (pernyataan load()) diselesaikan. Menurut desainnya, memuat file .bzl tidak memiliki efek samping yang terlihat, hanya menentukan nilai dan fungsi.

Bazel mencoba untuk cerdas: Bazel menggunakan analisis dependensi untuk mengetahui file mana yang harus dimuat, aturan mana yang harus dianalisis, dan tindakan mana yang harus dieksekusi. Misalnya, jika aturan menghasilkan tindakan yang tidak Anda perlukan untuk build saat ini, tindakan tersebut tidak akan dieksekusi.

Membuat ekstensi

Dua link di bawah akan sangat berguna saat menulis ekstensi Anda sendiri. Simpan link tersebut agar mudah dijangkau:

Mempelajari lebih lanjut

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