Bu eğitimde, Bazel ile Java uygulamaları oluşturmanın temelleri ele alınmaktadır. Çalışma alanınızı oluşturup hedefler ve BUILD
dosyaları gibi temel Bazel kavramlarını gösteren basit bir Java projesi oluşturacaksınız.
Tahmini tamamlama süresi: 30 dakika.
Neler öğreneceksiniz?
Bu eğitimde şunları öğreneceksiniz:
- Hedef oluşturma
- Projenin bağımlılıklarını görselleştirme
- Projeyi birden çok hedefe ve pakete bölme
- Paketler genelinde hedef görünürlüğünü kontrol etme
- Etiketler aracılığıyla referans hedefleri
- Hedef dağıtma
Başlamadan önce
Bazel'i yükleme
Eğitime hazırlanmak için, henüz yüklemediyseniz önce Bazel'i yükleyin.
JDK'yi yükleme
Java JDK'yı yükleyin (tercih edilen sürüm 11'dir ancak 8 ile 15 arasındaki sürümler desteklenir).
JAVA_HOME ortam değişkenini JDK'yi işaret edecek şekilde ayarlayın.
Linux/macOS'te:
export JAVA_HOME="$(dirname $(dirname $(realpath $(which javac))))"
Windows'da:
- Denetim Masası'nı açın.
- "Sistem ve Güvenlik" > "Sistem" > "Gelişmiş Sistem Ayarları" > "Gelişmiş" sekmesi > "Ortam Değişkenleri..."ne gidin. .
- "Kullanıcı değişkenleri" listesi altında (üstteki) "Yeni..." seçeneğini tıklayın.
- "Değişken adı" alanına
JAVA_HOME
yazın. - "Dizin'e göz at..."ı tıklayın.
- JDK dizinine (örneğin,
C:\Program Files\Java\jdk1.8.0_152
) gidin. - Tüm iletişim pencerelerinde "Tamam"ı tıklayın.
Örnek projeyi alma
Bazel'in GitHub deposundan örnek projeyi alın:
git clone https://github.com/bazelbuild/examples
Bu eğitim için örnek proje examples/java-tutorial
dizinindedir ve aşağıdaki gibi yapılandırılır:
java-tutorial
├── BUILD
├── src
│ └── main
│ └── java
│ └── com
│ └── example
│ ├── cmdline
│ │ ├── BUILD
│ │ └── Runner.java
│ ├── Greeting.java
│ └── ProjectRunner.java
└── MODULE.bazel
Bazel ile derleme
Çalışma alanını ayarlama
Bir proje oluşturabilmek için önce projenin çalışma alanını kurmanız gerekir. Çalışma alanı, projenizin kaynak dosyalarını ve Bazel'ın derleme çıkışlarını barındıran bir dizindir. Ayrıca, Bazel'in özel olarak tanıdığı dosyaları da içerir:
Dizini ve içeriğini Bazel çalışma alanı olarak tanımlayan ve projenin dizin yapısının kökünde bulunan
MODULE.bazel
dosyası,Bazel'e projenin farklı bölümlerinin nasıl derleneceğini söyleyen bir veya daha fazla
BUILD
dosyası. (Çalışma alanındakiBUILD
dosyası içeren bir dizin pakettir. Paketler hakkında daha fazla bilgiyi bu eğitimde bulabilirsiniz.)
Bir dizini Bazel çalışma alanı olarak atamak için söz konusu dizinde MODULE.bazel
adlı boş bir dosya oluşturun.
Bazel projeyi derlediğinde tüm girişler ve bağımlılıklar aynı çalışma alanında olmalıdır. Farklı çalışma alanlarında bulunan dosyalar, bağlanmadıkları sürece birbirinden bağımsızdır. Bu konu bu eğitim kapsamında değildir.
BUILD dosyasını anlama
BUILD
dosyası, Bazel için birkaç farklı türde talimat içerir.
En önemli tür, Bazel'e istenen çıkışları (ör. yürütülebilir ikili dosyalar veya kitaplıklar) nasıl oluşturacağını söyleyen derleme kuralı'dır. BUILD
dosyasındaki her derleme kuralının örneği hedef olarak adlandırılır ve belirli bir kaynak dosya ve bağımlılık grubuna işaret eder. Bir hedef başka hedefleri de
gösterebilir.
java-tutorial/BUILD
dosyasına göz atın:
java_binary(
name = "ProjectRunner",
srcs = glob(["src/main/java/com/example/*.java"]),
)
Örneğimizde ProjectRunner
hedefi, Bazel'in yerleşik java_binary
kuralını örneklendirir. Kural, Bazel'e bir .jar
dosyası ve sarmalayıcı kabuk komut dosyası (her ikisi de hedefin adıyla adlandırılır) oluşturmasını söyler.
Hedefteki özellikler, bağımlılıkları ve seçenekleri açıkça belirtir.
name
özelliği zorunlu olsa da birçoğu isteğe bağlıdır. Örneğin, ProjectRunner
kural hedefinde name
hedefin adıdır, srcs
, hedefi oluşturmak için kullandığı kaynak dosyaları ve main_class
, ana yöntemi içeren sınıfı belirtir. (Örneğimizde, bir grup kaynak dosyasını tek tek listelemek yerine Bazel'a iletmek için glob'un kullanıldığını fark etmiş olabilirsiniz.)
Projeyi oluşturma
Örnek projenizi derlemek için java-tutorial
dizinine gidin ve aşağıdaki komutu çalıştırın:
bazel build //:ProjectRunner
Hedef etikette //
bölümü, çalışma alanının köküne göre BUILD
dosyasının konumudur (bu örnekte kökün kendisi) ve ProjectRunner
, BUILD
dosyasındaki hedef addır. (Hedef etiketler hakkında daha fazla bilgiyi bu eğitim makalesinin sonunda bulabilirsiniz.)
Bazel, aşağıdakine benzer bir çıktı oluşturur:
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
Tebrikler, ilk Bazel hedefinizi oluşturdunuz. Bazel, derleme çıkışlarını çalışma alanının kökündeki bazel-bin
dizinine yerleştirir. Bazel'in çıkış yapısı hakkında fikir edinmek için içeriğine göz atın.
Şimdi yeni derlenen ikili programınızı test edin:
bazel-bin/ProjectRunner
Bağımlılık grafiğini inceleme
Bazel, derleme bağımlılıklarının BUILD dosyalarında açıkça tanımlanmasını gerektirir. Bazel, projenin bağımlılık grafiğini oluşturmak için bu ifadeleri kullanır. Bu sayede doğru artımlı derlemeler yapılabilir.
Örnek projenin bağımlılıklarını görselleştirmek için çalışma alanı kökünde şu komutu çalıştırarak bağımlılık grafiğinin metin temsilini oluşturabilirsiniz:
bazel query --notool_deps --noimplicit_deps "deps(//:ProjectRunner)" --output graph
Yukarıdaki komut, Bazel'a hedef //:ProjectRunner
için tüm bağımlılıkları aramasını (ana makine ve örtülü bağımlılıklar hariç) ve çıkışı grafik olarak biçimlendirmesini söyler.
Ardından, metni GraphViz içine yapıştırın.
Gördüğünüz gibi, projede ek bağımlılık olmadan iki kaynak dosya oluşturan tek bir hedef vardır:
Çalışma alanınızı oluşturduktan, projenizi derledikten ve bağımlılıklarını inceledikten sonra, biraz karmaşıklık ekleyebilirsiniz.
Bazel derlemenizi hassaslaştırma
Küçük projeler için tek bir hedef yeterli olsa da hızlı artımlı derlemelere (yani yalnızca değişenleri yeniden derlemeye) izin vermek ve bir projenin birden fazla bölümünü aynı anda derleyerek derlemelerinizi hızlandırmak için büyük projeleri birden fazla hedefe ve pakete bölmek isteyebilirsiniz.
Birden fazla derleme hedefi belirtme
Örnek proje derlemesini iki hedefe bölebilirsiniz. java-tutorial/BUILD
dosyasının içeriğini aşağıdakiyle değiştirin:
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"],
)
Bu yapılandırmayla Bazel önce greeter
kitaplığını, ardından ProjectRunner
ikili programını oluşturur. java_binary
içindeki deps
özelliği, Bazel'e ProjectRunner
ikili programını derlemek için greeter
kitaplığının gerekli olduğunu bildirir.
Projenin bu yeni sürümünü derlemek için aşağıdaki komutu çalıştırın:
bazel build //:ProjectRunner
Bazel, aşağıdakine benzer bir çıktı oluşturur:
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
Ardından, yeni oluşturulan ikili dosyanızı test edin:
bazel-bin/ProjectRunner
Artık ProjectRunner.java
dosyasını değiştirip projeyi yeniden oluşturursanız Bazel yalnızca bu dosyayı yeniden derleyecektir.
Bağımlılık grafiğine baktığınızda ProjectRunner
'ün öncekiyle aynı girişlere bağlı olduğunu ancak derlemenin yapısının farklı olduğunu görebilirsiniz:
Artık projeyi iki hedefle oluşturdunuz. ProjectRunner
hedefi iki kaynak dosya oluşturur ve bir ek kaynak dosya oluşturan başka bir hedefe (:greeter
) bağlıdır.
Birden çok paket kullanma
Şimdi projeyi birden fazla pakete bölelim. src/main/java/com/example/cmdline
dizinine göz atarsanız bir BUILD
dosyasının yanı sıra bazı kaynak dosyaları da içerdiğini görebilirsiniz. Bu nedenle, Bazel'e göre çalışma alanı artık //src/main/java/com/example/cmdline
ve //
olmak üzere iki paket içeriyor (çalışma alanının kökünde bir BUILD
dosyası bulunduğundan).
src/main/java/com/example/cmdline/BUILD
dosyasına göz atın:
java_binary(
name = "runner",
srcs = ["Runner.java"],
main_class = "com.example.cmdline.Runner",
deps = ["//:greeter"],
)
runner
hedefi, //
paketindeki greeter
hedefine (dolayısıyla hedef etiketi //:greeter
) bağlıdır. Bazel bunu deps
özelliği aracılığıyla bilir.
Bağımlılık grafiğine göz atın:
Ancak derlemenin başarılı olması için visibility
özelliğini kullanarak //src/main/java/com/example/cmdline/BUILD
'daki runner
hedefine //BUILD
'deki hedeflere yönelik açık bir görünürlük vermeniz gerekir. Bunun nedeni, hedeflerin varsayılan olarak yalnızca aynı BUILD
dosyasındaki diğer hedefler tarafından görülebilmesidir. (Bazel, uygulama ayrıntılarını içeren kitaplıkların herkese açık API'lere sızması gibi sorunların önüne geçmek için hedef görünürlüğü kullanır.)
Bunu yapmak için visibility
özelliğini aşağıda gösterildiği gibi java-tutorial/BUILD
içindeki greeter
hedefine ekleyin:
java_library(
name = "greeter",
srcs = ["src/main/java/com/example/Greeting.java"],
visibility = ["//src/main/java/com/example/cmdline:__pkg__"],
)
Artık çalışma alanının kökünde aşağıdaki komutu çalıştırarak yeni paketi oluşturabilirsiniz:
bazel build //src/main/java/com/example/cmdline:runner
Bazel, aşağıdakine benzer bir çıktı oluşturur:
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
Şimdi yeni derlenen ikili programınızı test edin:
./bazel-bin/src/main/java/com/example/cmdline/runner
Artık projeyi, her biri bir hedef içeren iki paket olarak derlenecek şekilde değiştirdiniz ve aralarındaki bağımlılıkları anladınız.
Hedeflere referans vermek için etiketleri kullanma
Bazel, BUILD
dosyalarında ve komut satırında hedeflere referans vermek için hedef etiketleri kullanır (ör. //:ProjectRunner
veya //src/main/java/com/example/cmdline:runner
). Söz dizimleri aşağıdaki gibidir:
//path/to/package:target-name
Hedef bir kural hedefiyse path/to/package
, BUILD
dosyasını içeren dizinin yoludur ve target-name
, BUILD
dosyasında hedefe verdiğiniz addır (name
özelliği). Hedef bir dosya hedefiyse path/to/package
, paketin köküdür; target-name
ise tam yol dahil olmak üzere hedef dosyanın adıdır.
Depo kökündeki hedeflere referans verirken paket yolu boştur, yalnızca //:target-name
kullanın. Aynı BUILD
dosyasındaki hedeflere referans verirken //
Workspace kök tanımlayıcısını atlayabilir ve yalnızca :target-name
kullanabilirsiniz.
Örneğin, java-tutorial/BUILD
dosyasındaki hedefler için bir paket yolu belirtmeniz gerekmez. Bunun nedeni, çalışma alanı kökünün de bir paket (//
) olması ve iki hedef etiketinizin yalnızca //:ProjectRunner
ve //:greeter
olmasıdır.
Ancak //src/main/java/com/example/cmdline/BUILD
dosyasındaki hedefler için //src/main/java/com/example/cmdline
öğesinin tam paket yolunu belirtmeniz gerekiyordu ve hedef etiketiniz //src/main/java/com/example/cmdline:runner
idi.
Bir Java hedefini dağıtım için paketleme
Şimdi ikili dosyayı tüm çalışma zamanı bağımlılıkları ile derleyerek dağıtım için bir Java hedefi paketleyelim. Bu sayede ikili programı, geliştirme ortamınızın dışında çalıştırabilirsiniz.
Hatırlayacağınız gibi, java_binary derleme kuralı bir .jar
ve sarmalayıcı kabuk komut dosyası oluşturur. Şu komutu kullanarak runner.jar
içeriğine göz atın:
jar tf bazel-bin/src/main/java/com/example/cmdline/runner.jar
İçeriklerin özellikleri:
META-INF/
META-INF/MANIFEST.MF
com/
com/example/
com/example/cmdline/
com/example/cmdline/Runner.class
Gördüğünüz gibi runner.jar
, Runner.class
'u içerir ancak bağımlılık öğesi Greeting.class
'yi içermez. Bazel'in oluşturduğu runner
komut dosyası, sınıf yoluna greeter.jar
ekler. Bu nedenle, dosyayı bu şekilde bırakırsanız yerel olarak çalışır ancak başka bir makinede bağımsız olarak çalışmaz. Neyse ki java_binary
kuralı, bağımsız, dağıtılabilir bir ikili program derlemenizi sağlar. Oluşturmak için hedef adın sonuna _deploy.jar
ekleyin:
bazel build //src/main/java/com/example/cmdline:runner_deploy.jar
Bazel, aşağıdakine benzer çıktılar üretir:
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
runner_deploy.jar
'ü derlediniz. Gerekli çalışma zamanı bağımlılıkları içerdiğinden, geliştirme ortamınızdan bağımsız olarak çalıştırabilirsiniz. Önceki komutu kullanarak bu bağımsız JAR dosyasının içeriğine göz atın:
jar tf bazel-bin/src/main/java/com/example/cmdline/runner_deploy.jar
İçerik, çalıştırılacak gerekli tüm sınıfları içerir:
META-INF/
META-INF/MANIFEST.MF
build-data.properties
com/
com/example/
com/example/cmdline/
com/example/cmdline/Runner.class
com/example/Greeting.class
Daha fazla bilgi
Daha fazla bilgi için:
rules_jvm_external komutunu çalıştırın.
Yerel ve uzak depolarla çalışma hakkında daha fazla bilgi edinmek için Harici Bağımlılıklar başlıklı makaleyi inceleyin.
Bazel hakkında daha fazla bilgi edinmek için diğer kurallar
Bazel ile C++ projeleri oluşturmaya başlamak için C++ derleme eğiticisini inceleyin.
Android uygulama eğitimi ve iOS uygulama eğitimi) inceleyin.
İyi çalışmalar.