Dış bağımlılıklara genel bakış

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel, derlemenizde kullanılan ve çalışma alanınızdan gelmeyen harici bağımlılıkları ve kaynak dosyalarını (hem metin hem de ikili program) destekler. Örneğin, GitHub deposunda barındırılan bir kural grubu, Maven yapısı veya mevcut çalışma alanınızın dışındaki yerel makinenizde bulunan bir dizin olabilir.

Bazel 6.0 sürümünden itibaren, dış bağımlılıkları Bazel ile yönetmenin iki yolu vardır: geleneksel, depo odaklı WORKSPACE sistemi ve Bzlmod adlı yeni bir MODULE.bazel sistemi (Bzlmod kodlu ve --enable_bzlmod işaretiyle etkinleştirilir). Bu iki sistem birlikte kullanılabilir ancak Bzlmod, taşıma rehberinin gelecekte Bzl0'in yerini kontrol ediyor.WORKSPACE

Bu belgede, Bazel'de harici bağımlılık yönetimiyle ilgili kavramlar açıklandıktan sonra iki sistem hakkında biraz daha ayrıntılı bilgi verilmektedir.

Kavramlar

Kod deposu

Bazel derlemesinde kullanılacak kaynak dosyaları içeren bir WORKSPACE veya WORKSPACE.bazel dosyası içeren dizin. Genellikle depo olarak kısaltılır.

Ana depo

Geçerli Bazel komutunun çalıştırıldığı depo.

Çalışma alanı

Tüm Bazel komutlarının paylaştığı ortam aynı ana depoda çalışır.

Geçmişte "depo" ve "çalışma alanı" kavramlarının birbirine karıştırıldığını unutmayın. "Çalışma alanı" terimi genellikle ana depoyu belirtmek için kullanılmış, hatta bazen "depo"nun eş anlamlısı olarak kullanılmıştır.

Standart depo adı

Bir deponun adreslenebilir olduğu kurallı ad. Çalışma alanı bağlamında her deponun tek bir standart adı vardır. Bir depo içerisinde standart adı canonical_name olan bir hedef, @@canonical_name//pac/kage:target etiketi tarafından ele alınabilir (çift @ değerine dikkat edin).

Ana depoda standart ad olarak her zaman boş dize bulunur.

Görünen depo adı

Bir depoya, başka bir depo bağlamında hitap edilebilir. Bu, deponun "rumuz" olarak düşünülebilir: michael standart adlı depo, alice kod deposu bağlamında mike görünen adına sahip olabilir ancak depo bob bağlamında mickey olarak görünen ada sahip olabilir. Bu durumda, michael içindeki bir hedef, alice bağlamında @mike//pac/kage:target etiketiyle adreslenebilir (tek @'a dikkat edin).

Tersine, bu bir depo eşlemesi olarak da anlaşılabilir: Her depo, "görünür depo adı" ile "kanonik depo adı" arasında bir eşleme sağlar.

Depo kuralı

Bazel'e bir deposu nasıl somutlaştıracağını söyleyen depo tanımları için bir şema. Örneğin, "belirli bir URL'den bir ZIP arşivi indirip ayıklayın", "belirli bir Maven yapısını getirip java_import hedefi olarak kullanılabilir hale getirin" ya da "yerel bir dizini simgesel bağlayın" şeklinde olabilir. Her depo, uygun sayıda bağımsız değişkene sahip bir depo kuralı çağırarak tanımlanır.

Kendi depo kurallarınızı yazma hakkında daha fazla bilgi için Depo kuralları başlıklı makaleyi inceleyin.

Şu ana kadar en yaygın depo kuralları, URL'den arşiv indiren ve bu arşivin ayıklandığı http_archive ile zaten Bazel deposu olan yerel bir dizine sembolik bir şekilde bağlantı veren local_repository'tir.

Kod deposu getir

Bir depoyu, ilişkili depo kuralını çalıştırarak yerel diskte kullanılabilir hale getirme işlemi. Bir çalışma alanında tanımlanan depolar, getirilmeden önce yerel diskte kullanılamaz.

Normalde, Bazel bir depoyu yalnızca depodan bir şey gerektiğinde getirir ve depo henüz getirilmemiştir. Depo daha önce getirilmişse Bazel yalnızca tanımı değiştiyse yeniden getirir.

Dizin düzeni

Depo, getirildikten sonra çıkış tabanındaki external alt dizininde, standart adının altında bulunabilir.

canonical_name kanonik adıyla deponun içeriğini görmek için aşağıdaki komutu çalıştırabilirsiniz:

ls $(bazel info output_base)/external/ canonical_name

Bzlmod ile harici bağımlılıkları yönetme

Yeni harici bağımlılık alt sistemi Bzlmod, depo tanımlarıyla doğrudan çalışmamaktadır. Bunun yerine modüllerden bir bağımlılık grafiği oluşturur, grafiğin en üstünde uzantıları çalıştırır ve depoları buna göre tanımlar.

