Xcode'dan Bazel'e taşıma

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bu sayfada, Bazel ile Xcode projesinin nasıl derleneceği veya test edileceği açıklanmaktadır. Xcode ile Bazel arasındaki farkları açıklar ve bir Xcode projesini Bazel projesine dönüştürme adımlarını sağlar. Ayrıca, sık karşılaşılan hataları gidermek için sorun giderme çözümleri de sağlanmaktadır.

Xcode ile Bazel arasındaki farklar

• Bazel, her derleme hedefini ve bağımlılıklarını, ayrıca derleme kuralları aracılığıyla ilgili derleme ayarlarını açıkça belirtmenizi gerektirir.

• Bazel, projenin bağlı olduğu tüm dosyaların Workspace dizininde bulunmasına veya WORKSPACE dosyasında içe aktarma olarak belirtilmesine ihtiyaç duyar.

• Xcode projeleri Bazel ile derlenirken BUILD dosyaları doğru kaynak olur. Proje üzerinde Xcode'da çalışıyorsanız BUILD dosyalarını her güncellediğinizde rules_xcodeproj dosyasını kullanarak Xcode projesinin BUILD dosyalarıyla eşleşen yeni bir sürümünü oluşturmanız gerekir. Bir hedefe bağımlılık ekleme gibi BUILD dosyalarında yapılan belirli değişiklikler, projenin yeniden oluşturulmasını gerektirmez. Bu da geliştirme sürecini hızlandırabilir. Xcode kullanmıyorsanız bazel build ve bazel test komutları, bu kılavuzun ilerleyen bölümlerinde açıklanan belirli sınırlamalarla derleme ve test özellikleri sağlar.

Başlamadan önce

Başlamadan önce aşağıdakileri yapın:

1. Henüz yapmadıysanız Bazel'i yükleyin.

2. Bazel ve kavramları hakkında bilginiz yoksa iOS uygulaması eğitimini tamamlayın. WORKSPACE ve BUILD dosyaları için Bazel çalışma alanını ve hedefler, derleme kuralları ve Bazel paketleri kavramlarını öğrendiniz.

3. Projenin bağımlılıklarını analiz edin ve anlayın.

Proje bağımlılıklarını analiz etme

Xcode'un aksine Bazel, BUILD dosyasında her hedef için tüm bağımlılıkları açıkça belirtmenizi gerektirir.

Harici bağımlılıklar hakkında daha fazla bilgi için Harici bağımlılıklarla çalışma başlıklı makaleyi inceleyin.

Bazel ile Xcode projesi derleme veya test etme

Bazel ile bir Xcode projesi oluşturmak veya test etmek için aşağıdakileri yapın:

1. WORKSPACE dosyasını oluşturma

2. (Deneysel) SwiftPM bağımlılıklarını entegre etme

3. BUILD dosyası oluşturma:

   a. Uygulama hedefini ekleme

   b. (İsteğe bağlı) Test hedeflerini ekleyin

   c. Kitaplık hedeflerini ekleme

4. (İsteğe bağlı) Derlemeyi ayrıntılı hale getirme

5. Derlemeyi çalıştırma

6. rules_xcodeproj ile Xcode projesini oluşturma

1. Adım: WORKSPACE dosyasını oluşturun

Yeni bir dizinde WORKSPACE dosyası oluşturun. Bu dizin, Bazel çalışma alanı kökü olur. Projede harici bağımlılık yoksa bu dosya boş olabilir. Proje, projenin dizinlerinden birinde yer almayan dosyalara veya paketlere dayanıyorsa bu harici bağımlılıkları WORKSPACE dosyasında belirtin.

Not: Proje kaynak kodunu, WORKSPACE dosyasını içeren dizin ağacına yerleştirin.

2. Adım: (Deneysel) SwiftPM bağımlılıklarını entegre edin

SwiftPM bağımlılıkları swift_bazel ile Bazel çalışma alanına entegre etmek için aşağıdaki eğitimde açıklandığı gibi bunları Bazel paketlerine dönüştürmeniz gerekir.

Not: SwiftPM desteği, birçok değişken içeren manuel bir işlemdir. Bazel ile SwiftPM entegrasyonu tam olarak doğrulanmamıştır ve resmi olarak desteklenmez.

