Tutorial ini membahas dasar-dasar pembuatan aplikasi Java dengan
Bazel. Anda akan menyiapkan ruang kerja dan membuat project Java sederhana yang
menggambarkan konsep utama Bazel, seperti target dan file BUILD
.
Perkiraan waktu penyelesaian: 30 menit.
Apa yang akan Anda pelajari
Dalam tutorial ini, Anda akan mempelajari cara:
- Membuat target
- Memvisualisasikan dependensi project
- Memisahkan project menjadi beberapa target dan paket
- Mengontrol visibilitas target di seluruh paket
- Mereferensikan target melalui label
- Men-deploy target
Sebelum memulai
Instal Bazel
Untuk mempersiapkan tutorial, pertama-tama Instal Bazel jika Anda belum menginstalnya.
Menginstal JDK
Instal Java JDK (versi yang lebih disukai adalah 11, namun versi antara 8 dan 15 didukung).
Setel variabel lingkungan JAVA_HOME untuk mengarah ke JDK.
Di Linux/macOS:
export JAVA_HOME="$(dirname $(dirname $(realpath $(which javac))))"
Di Windows:
- Buka Control Panel.
- Buka "Sistem dan Keamanan" > "Sistem" > "Setelan Sistem Lanjutan" > tab "Lanjutan" > "Variabel Lingkungan..." .
- Di daftar "Variabel pengguna" (yang ada di bagian atas), klik "Baru...".
- Di kolom "Nama variabel", masukkan
JAVA_HOME
. - Klik "Jelajahi Direktori...".
- Buka direktori JDK (misalnya
C:\Program Files\Java\jdk1.8.0_152
). - Klik "OK" pada semua jendela dialog.
Mendapatkan contoh project
Ambil project contoh dari repositori GitHub Bazel:
git clone https://github.com/bazelbuild/examples
Project contoh untuk tutorial ini ada di direktori examples/java-tutorial
dan disusun sebagai berikut:
java-tutorial
├── BUILD
├── src
│ └── main
│ └── java
│ └── com
│ └── example
│ ├── cmdline
│ │ ├── BUILD
│ │ └── Runner.java
│ ├── Greeting.java
│ └── ProjectRunner.java
└── WORKSPACE
Membangun dengan Bazel
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. Class ini juga berisi file yang dikenali Bazel sebagai spesial:
File
WORKSPACE
, yang mengidentifikasi direktori dan isinya sebagai ruang kerja Bazel dan berada di root struktur direktori project.Satu atau beberapa file
BUILD
, yang memberi tahu Bazel cara mem-build berbagai bagian project. (Direktori dalam ruang kerja yang berisi fileBUILD
adalah sebuah paket. Anda akan mempelajari tentang paket nanti dalam tutorial ini.)
Untuk menetapkan direktori sebagai ruang kerja Bazel, buat file kosong bernama
WORKSPACE
di direktori tersebut.
Saat Bazel mem-build project, semua input dan dependensi harus berada di ruang kerja yang sama. File yang berada di ruang kerja yang berbeda tidak saling bergantung kecuali jika ditautkan, yang berada di luar cakupan tutorial ini.
Memahami file BUILD
File BUILD
berisi beberapa jenis petunjuk untuk Bazel.
Jenis yang paling penting adalah aturan build, 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 java-tutorial/BUILD
:
java_binary(
name = "ProjectRunner",
srcs = glob(["src/main/java/com/example/*.java"]),
)
Dalam contoh kami, target ProjectRunner
membuat instance
aturan java_binary
bawaan Bazel. Aturan tersebut memberi tahu Bazel untuk
membuat file .jar
dan skrip shell wrapper (keduanya diberi nama berdasarkan target).
Atribut pada target secara eksplisit menyatakan dependensi dan opsinya.
Meskipun atribut name
bersifat wajib, banyak yang bersifat opsional. Misalnya, dalam
target aturan ProjectRunner
, name
adalah nama target, srcs
menentukan
file sumber yang digunakan Bazel untuk membuat target, dan main_class
menentukan
class yang berisi metode utama. (Anda mungkin sudah melihat bahwa contoh kami menggunakan glob untuk meneruskan satu set file sumber ke Bazel, bukan mencantumkannya satu per satu.)
Membuat project
Untuk membuat project contoh, buka direktori java-tutorial
dan jalankan:
bazel build //:ProjectRunner
Dalam label target, bagian //
adalah lokasi file BUILD
yang relatif terhadap root ruang kerja (dalam hal ini, root itu sendiri),
dan ProjectRunner
adalah nama target dalam file BUILD
. (Anda akan mempelajari label target secara lebih mendetail di akhir tutorial ini.)
Bazel menghasilkan output yang mirip dengan berikut ini:
INFO: Found 1 target...
Target //:ProjectRunner up-to-date:
bazel-bin/ProjectRunner.jar
bazel-bin/ProjectRunner
INFO: Elapsed time: 1.021s, Critical Path: 0.83s
Selamat, Anda baru saja membuat target Bazel pertama Anda! Bazel menempatkan
output build di direktori bazel-bin
di root ruang kerja. Jelajahi
kontennya untuk mendapatkan ide tentang struktur output Bazel.
Sekarang, uji biner yang baru Anda bangun:
bazel-bin/ProjectRunner
Meninjau grafik dependensi
Bazel memerlukan dependensi build untuk dideklarasikan secara eksplisit dalam file BUILD. Bazel menggunakan pernyataan tersebut untuk membuat grafik dependensi project, yang memungkinkan build inkremental yang akurat.
Untuk memvisualisasikan dependensi project contoh, Anda dapat membuat representasi teks grafik dependensi dengan menjalankan perintah ini di root ruang kerja:
bazel query --notool_deps --noimplicit_deps "deps(//:ProjectRunner)" --output graph
Perintah di atas memberi tahu Bazel untuk mencari semua dependensi untuk //:ProjectRunner
target (kecuali host dan dependensi implisit) dan memformat output sebagai grafik.
Kemudian, tempelkan teks ke GraphViz.
Seperti yang dapat Anda lihat, project memiliki satu target yang membuat dua file sumber tanpa dependensi tambahan:
Setelah menyiapkan ruang kerja, membangun project, dan memeriksa dependensinya, Anda dapat menambahkan beberapa kerumitan.
Sempurnakan build Bazel Anda
Meskipun satu target cukup untuk project kecil, Anda mungkin ingin membagi project yang lebih besar menjadi beberapa target dan paket untuk memungkinkan build inkremental yang cepat (yaitu, hanya mem-build ulang apa yang berubah) dan untuk mempercepat build dengan mem-build beberapa bagian project sekaligus.
Menentukan beberapa target build
Anda dapat membagi build project contoh menjadi dua target. Ganti konten file java-tutorial/BUILD
dengan berikut ini:
java_binary(
name = "ProjectRunner",
srcs = ["src/main/java/com/example/ProjectRunner.java"],
main_class = "com.example.ProjectRunner",
deps = [":greeter"],
)
java_library(
name = "greeter",
srcs = ["src/main/java/com/example/Greeting.java"],
)
Dengan konfigurasi ini, Bazel terlebih dahulu akan mem-build library greeter
, lalu biner ProjectRunner
. Atribut deps
dalam java_binary
memberi tahu Bazel bahwa
library greeter
diperlukan untuk membuat biner ProjectRunner
.
Untuk mem-build project versi baru ini, jalankan perintah berikut:
bazel build //:ProjectRunner
Bazel menghasilkan output yang mirip dengan berikut ini:
INFO: Found 1 target...
Target //:ProjectRunner up-to-date:
bazel-bin/ProjectRunner.jar
bazel-bin/ProjectRunner
INFO: Elapsed time: 2.454s, Critical Path: 1.58s
Sekarang, uji biner yang baru Anda bangun:
bazel-bin/ProjectRunner
Jika Anda sekarang mengubah ProjectRunner.java
dan mem-build ulang project, Bazel hanya
akan mengompilasi ulang file tersebut.
Dengan melihat grafik dependensi, Anda dapat melihat bahwa ProjectRunner
bergantung pada
input yang sama seperti sebelumnya, tetapi struktur build-nya berbeda:
Anda sekarang telah membangun proyek dengan dua target. Target ProjectRunner
membuat
dua file sumber dan bergantung pada satu target lainnya (:greeter
), yang mem-build
satu file sumber tambahan.
Menggunakan beberapa paket
Sekarang, mari kita bagi project menjadi beberapa paket. Jika melihat direktori
src/main/java/com/example/cmdline
, Anda bisa mengetahui bahwa direktori tersebut juga berisi
file BUILD
, plus beberapa file sumber. Oleh karena itu, untuk Bazel, ruang kerja kini
berisi dua paket, //src/main/java/com/example/cmdline
dan //
(karena
ada file BUILD
di root ruang kerja).
Lihat file src/main/java/com/example/cmdline/BUILD
:
java_binary(
name = "runner",
srcs = ["Runner.java"],
main_class = "com.example.cmdline.Runner",
deps = ["//:greeter"],
)
Target runner
bergantung pada target greeter
dalam paket //
(oleh karena itu,
label target //:greeter
) - Bazel mengetahui hal ini melalui atribut deps
.
Lihat grafik dependensi berikut:
Namun, agar build berhasil, Anda harus secara eksplisit memberikan target runner
dalam visibilitas //src/main/java/com/example/cmdline/BUILD
ke target di
//BUILD
menggunakan atribut visibility
. 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.)
Untuk melakukannya, tambahkan atribut visibility
ke target greeter
di
java-tutorial/BUILD
seperti yang ditunjukkan di bawah ini:
java_library(
name = "greeter",
srcs = ["src/main/java/com/example/Greeting.java"],
visibility = ["//src/main/java/com/example/cmdline:__pkg__"],
)
Sekarang Anda dapat mem-build paket baru dengan menjalankan perintah berikut di root workspace:
bazel build //src/main/java/com/example/cmdline:runner
Bazel menghasilkan output yang mirip dengan berikut ini:
INFO: Found 1 target...
Target //src/main/java/com/example/cmdline:runner up-to-date:
bazel-bin/src/main/java/com/example/cmdline/runner.jar
bazel-bin/src/main/java/com/example/cmdline/runner
INFO: Elapsed time: 1.576s, Critical Path: 0.81s
Sekarang, uji biner yang baru Anda bangun:
./bazel-bin/src/main/java/com/example/cmdline/runner
Sekarang Anda telah mengubah project untuk mem-build sebagai dua paket, yang masing-masing berisi satu target, dan memahami dependensi di antara keduanya.
Menggunakan label untuk mereferensikan target
Dalam file BUILD
dan di command line, Bazel menggunakan label target untuk mereferensikan
target, misalnya, //:ProjectRunner
atau
//src/main/java/com/example/cmdline:runner
. Sintaksisnya adalah sebagai berikut:
//path/to/package:target-name
Jika targetnya adalah target aturan, maka path/to/package
adalah jalur ke direktori yang berisi file BUILD
, dan target-name
adalah nama target dalam file BUILD
(atribut name
). Jika targetnya adalah target
file, maka path/to/package
adalah jalur ke root paket, dan
target-name
adalah nama file target, termasuk jalur lengkapnya.
Saat mereferensikan target di root repositori, jalur paket akan kosong,
cukup gunakan //:target-name
. Saat mereferensikan target dalam file BUILD
yang sama, Anda bahkan dapat melewati ID root ruang kerja //
dan hanya menggunakan
:target-name
.
Misalnya, untuk target dalam file java-tutorial/BUILD
, Anda tidak perlu
menentukan jalur paket, karena root ruang kerja itu sendiri adalah paket (//
), dan
dua label target Anda hanya //:ProjectRunner
dan //:greeter
.
Namun, untuk target dalam file //src/main/java/com/example/cmdline/BUILD
, Anda harus menentukan jalur paket lengkap //src/main/java/com/example/cmdline
dan label target adalah //src/main/java/com/example/cmdline:runner
.
Mengemas target Java untuk deployment
Sekarang, mari kita paketkan target Java untuk deployment dengan membangun biner bersama semua dependensi runtime-nya. Hal ini memungkinkan Anda menjalankan biner di luar lingkungan pengembangan.
Seperti yang Anda ingat, aturan build java_binary
menghasilkan skrip shell wrapper dan .jar
. Lihat isi
runner.jar
menggunakan perintah ini:
jar tf bazel-bin/src/main/java/com/example/cmdline/runner.jar
Isinya adalah:
META-INF/
META-INF/MANIFEST.MF
com/
com/example/
com/example/cmdline/
com/example/cmdline/Runner.class
Seperti yang dapat Anda lihat, runner.jar
berisi Runner.class
, tetapi tidak dependensinya,
Greeting.class
. Skrip runner
yang dihasilkan Bazel akan menambahkan greeter.jar
ke classpath. Jadi, jika Anda membiarkannya seperti ini, skrip akan berjalan secara lokal, tetapi
tidak akan berjalan secara mandiri di komputer lain. Untungnya, aturan java_binary
memungkinkan Anda membuat biner mandiri yang dapat di-deploy. Untuk mem-build-nya, tambahkan
_deploy.jar
ke nama target:
bazel build //src/main/java/com/example/cmdline:runner_deploy.jar
Bazel menghasilkan output yang mirip dengan berikut ini:
INFO: Found 1 target...
Target //src/main/java/com/example/cmdline:runner_deploy.jar up-to-date:
bazel-bin/src/main/java/com/example/cmdline/runner_deploy.jar
INFO: Elapsed time: 1.700s, Critical Path: 0.23s
Anda baru saja mem-build runner_deploy.jar
, yang dapat dijalankan secara mandiri dari
lingkungan pengembangan Anda karena berisi dependensi runtime
yang diperlukan. Lihat isi JAR mandiri ini menggunakan
perintah yang sama seperti sebelumnya:
jar tf bazel-bin/src/main/java/com/example/cmdline/runner_deploy.jar
Isinya mencakup semua class yang diperlukan untuk dijalankan:
META-INF/
META-INF/MANIFEST.MF
build-data.properties
com/
com/example/
com/example/cmdline/
com/example/cmdline/Runner.class
com/example/Greeting.class
Bacaan lebih lanjut
Untuk mengetahui detail selengkapnya, lihat:
rules_jvm_external untuk aturan guna mengelola dependensi Maven transitif.
Dependensi Eksternal untuk mempelajari lebih lanjut cara menggunakan repositori lokal dan jarak jauh.
Aturan lain untuk mempelajari Bazel lebih lanjut.
Tutorial build C++ untuk mulai membangun project C++ dengan Bazel.
Tutorial aplikasi Android dan tutorial aplikasi iOS) untuk mulai mem-build aplikasi seluler untuk Android dan iOS dengan Bazel.
Selamat membangun!