Pengantar
Baru mengenal Bazel? Anda berada di tempat yang tepat. Ikuti tutorial First Build ini untuk pengenalan sederhana tentang penggunaan Bazel. Tutorial ini menjelaskan istilah-istilah utama saat digunakan dalam konteks Bazel dan memandu Anda memahami dasar-dasar alur kerja Bazel. Dimulai dengan alat yang diperlukan, Anda akan membangun dan menjalankan tiga project dengan meningkatkan kompleksitas serta mempelajari bagaimana dan mengapa project tersebut menjadi lebih kompleks.
Meskipun Bazel adalah sistem build yang mendukung build multibahasa, tutorial ini menggunakan project C++ sebagai contoh dan memberikan panduan serta 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 juga untuk mendapatkan hasil terbaik, instal Git.
Selanjutnya, ambil project contoh dari repositori GitHub Bazel dengan menjalankan hal berikut di 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 set file, masing-masing set mewakili satu tahap dalam tutorial ini. Pada tahap pertama, Anda akan membuat 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-build-nya dengan beberapa target.
Ringkasan: Pendahuluan
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 menentukan beberapa istilah dan menyiapkan ruang kerja.
Memulai
Siapkan ruang kerja
Sebelum dapat membuat project, Anda perlu menyiapkan ruang kerja. Ruang kerja adalah direktori yang menyimpan file sumber project dan output build Bazel. File tersebut juga berisi file-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 membuat berbagai bagian project. Direktori dalam ruang kerja yang berisi fileBUILD
filesBUILD
adalah paket. (Informasi lebih lanjut tentang paket akan dibahas nanti dalam tutorial ini.)
Dalam project mendatang, untuk menetapkan direktori sebagai ruang kerja Bazel, buat
file kosong bernama WORKSPACE
di direktori tersebut. Untuk keperluan tutorial ini,
file WORKSPACE
sudah ada dalam setiap tahap.
CATATAN: Saat Bazel mem-build project, semua input harus berada di ruang kerja yang sama. File yang berada di ruang kerja yang berbeda tidak saling bergantung kecuali jika ditautkan. Informasi lebih mendetail tentang aturan ruang kerja dapat ditemukan di panduan ini.
Memahami file BUILD
File BUILD
berisi beberapa jenis petunjuk untuk Bazel. Setiap
file BUILD
memerlukan setidaknya satu aturan
sebagai serangkaian petunjuk, yang memberi tahu Bazel cara mem-build output yang diinginkan,
seperti library atau biner yang dapat dieksekusi. Setiap instance aturan build dalam
file BUILD
disebut target
dan mengarah ke kumpulan file sumber dan dependensi tertentu.
Target juga dapat menunjuk ke target lain.
Lihat file BUILD
di direktori cpp-tutorial/stage1/main
:
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
)
Dalam contoh kami, target hello-world
membuat instance cc_binary rule
bawaan Bazel.
Aturan tersebut memberi tahu Bazel untuk mem-build biner mandiri yang dapat dieksekusi dari file sumber hello-world.cc
tanpa dependensi.
Ringkasan: memulai
Sekarang Anda sudah memahami beberapa istilah penting, dan artinya dalam konteks project ini dan Bazel secara umum. Di bagian berikutnya, Anda akan membangun dan menguji Tahap 1 proyek.
Tahap 1: target tunggal, paket tunggal
Saatnya untuk membangun bagian pertama dari proyek. Untuk referensi visual, struktur bagian Tahap 1 pada 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 relatif terhadap 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
Anda baru saja membuat target Bazel pertama Anda. Bazel menempatkan output build di
direktori bazel-bin
di root
ruang kerja.
Sekarang uji biner Anda yang baru dibuat, 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 telah memiliki gambaran dasar tentang struktur build. Pada tahap selanjutnya, Anda akan menambahkan kompleksitas dengan menambahkan target lain.
Tahap 2: beberapa target build
Meskipun satu target 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 apa yang berubah – dan mempercepat build dengan mem-build beberapa bagian project sekaligus. Tahap tutorial ini menambahkan target, dan tahap berikutnya menambahkan paket.
Ini adalah direktori yang Anda kerjakan untuk Tahap 2:
├──stage2
│ ├── main
│ │ ├── BUILD
│ │ ├── hello-world.cc
│ │ ├── hello-greet.cc
│ │ └── hello-greet.h
│ └── WORKSPACE
Lihat file BUILD
di bawah direktori cpp-tutorial/stage2/main
di bawah ini:
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 terlebih dahulu akan 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 membuat biner hello-world
.
Sebelum dapat mem-build project versi baru ini, Anda perlu mengubah
direktori, beralih ke direktori cpp-tutorial/stage2
dengan menjalankan:
cd ../stage2
Sekarang Anda dapat mem-build 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 dibuat, yang menampilkan “Hello world
” lain:
bazel-bin/main/hello-world
Jika Anda sekarang mengubah hello-greet.cc
dan mem-build ulang project, Bazel hanya akan mengompilasi ulang
file tersebut.
Dengan melihat grafik dependensi, Anda dapat melihat bahwa hello-world
bergantung pada input tambahan
bernama hello-greet
:
Ringkasan: tahap 2
Anda sekarang telah membangun proyek dengan dua target. Target hello-world
membuat
satu file sumber dan bergantung pada satu target lainnya (//main:hello-greet
), yang
membuat dua file sumber tambahan. Di bagian selanjutnya, ambil selangkah lebih maju
dan tambahkan paket lain.
Tahap 3: beberapa paket
Tahap berikutnya ini menambahkan lapisan detail lain dan mem-build project dengan
beberapa paket. Lihat struktur dan konten direktori
cpp-tutorial/stage3
di bawah ini:
└──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 kini ada dua subdirektori, dan masing-masing berisi satu file
BUILD
. Oleh karena itu, untuk Bazel, ruang kerja kini 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__"],
)
Pada 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
(sehingga label target //lib:hello-time
) - Bazel mengetahui
hal ini melalui atribut deps
. Anda dapat melihatnya tercermin 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 secara default target 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 final project ini. Beralih ke direktori
cpp-tutorial/stage3
dengan menjalankan:
cd ../stage3
Jalankan perintah berikut sekali lagi:
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 mem-build project sebagai dua paket dengan tiga target dan memahami dependensi di antara keduanya, sehingga Anda dapat melanjutkan dan mem-build project mendatang dengan Bazel. Di bagian berikutnya, lihat cara untuk melanjutkan perjalanan Bazel.
Langkah berikutnya
Anda telah menyelesaikan build dasar pertama Anda dengan Bazel, tetapi ini baru saja. Berikut ini beberapa referensi lainnya untuk terus belajar bersama Bazel:
- Untuk terus berfokus pada C++, baca kasus penggunaan build C++ yang umum.
- Untuk mulai mem-build aplikasi lain dengan Bazel, lihat tutorial untuk Java, aplikasi Android, atau aplikasi iOS).
- Untuk mempelajari lebih lanjut cara menggunakan repositori lokal dan jarak jauh, baca dependensi eksternal.
- Untuk mempelajari aturan Bazel lebih lanjut, lihat panduan referensi ini.
Selamat membangun!