Giriş
Bazel'i kullanmaya yeni mi başladınız? Doğru yerdesiniz. Bazel'i kullanmaya yönelik basit bir giriş için bu ilk derleme eğitimini izleyin. Bu eğitimde, temel terimler Bazel bağlamında kullanıldığı şekilde tanımlanmakta ve Bazel iş akışının temelleri açıklanmaktadır. İhtiyacınız olan araçlardan başlayarak karmaşıklığı artan üç proje oluşturup çalıştıracak ve bu projelerin nasıl ve neden daha karmaşık hale geldiğini öğreneceksiniz.
Bazel, çok dilli derlemeleri destekleyen bir derleme sistemi olsa da bu eğitimde örnek olarak bir C++ projesi kullanılmakta ve çoğu dil için geçerli olan genel yönergeler ve akış sağlanmaktadır.
Tahmini tamamlama süresi: 30 dakika.
Ön koşullar
Henüz yapmadıysanız Bazel'i yükleyin. Bu eğitimde kaynak kontrolü için Git kullanılır. En iyi sonuçları elde etmek istiyorsanız Git'i de yükleyin.
Ardından, tercih ettiğiniz komut satırı aracında aşağıdakileri çalıştırarak örnek projeyi Bazel'in GitHub deposundan alın:
git clone https://github.com/bazelbuild/examples
Bu eğitim için örnek proje examples/cpp-tutorial
dizinindedir.
Nasıl yapılandırıldığına aşağıda göz atabilirsiniz:
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
Her biri bu eğitimdeki bir aşamayı temsil eden üç dosya grubu vardır. İlk aşamada, tek bir paket içinde bulunan tek bir hedef oluşturursunuz. İkinci aşamada, tek bir paketten hem ikili program hem de kitaplık oluşturacaksınız. Üçüncü ve son aşamada, birden fazla paket içeren bir proje oluşturacak ve bu projeyi birden fazla hedef için derleyeceksiniz.
Özet: Giriş
Bazel'i (ve Git'i) yükleyip bu eğitim için deposu klonlayarak Bazel ile ilk derleme işleminizin temelini atmış oldunuz. Bazı terimleri tanımlamak ve çalışma alanınızı ayarlamak için bir sonraki bölüme geçin.
Başlarken
Ç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 şu önemli 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
.WORKSPACE
file - Bazel'e projenin farklı bölümlerini nasıl oluşturacağını bildiren bir veya daha fazla
. Çalışma alanındakiBUILD
filesBUILD
dosyası içeren bir dizin paket olarak adlandırılır. (Bu eğiticinin sonraki bölümlerinde paketlerle ilgili daha fazla bilgi bulabilirsiniz.)
Gelecekteki projelerde bir dizini Bazel çalışma alanı olarak belirlemek için söz konusu dizinde WORKSPACE
adlı boş bir dosya oluşturun. Bu eğiticinin amaçları doğrultusunda,
her aşamada bir WORKSPACE
dosyası zaten mevcuttur.
NOT: Bazel projeyi oluşturduğunda tüm girişlerin aynı çalışma alanında olması gerekir. Farklı çalışma alanlarında bulunan dosyalar, bağlanmadıkları sürece birbirinden bağımsızdır. Çalışma alanı kuralları hakkında daha ayrıntılı bilgiyi bu kılavuzda bulabilirsiniz.
BUILD dosyasını anlama
BUILD
dosyası, Bazel için birkaç farklı türde talimat içerir. Her BUILD
dosyasında, Bazel'e istenen çıkışları (ör. yürütülebilir ikili dosyalar veya kitaplıklar) nasıl oluşturacağını söyleyen bir talimat grubu olarak en az bir kural gerekir. BUILD
dosyasında bir derleme kuralının her örneğine hedef denir ve belirli bir kaynak dosya ve bağımlılıklar kümesini işaret eder.
Hedefler diğer hedefleri de gösterebilir.
cpp-tutorial/stage1/main
dizinindeki BUILD
dosyasına göz atın:
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
)
Örneğimizde hello-world
hedefi, Bazel'in yerleşik cc_binary rule
öğesini örneklendirir.
Kural, Bazel'e hello-world.cc
kaynak dosyasından bağımlılık içermeyen, kendi kendine yeten bir yürütülebilir ikili dosya oluşturmasını söyler.
Özet: başlarken
Artık bazı temel terimleri ve bu proje ile genel olarak Bazel bağlamında ne anlama geldiklerini biliyorsunuz. Bir sonraki bölümde, projenin 1. aşamasını oluşturup test edeceksiniz.
1. Aşama: tek hedef, tek paket
Projenin ilk bölümünü oluşturmanın zamanı geldi. Görsel referans olarak kullanabileceğiniz projenin 1. Aşama bölümünün yapısı:
examples
└── cpp-tutorial
└──stage1
├── main
│ ├── BUILD
│ └── hello-world.cc
└── WORKSPACE
cpp-tutorial/stage1
dizine gitmek için aşağıdaki komutu çalıştırın:
cd cpp-tutorial/stage1
Ardından şu komutu çalıştırın:
bazel build //main:hello-world
Hedef etiketinde //main:
kısmı, BUILD
dosyasının çalışma alanının köküne göre konumudur ve hello-world
, BUILD
dosyasındaki hedef addır.
Bazel aşağıdaki gibi bir sonuç oluşturur:
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
İlk Bazel hedefinizi oluşturdunuz. Bazel, derleme çıkışlarını çalışma alanının kökündeki bazel-bin
dizinine yerleştirir.
Artık yeni oluşturulan ikili programınızı test edin. Bu program:
bazel-bin/main/hello-world
Bu işlem, "Hello world
" mesajının yazdırılmasına neden olur.
1. Aşama'nın bağımlılık grafiği aşağıda verilmiştir:
Özet: 1. aşama
İlk derlemenizi tamamladığınıza göre derlemelerin nasıl yapılandırıldığına dair temel bir fikriniz var. Bir sonraki aşamada başka bir hedef ekleyerek karmaşıklığı ekleyeceksiniz.
2. Aşama: birden çok derleme hedefi
Küçük projeler için tek bir hedef yeterli olsa da büyük projeleri birden fazla hedefe ve pakete bölmek isteyebilirsiniz. Bu yöntem, artımlı derlemelerin hızlı olmasına olanak tanır. Yani, Bazel yalnızca değişiklikleri yeniden oluşturur. Ayrıca, projenin birden fazla parçasını tek seferde derleyerek derlemelerinizi hızlandırır. Eğitimin bu aşamasında bir hedef, sonraki aşamada ise bir paket eklenir.
2. Aşama için kullandığınız dizin budur:
├──stage2
│ ├── main
│ │ ├── BUILD
│ │ ├── hello-world.cc
│ │ ├── hello-greet.cc
│ │ └── hello-greet.h
│ └── WORKSPACE
Aşağıda, cpp-tutorial/stage2/main
dizinindeki BUILD
dosyasına göz atın:
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",
],
)
Bazel, bu BUILD
dosyasıyla önce hello-greet
kitaplığını (Bazel'in yerleşik cc_library rule
aracını kullanarak) ardından hello-world
ikili programını oluşturur. hello-world
hedefindeki deps
özelliği, Bazel'e hello-world
ikilisini derlemek için hello-greet
kitaplığının gerekli olduğunu bildirir.
Projenin bu yeni sürümünü oluşturabilmek için önce dizinleri değiştirmeniz ve aşağıdaki komutu çalıştırarak cpp-tutorial/stage2
dizinine geçmeniz gerekir:
cd ../stage2
Artık aşağıdaki tanıdık komutu kullanarak yeni ikili dosyayı derleyebilirsiniz:
bazel build //main:hello-world
Bazel yine şuna benzer bir şey oluşturur:
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
Artık yeni oluşturulan ikili dosyanızı test edebilirsiniz. Bu dosya başka bir "Hello world
" döndürür:
bazel-bin/main/hello-world
Artık hello-greet.cc
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 hello-world
'ün hello-greet
adlı ek bir girişe bağlı olduğunu görebilirsiniz:
Özet: 2. aşama
Projeyi iki hedefle oluşturmuş oldunuz. hello-world
hedefi bir kaynak dosya oluşturur ve iki ek kaynak dosyası oluşturan başka bir hedefe (//main:hello-greet
) bağlıdır. Bir sonraki bölümde, bir adım daha ileri gidip başka bir paket daha ekleyin.
3. Aşama: birden fazla paket
Bu sonraki aşamada, karmaşıklık bir kat daha artar ve birden fazla paket içeren bir proje oluşturulur. cpp-tutorial/stage3
dizininin yapısına ve içeriğine aşağıdan göz atın:
└──stage3
├── main
│ ├── BUILD
│ ├── hello-world.cc
│ ├── hello-greet.cc
│ └── hello-greet.h
├── lib
│ ├── BUILD
│ ├── hello-time.cc
│ └── hello-time.h
└── WORKSPACE
Artık iki alt dizin olduğunu ve her birinin bir BUILD
dosyası içerdiğini görebilirsiniz. Bu nedenle, Bazel'e göre çalışma alanı artık iki paket içeriyor: lib
ve
main
.
lib/BUILD
dosyasına göz atın:
cc_library(
name = "hello-time",
srcs = ["hello-time.cc"],
hdrs = ["hello-time.h"],
visibility = ["//main:__pkg__"],
)
main/BUILD
dosyasında:
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",
],
)
Ana paketteki hello-world
hedefi, lib
paketindeki hello-time
hedefine bağlıdır (bu nedenle hedef etiketi //lib:hello-time
). Bazel bunu deps
özelliği aracılığıyla bilir. Bunun bağımlılık grafiğinde yansıdığını görebilirsiniz:
Derlemenin başarılı olması için görünürlük özelliğini kullanarak lib/BUILD
'daki //lib:hello-time
hedefini main/BUILD
'deki hedeflere açıkça görünür hale getirirsiniz.
Bunun nedeni, hedeflerin varsayılan olarak yalnızca aynı BUILD
dosyasındaki diğer hedefler tarafından görülebilmesidir. Bazel, herkese açık API'lere sızdırılan uygulama ayrıntılarını içeren kitaplıklar gibi sorunları önlemek için hedef görünürlük kullanır.
Şimdi projenin bu son sürümünü derleyin. Aşağıdaki komutu çalıştırarak cpp-tutorial/stage3
dizinine geçin:
cd ../stage3
Aşağıdaki komutu tekrar çalıştırın:
bazel build //main:hello-world
Bazel aşağıdaki gibi bir sonuç oluşturur:
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
Şimdi, bu eğiticinin son ikili programındaki son Hello world
mesajını test edin:
bazel-bin/main/hello-world
Özet: 3. aşama
Artık projeyi üç hedefi olan iki paket olarak oluşturdunuz ve aralarındaki bağımlılıkları anladınız. Bu sayede, Bazel ile gelecekteki projeleri oluşturmaya hazırsınız. Bir sonraki bölümde Bazel yolculuğunuza nasıl devam edeceğinize bakacağız.
Sonraki adımlar
Bazel ile ilk temel derlemenizi tamamladınız. Ancak bu sadece başlangıç. Bazel ile ilgili daha fazla bilgi edinmek için aşağıdaki kaynaklardan yararlanabilirsiniz:
- C++'ya odaklanmaya devam etmek için yaygın C++ derleme kullanım alanları hakkında bilgi edinin.
- Bazel ile başka uygulamalar oluşturmaya başlamak için Java, Android uygulaması veya iOS uygulaması ile ilgili eğitici içeriklere göz atın.
- Yerel ve uzak kod depolarıyla çalışma hakkında daha fazla bilgi edinmek için harici bağımlılıklar hakkında bilgi edinin.
- Bazel'in diğer kuralları hakkında daha fazla bilgi edinmek için bu referans kılavuzunu inceleyin.
İyi çalışmalar.