3. Adım: BUILD dosyası oluşturun

Çalışma alanını ve harici bağımlılıkları tanımladıktan sonra, Bazel'e projenin nasıl yapılandırıldığını bildiren bir BUILD dosyası oluşturmanız gerekir. Bazel çalışma alanının kökünde BUILD dosyasını oluşturun ve projenin ilk derlemesini yapacak şekilde yapılandırın:

• Adım 3a: Uygulama hedefini ekleyin
• 3b. adım: (İsteğe bağlı) Test hedeflerini ekleyin
• 3c. adım: Kitaplık hedeflerini ekleyin

İpucu: Paketler ve diğer Bazel kavramları hakkında daha fazla bilgi edinmek için Çalışma alanları, paketler ve hedefler başlıklı makaleyi inceleyin.

3a. adım: Uygulama hedefini ekleyin

macos_application veya ios_application kural hedefi ekleyin. Bu hedef, sırasıyla macOS veya iOS uygulama paketi oluşturur. Hedefte en az aşağıdakileri belirtin:

• bundle_id: İkilinin paket kimliği (tersten DNS yolu ve ardından uygulama adı).

• provisioning_profile - Apple Developer hesabınızdan temel hazırlık profili (bir iOS cihaz cihazı için oluşturuluyorsa).

• families (yalnızca iOS) - Uygulamanın iPhone, iPad veya her ikisi için mi geliştirileceğidir.

• infoplists: Nihai Info .plist dosyasıyla birleştirilecek.plist dosyalarının listesi.

• minimum_os_version: Uygulamanın desteklediği macOS veya iOS'in minimum sürümü. Bu sayede Bazel, uygulamayı doğru API düzeyleriyle oluşturur.

3b. adım: (İsteğe bağlı) Test hedeflerini ekleyin

Bazel'in Apple derleme kuralları, iOS ve macOS'te kitaplık tabanlı birim testlerinin yanı sıra macOS'te uygulama tabanlı testlerin çalıştırılmasını destekler. Her iki platformdaki iOS veya kullanıcı arayüzü testlerinde yapılan uygulama tabanlı testler için Bazel, test çıkışlarını oluşturur ancak testlerin, rules_xcodeproj ile oluşturulan bir proje aracılığıyla Xcode içinde çalıştırılması gerekir. Test hedeflerini aşağıdaki gibi ekleyin:

• macos_unit_test kullanarak macOS'te kitaplık tabanlı ve uygulama tabanlı birim testleri çalıştırabilirsiniz.

• ios_unit_test iOS'te kitaplığa dayalı birim testleri çalıştırmak için. iOS simülatörünü gerektiren testler için Bazel, test çıktılarını oluşturur ancak testleri çalıştırmaz. rules_xcodeproj ile bir Xcode projesi oluşturmanız ve testleri Xcode'dan çalıştırmanız gerekir.

• ios_ui_test Xcode'u kullanarak iOS simülatöründe kullanıcı arayüzü testlerini çalıştırmak için gereken çıkışları oluşturmak. rules_xcodeproj ile bir Xcode projesi oluşturmanız ve testleri Xcode'dan çalıştırmanız gerekir. Bazel, kullanıcı arayüzü testlerini yerel olarak çalıştıramaz.

En azından minimum_os_version özelliği için bir değer belirtin. bundle_identifier ve infoplists gibi diğer paketleme özellikleri varsayılan olarak en yaygın kullanılan değerlere sahip olsa da bu varsayılan değerlerin projeyle uyumlu olduğundan emin olun ve gerektiğinde bunları ayarlayın. iOS simülatörünün kullanılmasını gerektiren testlerde, test_host özelliğinin değeri olarak ios_application hedef adını da belirtin.

3. adım c: Kitaplık hedeflerini ekleyin

Her Objective-C kitaplığı için bir objc_library hedefi, uygulama ve/veya testlerin bağlı olduğu her Swift kitaplığı için bir swift_library hedefi ekleyin.

Kitaplık hedeflerini aşağıdaki gibi ekleyin:

• Uygulama kitaplığı hedeflerini uygulama hedeflerine bağımlılık olarak ekleyin.

• Test kitaplığı hedeflerini test hedeflerine bağımlılık olarak ekleyin.

• srcs özelliğinde uygulama kaynaklarını listeleyin.