Bazel modülleri, her biri bağlı olduğu diğer modüllerle ilgili meta verileri yayınlayan, birden çok sürümü olabilen bir Bazel projesidir. Bir modülün, depo kökünde WORKSPACE dosyasının yanında bir MODULE.bazel dosyası olmalıdır. Bu dosya, modülün manifest dosyasıdır ve adını, sürümünü, bağımlılık listesini ve diğer bilgileri bildirir. Aşağıda temel bir örnek verilmiştir:

module(name = "my-module", version = "1.0")

bazel_dep(name = "rules_cc", version = "0.0.1")
bazel_dep(name = "protobuf", version = "3.19.0")

Bir modül yalnızca doğrudan bağımlılarını listelemelidir. Bzlmod, bu bağımlılıkları bir Bazel kayıt defterinde (varsayılan olarak Bazel Merkezi Kayıt Defteri) arar. Kayıt defteri, bağımlılıkların MODULE.bazel dosyalarını sağlar. Bu sayede Bazel, sürüm çözümlemesi yapmadan önce geçişli bağımlılık grafiğinin tamamını keşfedebilir.

Her modül için bir sürümün seçildiği sürüm çözümlemesinden sonra Bazel, her modül için bir deponun nasıl tanımlanacağını öğrenmek üzere kayıt defterine tekrar danışır (çoğu durumda http_archive kullanılarak).

Modüller, etiketler adı verilen özelleştirilmiş veri parçalarını da belirtebilir. Bu veriler, modül çözümlemesinden sonra ek depolar tanımlamak için modül uzantıları tarafından kullanılır. Bu uzantılar, depo kurallarına benzer özellikler sunarak dosya G/Ç ve ağ istekleri gönderme gibi işlemleri gerçekleştirmelerini sağlar. Diğerlerinin yanı sıra Bazel'in Bazel modüllerinden oluşturulan bağımlılık grafiğine saygı duyarken diğer paket yönetim sistemleriyle etkileşim kurmasına olanak tanır.

WORKSPACE ile depoları tanımlama

Geçmişte, WORKSPACE (veya WORKSPACE.bazel) dosyasında depoları tanımlayarak harici bağımlılıkları yönetebilirsiniz. Bu dosyanın söz dizimi, derleme kuralları yerine depo kuralları kullanan BUILD dosyalarına benzer.

Aşağıdaki snippet, WORKSPACE dosyasında http_archive kod deposu kuralını kullanmaya yönelik bir örnektir:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "foo",
    urls = ["https://example.com/foo.zip"],
    sha256 = "c9526390a7cd420fdcec2988b4f3626fe9c5b51e2959f685e8f4d170d1a9bd96",
)

Sana Özel snippet'i, kurallı adı foo olan bir deposu tanımlar. WORKSPACE sisteminde, varsayılan olarak bir deponun kurallı adı, diğer tüm depolar için görünen adıdır.

WORKSPACE dosyalarında kullanılabilen işlevlerin tam listesine göz atın.

WORKSPACE sisteminin eksiklikleri

WORKSPACE sisteminin kullanıma sunulmasından bu yana geçen yıllarda kullanıcılar aşağıdakiler de dahil olmak üzere birçok sorun yaşadığını bildirdi:

  • Bazel, bağımlılıkların WORKSPACE dosyalarını değerlendirmez. Bu nedenle, tüm geçişli bağımlılıkların doğrudan bağımlılıklara ek olarak ana deponun WORKSPACE dosyasında tanımlanması gerekir.
  • Bu sorunu çözmek için projeler, "deps.bzl" kalıbını benimsemiştir. Bu kalıpta, birden çok depoyu tanımlayan bir makro tanımlanır ve kullanıcılardan bu makroyu WORKSPACE dosyalarında çağırmaları istenir.
    • Bunun da kendine özgü sorunları vardır: Makrolar diğer .bzl dosyalarını load edemez. Bu nedenle, bu projelerin geçişli bağımlılıklarını bu "deps" makrosunda tanımlaması veya kullanıcının birden fazla katmanlı "deps" makrosu çağırmasını sağlayarak bu sorunu gidermesi gerekir.
    • Bazel, WORKSPACE dosyasını sırayla değerlendirir. Ayrıca, bağımlılıklar herhangi bir sürüm bilgisi olmadan URL'lerle birlikte http_archive kullanılarak belirtilir. Bu, elmas bağımlılıkları durumunda sürüm çözümlemesi yapmanın güvenilir bir yolu olmadığı anlamına gelir (A, B ve C'a bağlıdır; B ve C, D sürümünün farklı sürümlerine bağlıdır).

WORKSPACE'in eksiklikleri nedeniyle Bzlmod, gelecekteki Bazel sürümlerinde eski WORKSPACE sisteminin yerini alacak. Bzlmod'a geçiş hakkında bilgi edinmek için lütfen Bzlmod taşıma kılavuzunu okuyun.