Pengantar
Baru mengenal Bazel? Anda sudah berada di tempat yang tepat. Ikuti tutorial Build Pertama ini untuk mendapatkan pengantar yang disederhanakan tentang penggunaan Bazel. Tutorial ini mendefinisikan istilah penting saat digunakan dalam konteks Bazel dan memandu Anda memahami dasar-dasar alur kerja Bazel. Dimulai dengan alat yang Anda perlukan, Anda akan membangun dan menjalankan tiga project dengan kompleksitas yang semakin meningkat serta mempelajari cara dan alasan project tersebut menjadi lebih kompleks.
Meskipun Bazel adalah sistem build yang mendukung build multibahasa, tutorial ini menggunakan project C++ sebagai contoh dan memberikan panduan dan alur umum yang berlaku untuk sebagian besar bahasa.
Perkiraan waktu penyelesaian: 30 menit.
Prasyarat
Mulailah dengan menginstal Bazel jika Anda belum melakukannya. Tutorial ini menggunakan Git untuk kontrol sumber, jadi untuk hasil terbaik, instal Git juga.
Selanjutnya, ambil project contoh dari repositori GitHub Bazel dengan menjalankan perintah berikut dalam alat command line pilihan Anda:
git clone https://github.com/bazelbuild/examples
Project contoh untuk tutorial ini ada di direktori examples/cpp-tutorial
.
Lihat strukturnya di bawah ini:
examples
└── cpp-tutorial
├──stage1
│ ├── main
│ │ ├── BUILD
│ │ └── hello-world.cc
│ └── WORKSPACE
├──stage2
│ ├── main
│ │ ├── BUILD
│ │ ├── hello-world.cc
│ │ ├── hello-greet.cc
│ │ └── hello-greet.h
│ └── WORKSPACE
└──stage3
├── main
│ ├── BUILD
│ ├── hello-world.cc
│ ├── hello-greet.cc
│ └── hello-greet.h
├── lib
│ ├── BUILD
│ ├── hello-time.cc
│ └── hello-time.h
└── WORKSPACE
Ada tiga kumpulan file, setiap kumpulan mewakili tahap dalam tutorial ini. Pada tahap pertama, Anda akan mem-build satu target yang berada dalam satu paket. Pada tahap kedua, Anda akan mem-build biner dan library dari satu paket. Pada tahap ketiga dan terakhir, Anda akan mem-build project dengan beberapa paket dan mem-buildnya dengan beberapa target.
Ringkasan: Pengantar
Dengan menginstal Bazel (dan Git) serta meng-clone repositori untuk tutorial ini, Anda telah menyiapkan fondasi untuk build pertama Anda dengan Bazel. Lanjutkan ke bagian berikutnya untuk mendefinisikan beberapa istilah dan menyiapkan ruang kerja Anda.
Memulai
Menyiapkan ruang kerja
Sebelum dapat mem-build project, Anda harus menyiapkan ruang kerjanya. Ruang kerja adalah direktori yang menyimpan file sumber project dan output build Bazel. File ini juga berisi file penting berikut:
, yang mengidentifikasi direktori dan kontennya sebagai ruang kerja Bazel dan berada di root struktur direktori project.WORKSPACE
file- Satu atau beberapa
, yang memberi tahu Bazel cara mem-build berbagai bagian project. Direktori dalam ruang kerja yang berisi fileBUILD
filesBUILD
adalah paket. (Selengkapnya tentang paket nanti dalam tutorial ini.)
Dalam project mendatang, untuk menetapkan direktori sebagai ruang kerja Bazel, buat
file kosong bernama WORKSPACE
di direktori tersebut. Untuk tujuan tutorial ini,
file WORKSPACE
sudah ada di setiap tahap.
CATATAN: Saat Bazel membuat project, semua input harus berada di ruang kerja yang sama. File yang berada di ruang kerja yang berbeda bersifat independen satu sama lain kecuali jika ditautkan. Informasi lebih mendetail tentang aturan ruang kerja dapat ditemukan di panduan ini.
Memahami file BUILD
File BUILD
berisi beberapa jenis petunjuk yang berbeda untuk Bazel. Setiap
file BUILD
memerlukan minimal satu aturan
sebagai kumpulan petunjuk, yang memberi tahu Bazel cara mem-build output yang diinginkan,
seperti biner atau library yang dapat dieksekusi. Setiap instance aturan build dalam
file BUILD
disebut target
dan mengarah ke kumpulan file sumber dan dependensi tertentu.
Target juga dapat mengarah ke target lain.
Lihat file BUILD
di direktori cpp-tutorial/stage1/main
:
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
)
Dalam contoh kita, target hello-world
membuat instance cc_binary rule
bawaan
Bazel.
Aturan ini memberi tahu Bazel untuk mem-build biner yang dapat dieksekusi mandiri dari
file sumber hello-world.cc
tanpa dependensi.
Ringkasan: memulai
Sekarang Anda sudah memahami beberapa istilah utama, dan artinya dalam konteks project ini dan Bazel secara umum. Di bagian berikutnya, Anda akan membangun dan menguji Tahap 1 project.
Tahap 1: satu target, satu paket
Saatnya mem-build bagian pertama project. Untuk referensi visual, struktur bagian Tahap 1 project adalah:
examples
└── cpp-tutorial
└──stage1
├── main
│ ├── BUILD
│ └── hello-world.cc
└── WORKSPACE
Jalankan perintah berikut untuk berpindah ke direktori cpp-tutorial/stage1
:
cd cpp-tutorial/stage1
Kemudian jalankan:
bazel build //main:hello-world
Dalam label target, bagian //main:
adalah lokasi file BUILD
yang terkait dengan root ruang kerja, dan hello-world
adalah nama target dalam
file BUILD
.
Bazel menghasilkan sesuatu yang terlihat seperti ini:
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 2.267s, Critical Path: 0.25s
Kamu baru saja membuat target Bazel pertama. Bazel menempatkan output build di
direktori bazel-bin
di root
ruang kerja.
Sekarang uji biner yang baru Anda bangun, yaitu:
bazel-bin/main/hello-world
Tindakan ini akan menghasilkan pesan “Hello world
” yang dicetak.
Berikut adalah grafik dependensi Tahap 1:
Ringkasan: tahap 1
Setelah menyelesaikan build pertama, Anda memiliki gambaran dasar tentang struktur build. Pada tahap berikutnya, Anda akan menambahkan kompleksitas dengan menambahkan target lain.
Tahap 2: beberapa target build
Meskipun satu target sudah cukup untuk project kecil, Anda dapat membagi project yang lebih besar menjadi beberapa target dan paket. Hal ini memungkinkan build inkremental yang cepat – yaitu, Bazel hanya mem-build ulang yang telah berubah – dan mempercepat build Anda dengan mem-build beberapa bagian project sekaligus. Tahap tutorial ini menambahkan target, dan tahap berikutnya menambahkan paket.
Ini adalah direktori yang sedang Anda gunakan untuk Tahap 2:
├──stage2
│ ├── main
│ │ ├── BUILD
│ │ ├── hello-world.cc
│ │ ├── hello-greet.cc
│ │ └── hello-greet.h
│ └── WORKSPACE
Lihat file BUILD
di direktori cpp-tutorial/stage2/main
di bawah:
cc_library(
name = "hello-greet",
srcs = ["hello-greet.cc"],
hdrs = ["hello-greet.h"],
)
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
deps = [
":hello-greet",
],
)
Dengan file BUILD
ini, Bazel pertama-tama mem-build library hello-greet
(menggunakan cc_library rule
bawaan Bazel),
lalu biner hello-world
. Atribut deps
dalam
target hello-world
memberi tahu Bazel bahwa library hello-greet
diperlukan untuk mem-build biner hello-world
.
Sebelum dapat membangun versi baru project ini, Anda harus mengubah
direktori, beralih ke direktori cpp-tutorial/stage2
dengan menjalankan:
cd ../stage2
Sekarang Anda dapat membangun biner baru menggunakan perintah yang sudah dikenal berikut:
bazel build //main:hello-world
Sekali lagi, Bazel menghasilkan sesuatu yang terlihat seperti ini:
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 2.399s, Critical Path: 0.30s
Sekarang Anda dapat menguji biner yang baru dibangun, yang menampilkan “Hello world
” lain:
bazel-bin/main/hello-world
Jika sekarang Anda mengubah hello-greet.cc
dan mem-build ulang project, Bazel hanya akan mengompilasi ulang
file tersebut.
Melihat grafik dependensi, Anda dapat melihat bahwa hello-world bergantung pada input yang sama seperti sebelumnya, tetapi struktur build-nya berbeda:
Ringkasan: tahap 2
Sekarang Anda telah membangun proyek dengan dua target. Target hello-world
mem-build
satu file sumber dan bergantung pada satu target lain (//main:hello-greet
), yang
mem-build dua file sumber tambahan. Pada bagian berikutnya, lakukan selangkah lebih jauh
dan tambahkan paket lain.
Tahap 3: beberapa paket
Tahap berikutnya ini menambahkan lapisan kerumitan lain dan mem-build project dengan
beberapa paket. Lihat struktur dan konten direktori
cpp-tutorial/stage3
di bawah:
└──stage3
├── main
│ ├── BUILD
│ ├── hello-world.cc
│ ├── hello-greet.cc
│ └── hello-greet.h
├── lib
│ ├── BUILD
│ ├── hello-time.cc
│ └── hello-time.h
└── WORKSPACE
Anda dapat melihat bahwa sekarang ada dua subdirektori, dan masing-masing berisi file
BUILD
. Oleh karena itu, bagi Bazel, ruang kerja sekarang berisi dua paket: lib
dan
main
.
Lihat file lib/BUILD
:
cc_library(
name = "hello-time",
srcs = ["hello-time.cc"],
hdrs = ["hello-time.h"],
visibility = ["//main:__pkg__"],
)
Dan di file main/BUILD
:
cc_library(
name = "hello-greet",
srcs = ["hello-greet.cc"],
hdrs = ["hello-greet.h"],
)
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
deps = [
":hello-greet",
"//lib:hello-time",
],
)
Target hello-world
dalam paket utama bergantung pada target hello-time
dalam paket lib
(oleh karena itu label target //lib:hello-time
) - Bazel mengetahui
hal ini melalui atribut deps
. Anda dapat melihatnya dalam grafik
dependensi:
Agar build berhasil, buat target //lib:hello-time
di lib/BUILD
secara eksplisit terlihat oleh target di main/BUILD
menggunakan atribut visibilitas.
Hal ini karena target default hanya terlihat oleh target lain dalam file
BUILD
yang sama. Bazel menggunakan visibilitas target untuk mencegah masalah seperti library
yang berisi detail implementasi yang bocor ke API publik.
Sekarang, build versi akhir project ini. Beralih ke direktori cpp-tutorial/stage3
dengan menjalankan:
cd ../stage3
Sekali lagi, jalankan perintah berikut:
bazel build //main:hello-world
Bazel menghasilkan sesuatu yang terlihat seperti ini:
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 0.167s, Critical Path: 0.00s
Sekarang, uji biner terakhir tutorial ini untuk pesan Hello world
akhir:
bazel-bin/main/hello-world
Ringkasan: tahap 3
Sekarang, Anda telah membangun project sebagai dua paket dengan tiga target dan memahami dependensi di antara keduanya, sehingga Anda dapat melanjutkan dan membangun project masa depan dengan Bazel. Di bagian berikutnya, lihat cara melanjutkan perjalanan Bazel Anda.
Langkah berikutnya
Anda kini telah menyelesaikan build dasar pertama dengan Bazel, tetapi ini baru awal. Berikut adalah beberapa referensi lainnya untuk terus mempelajari Bazel:
- Untuk tetap fokus pada C++, baca kasus penggunaan build C++ umum.
- Untuk mulai mem-build aplikasi lain dengan Bazel, lihat tutorial untuk Java, aplikasi Android, atau aplikasi iOS.
- Untuk mempelajari lebih lanjut cara bekerja dengan repositori lokal dan jarak jauh, baca dependensi eksternal.
- Untuk mempelajari lebih lanjut aturan Bazel lainnya, lihat panduan referensi ini.
Selamat membangun!