• hdrs özelliğindeki başlıkları listeleyin.

Not: Belirli bir türdeki tüm kaynakları ve/veya başlıkları dahil etmek için glob işlevini kullanabilirsiniz. Bazel'in derlemesini istemediğiniz dosyaları içerebileceğinden bu özelliği dikkatli kullanın.

Çeşitli uygulama türleriyle ilgili mevcut örneklere doğrudan rules_apple örnekler dizininde göz atabilirsiniz. Örneğin:

• macOS uygulama hedefleri

• iOS uygulama hedefleri

• Çok platformlu uygulamalar (macOS, iOS, watchOS, tvOS)

Derleme kuralları hakkında daha fazla bilgi edinmek için Bazel için Apple Kuralları'na bakın.

Bu aşamada derlemeyi test etmek iyi bir fikirdir:

bazel build //:<application_target>

4. Adım: (İsteğe bağlı) Derlemeyi ayrıntılı hale getirin

Proje büyükse veya büyüdükçe projeyi birden fazla Bazel paketine bölmeyi düşünebilirsiniz. Bu artan ayrıntı düzeyi şunları sağlar:

• Derlemelerin artımlılığı,

• Derleme görevlerinde daha fazla paralellik yapılması,

• Gelecekteki kullanıcılar için daha iyi sürdürülebilirlik,

• Hedefler ve paketler genelinde kaynak kod görünürlüğü üzerinde daha iyi kontrol. Bu, uygulama ayrıntılarını içeren kitaplıkların herkese açık API'lere sızması gibi sorunların önüne geçer.

Projeyi ayrıntılı hale getirmeyle ilgili ipuçları:

• Her kitaplığı kendi Bazel paketine koyun. En az bağımlılığı gerektirenlerden başlayıp bağımlılık ağacında yukarı doğru ilerleyin.

• BUILD dosyaları ekleyip hedefleri belirtirken bu yeni hedefleri, kendilerine bağlı hedeflerin deps özelliklerine ekleyin.

• glob() işlevi paket sınırlarını aşmaz. Bu nedenle, paket sayısı arttıkça glob() ile eşleşen dosya sayısı azalır.

• main dizinine BUILD dosyası eklerken ilgili test dizinine de BUILD dosyası ekleyin.

• Paketler genelinde sağlıklı görünürlük sınırlamaları uygulayın.

• BUILD dosyalarında yapılan her büyük değişiklikten sonra projeyi derleyin ve karşılaştığınız derleme hatalarını düzeltin.

5. adım: Derlemeyi çalıştırın

Tamamen taşınmış derlemeyi çalıştırarak hata veya uyarı olmadan tamamlandığından emin olun. Ortaya çıkan hataların kaynaklarını daha kolay bulmak için her uygulamayı ve test hedefini ayrı ayrı çalıştırın.

Örneğin:

bazel build //:my-target

6. adım: rules_xcodeproj ile Xcode projesini oluşturun

Bazel ile derleme yaparken WORKSPACE ve BUILD dosyaları, derlemeyle ilgili doğru kaynak olur. Xcode'un bundan haberdar olması için rules_xcodeproj kodunu kullanarak Bazel uyumlu bir Xcode projesi oluşturmanız gerekir.

Sorun giderme

Bir güncellemeyi uyguladığınızda olduğu gibi, seçilen Xcode sürümüyle senkronize olmadığında Bazel hataları ortaya çıkabilir. Xcode ile ilgili hatalarla (ör. "Apple CROSSTOOL kullanmak için Xcode sürümü belirtilmelidir") karşılaşıyorsanız deneyebileceğiniz bazı işlemleri aşağıda bulabilirsiniz.

• Xcode'u manuel olarak çalıştırın ve tüm hükümler ve koşulları kabul edin.

• Doğru sürümü belirtmek, lisansı kabul etmek ve Bazel'in durumunu temizlemek için Xcode seçiciyi kullanın.

  sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
  sudo xcodebuild -license
  bazel sync --configure

• Bu işe yaramazsa bazel clean --expunge komutunu çalıştırmayı da deneyebilirsiniz.

Not: Xcode'unuzu farklı bir yola kaydettiyseniz xcode-select -s kullanarak bu yolu gösterebilirsiniz.